Price models
Was this helpful?
Was this helpful?
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Price model's unique identifier, generated when the price model is created.
List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.Deletes a specified price model by priceModel Id.
Important: If you want to delete a price model that has prices assigned to it, you need to set the forceDelete query parameter to true. In this case, all prices assigned to the price model will be deleted as well, in an asynchronous manner.
price.pricemodel_manage
price.pricemodel_manage_admin
Note: The price.pricemodel_manage_admin scope is only required if you want to delete a price model that has prices assigned to it.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Price model's unique identifier, generated when the price model is created.
If set to true and the price model has prices assigned to it, both the price model and the prices will be deleted.
Important: To set this parameter to true, your access token needs to have the price.pricemodel_manage_admin scope granted.
If set to false or not specified and the price model has prices assigned to it, the endpoint will respond with a 400 error.
No content
Retrieves all price models assigned to the tenant. You can filter the results with query parameters.
A price model can be defined as a repeatable way to sell products in a market with the intention of making a profit. Price models define basic structures for prices.
price.pricemodel_read
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Page number to be retrieved. The number of the first page is 1.
Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.
1Number of items to be retrieved per page.
60List of properties used to sort the results, separated by colons. The order of properties indicates their priority in sorting.
Possible values:
{fieldName}{fieldName}:asc{fieldName}:descNote: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:descIf the sorting direction is not specified, the fields are sorted in ascending order.
name,code:descFlag indicating whether prices assigned to the price model are expressed as net or gross.
| Value | Description |
|---|---|
true |
Prices are expressed as gross values. |
false |
Prices are expressed as net values. |
Flag indicating whether prices assigned to the price model include markup.
Note: This is a preview field.
Pricing strategy applicable to the price model. Possible values:
BASICVOLUMETIEREDPrice model's name.
Price model's description.
Filter price models by unit code
List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.Flag indicating whether the total count of retrieved items should be returned.
falseCreates a new price model.
A price model can be defined as a repeatable way to sell products in a market with the intention of making a profit. Price models define basic structures for prices, including whether the prices are expressed as gross or net or the measurement units for which prices are defined.
Each price model can specify one of three pricing strategies:
Basic pricing, where the price per unit is constant, regardless of the ordered quantity.
Volume pricing, where the price per unit depends on the ordered quantity.
Tiered pricing, where the price per unit depends on the tiers that the ordered quantity falls into.
price.pricemodel_manage
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$List of languages in which localized fields in the request body are provided.
Content-Language header is set to *, the localized fields should be provided as maps of translations, where the keys are language codes and values are the fields in their respective languages.Content-Language header is set to a specific language, the localized fields should be provided as strings.Content-Language header is empty, the endpoint will asume that the localized fields are provided in the default language defined in the Configuration Service.Note: You can provide the localized fields only in languages defined in the Configuration Service. In case the fields are provided in languages that are not defined in the Configuration Service, the request will be rejected.
A price model can be defined as a repeatable way to sell products in a market with the intention of making a profit. Price models define basic structures for prices.
Custom price model identifier. If not provided, it is automatically generated.
Flag indicating whether prices assigned to the price model will be expressed as net or gross.
| Value | Description |
|---|---|
true |
Prices will be expressed as gross values. |
false |
Prices will be expressed as net values. |
Flag indicating whether prices assigned to the price model include markup.
Note: This is a preview field.
Indicates whether the price model is default one or not.
Price model name. It should be a brief, human-readable name that describes purposes of the model.
Content-Language header is set to *, then the name should be provided as a map of translations, where each key is a language code and the value is the name in its respective language.Content-Language header is set to a specific language, the name should be provided as a string.Content-Language header is empty, the endpoint will asume that the name is provided in the default language defined in the Configuration Service.Note: You can provide the names only in languages defined in the Configuration Service. In case the name is provided in a language that is not defined in the Configuration Service, the request will be rejected.
Price model description. It can contain details about the price model.
Content-Language header is set to *, then the description should be provided as a map of translations, where each key is a language code and the value is the description in its respective language.Content-Language header is set to a specific language, the description should be provided as a string.Content-Language header is empty, the endpoint will asume that the description is provided in the default language defined in the Configuration Service.Note: You can provide the descriptions only in languages defined in the Configuration Service. In case the description is provided in a language that is not defined in the Configuration Service, the request will be rejected.
Definition of pricing tiers.
Measurement unit and quantity for which the price is defined.
For example, if a product is sold by the piece, the field should contain 1 pc. If products relevant to this price model are sold per kilogram, this field should contain 1 kg.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Price model's unique identifier, generated when the price model is created.
List of languages in which localized fields in the request body are provided.
Content-Language header is set to *, the localized fields should be provided as maps of translations, where the keys are language codes and values are the fields in their respective languages.Content-Language header is set to a specific language, the localized fields should be provided as strings.Content-Language header is empty, the endpoint will asume that the localized fields are provided in the default language defined in the Configuration Service.Note: You can provide the localized fields only in languages defined in the Configuration Service. In case the fields are provided in languages that are not defined in the Configuration Service, the request will be rejected.
A price model can be defined as a repeatable way to sell products in a market with the intention of making a profit. Price models define basic structures for prices.
Custom price model identifier. If not provided, it is automatically generated.
Flag indicating whether prices assigned to the price model will be expressed as net or gross.
| Value | Description |
|---|---|
true |
Prices will be expressed as gross values. |
false |
Prices will be expressed as net values. |
Flag indicating whether prices assigned to the price model include markup.
Note: This is a preview field.
Indicates whether the price model is default one or not.
Price model name. It should be a brief, human-readable name that describes purposes of the model.
Content-Language header is set to *, then the name should be provided as a map of translations, where each key is a language code and the value is the name in its respective language.Content-Language header is set to a specific language, the name should be provided as a string.Content-Language header is empty, the endpoint will asume that the name is provided in the default language defined in the Configuration Service.Note: You can provide the names only in languages defined in the Configuration Service. In case the name is provided in a language that is not defined in the Configuration Service, the request will be rejected.
Price model description. It can contain details about the price model.
Content-Language header is set to *, then the description should be provided as a map of translations, where each key is a language code and the value is the description in its respective language.Content-Language header is set to a specific language, the description should be provided as a string.Content-Language header is empty, the endpoint will asume that the description is provided in the default language defined in the Configuration Service.Note: You can provide the descriptions only in languages defined in the Configuration Service. In case the description is provided in a language that is not defined in the Configuration Service, the request will be rejected.
Definition of pricing tiers.
Measurement unit and quantity for which the price is defined.
For example, if a product is sold by the piece, the field should contain 1 pc. If products relevant to this price model are sold per kilogram, this field should contain 1 kg.