Open API v2 / Custom Modules / Module Item Prices

Module Item Prices

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/module-items/{moduleItemId}/prices#

Retrieves a list of module item prices

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

CurrencyCountrystring · nullable

Geographical binding of a specific price offer.

Currencystring · nullable

Currency code (e.g. USD).

Countrystring · nullable

Country (it is recommended to use ISO codes).

CustomerTypeIdinteger

Customer Category ID. Allows you to set different prices for different segments.

TaxIdinteger

The identifier of the tax rule that applies to this price.

RecommendedPricenumber

Recommended retail price.

SellPricenumber

The actual selling price at which the customer purchases the product.

EnableVolumeDiscountboolean

If true, the bulk discounts feature is activated for this product depending on the quantity.

TaxNeverAppliesboolean

"No tax" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports).

PriceQuantityDiscountsarray of objects

Determines the price based on the number of items in the cart.

curl "https://your-site.webinone.com/api/v2/admin/module-items/1/prices" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/prices", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/module-items/1/prices",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-items/1/prices', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/module-items/1/prices");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "CurrencyCountry": "USD",
      "Currency": "USD",
      "Country": "string",
      "CustomerTypeId": 1,
      "TaxId": 1,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": false,
      "TaxNeverApplies": false,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

POST/api/v2/admin/module-items/{moduleItemId}/prices#

Creates a new module item price group

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Body parameters

CustomerTypeIdinteger

Customer Category ID. Allows you to set different prices for different segments.

TaxIdinteger

The identifier of the tax rule that applies to this price.

RecommendedPricenumber

Recommended retail price.

SellPricenumber

The actual selling price at which the customer purchases the product.

EnableVolumeDiscountboolean

If true, the bulk discounts feature is activated for this product depending on the quantity.

TaxNeverAppliesboolean

"No tax" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports).

PriceQuantityDiscountsarray of objects

Determines the price based on the number of items in the cart.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

CurrencyCountrystring · nullable

Geographical binding of a specific price offer.

Currencystring · nullable

Currency code (e.g. USD).

Countrystring · nullable

Country (it is recommended to use ISO codes).

CustomerTypeIdinteger

Customer Category ID. Allows you to set different prices for different segments.

TaxIdinteger

The identifier of the tax rule that applies to this price.

RecommendedPricenumber

Recommended retail price.

SellPricenumber

The actual selling price at which the customer purchases the product.

EnableVolumeDiscountboolean

If true, the bulk discounts feature is activated for this product depending on the quantity.

TaxNeverAppliesboolean

"No tax" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports).

PriceQuantityDiscountsarray of objects

Determines the price based on the number of items in the cart.

curl -X POST "https://your-site.webinone.com/api/v2/admin/module-items/1/prices" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '[{"CustomerTypeId":1,"TaxId":1,"RecommendedPrice":0,"SellPrice":0,"EnableVolumeDiscount":false,"TaxNeverApplies":false,"PriceQuantityDiscounts":[{"MinQuantity":0,"Value":0}]}]'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/prices", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify([
    {
      "CustomerTypeId": 1,
      "TaxId": 1,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": false,
      "TaxNeverApplies": false,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ])
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/module-items/1/prices",
    headers={"Authorization": "Bearer <token>"},
    json=[{
        "CustomerTypeId": 1,
        "TaxId": 1,
        "RecommendedPrice": 0,
        "SellPrice": 0,
        "EnableVolumeDiscount": False,
        "TaxNeverApplies": False,
        "PriceQuantityDiscounts": [{
            "MinQuantity": 0,
            "Value": 0
        }]
    }]
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/module-items/1/prices', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [[
        'CustomerTypeId' => 1,
        'TaxId' => 1,
        'RecommendedPrice' => 0,
        'SellPrice' => 0,
        'EnableVolumeDiscount' => false,
        'TaxNeverApplies' => false,
        'PriceQuantityDiscounts' => [[
            'MinQuantity' => 0,
            'Value' => 0
        ]]
    ]]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/module-items/1/prices");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "[{\"CustomerTypeId\":1,\"TaxId\":1,\"RecommendedPrice\":0,\"SellPrice\":0,\"EnableVolumeDiscount\":false,\"TaxNeverApplies\":false,\"PriceQuantityDiscounts\":[{\"MinQuantity\":0,\"Value\":0}]}]",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "CurrencyCountry": "USD",
      "Currency": "USD",
      "Country": "string",
      "CustomerTypeId": 1,
      "TaxId": 1,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": false,
      "TaxNeverApplies": false,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

PUT/api/v2/admin/module-items/{moduleItemId}/prices#

Updates an existing module item price group

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Body parameters

Idinteger

Unique identifier assigned by the platform.

CustomerTypeIdinteger

Customer Category ID. Allows you to set different prices for different segments.

TaxIdinteger

The identifier of the tax rule that applies to this price.

RecommendedPricenumber

Recommended retail price.

SellPricenumber

The actual selling price at which the customer purchases the product.

EnableVolumeDiscountboolean

If true, the bulk discounts feature is activated for this product depending on the quantity.

TaxNeverAppliesboolean

"No tax" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports).

PriceQuantityDiscountsarray of objects

Determines the price based on the number of items in the cart.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

CurrencyCountrystring · nullable

Geographical binding of a specific price offer.

Currencystring · nullable

Currency code (e.g. USD).

Countrystring · nullable

Country (it is recommended to use ISO codes).

CustomerTypeIdinteger

Customer Category ID. Allows you to set different prices for different segments.

TaxIdinteger

The identifier of the tax rule that applies to this price.

RecommendedPricenumber

Recommended retail price.

SellPricenumber

The actual selling price at which the customer purchases the product.

EnableVolumeDiscountboolean

If true, the bulk discounts feature is activated for this product depending on the quantity.

TaxNeverAppliesboolean

"No tax" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports).

PriceQuantityDiscountsarray of objects

Determines the price based on the number of items in the cart.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/1/prices" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '[{"Id":1,"CustomerTypeId":1,"TaxId":1,"RecommendedPrice":0,"SellPrice":0,"EnableVolumeDiscount":false,"TaxNeverApplies":false,"PriceQuantityDiscounts":[{"MinQuantity":0,"Value":0}]}]'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/prices", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify([
    {
      "Id": 1,
      "CustomerTypeId": 1,
      "TaxId": 1,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": false,
      "TaxNeverApplies": false,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ])
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/module-items/1/prices",
    headers={"Authorization": "Bearer <token>"},
    json=[{
        "Id": 1,
        "CustomerTypeId": 1,
        "TaxId": 1,
        "RecommendedPrice": 0,
        "SellPrice": 0,
        "EnableVolumeDiscount": False,
        "TaxNeverApplies": False,
        "PriceQuantityDiscounts": [{
            "MinQuantity": 0,
            "Value": 0
        }]
    }]
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/1/prices', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [[
        'Id' => 1,
        'CustomerTypeId' => 1,
        'TaxId' => 1,
        'RecommendedPrice' => 0,
        'SellPrice' => 0,
        'EnableVolumeDiscount' => false,
        'TaxNeverApplies' => false,
        'PriceQuantityDiscounts' => [[
            'MinQuantity' => 0,
            'Value' => 0
        ]]
    ]]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/1/prices");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "[{\"Id\":1,\"CustomerTypeId\":1,\"TaxId\":1,\"RecommendedPrice\":0,\"SellPrice\":0,\"EnableVolumeDiscount\":false,\"TaxNeverApplies\":false,\"PriceQuantityDiscounts\":[{\"MinQuantity\":0,\"Value\":0}]}]",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "CurrencyCountry": "USD",
      "Currency": "USD",
      "Country": "string",
      "CustomerTypeId": 1,
      "TaxId": 1,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": false,
      "TaxNeverApplies": false,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

DELETE/api/v2/admin/module-items/prices#

Deletes an existing module item price group

Body parameters

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/module-items/prices" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '[0]'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/prices", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify([
    0
  ])
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/module-items/prices",
    headers={"Authorization": "Bearer <token>"},
    json=[0]
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/module-items/prices', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [0]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/module-items/prices");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "[0]",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

GET/api/v2/admin/module-items/prices/{id}#

Retrieves a single module item price

Parameters

idinteger · pathrequired

Module item price id.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

CurrencyCountrystring · nullable

Geographical binding of a specific price offer.

Currencystring · nullable

Currency code (e.g. USD).

Countrystring · nullable

Country (it is recommended to use ISO codes).

CustomerTypeIdinteger

Customer Category ID. Allows you to set different prices for different segments.

TaxIdinteger

The identifier of the tax rule that applies to this price.

RecommendedPricenumber

Recommended retail price.

SellPricenumber

The actual selling price at which the customer purchases the product.

EnableVolumeDiscountboolean

If true, the bulk discounts feature is activated for this product depending on the quantity.

TaxNeverAppliesboolean

"No tax" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports).

PriceQuantityDiscountsarray of objects

Determines the price based on the number of items in the cart.

curl "https://your-site.webinone.com/api/v2/admin/module-items/prices/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/prices/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/module-items/prices/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-items/prices/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/module-items/prices/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "CurrencyCountry": "USD",
  "Currency": "USD",
  "Country": "string",
  "CustomerTypeId": 1,
  "TaxId": 1,
  "RecommendedPrice": 0,
  "SellPrice": 0,
  "EnableVolumeDiscount": false,
  "TaxNeverApplies": false,
  "PriceQuantityDiscounts": [
    {
      "MinQuantity": 0,
      "Value": 0
    }
  ]
}