Logo
Emporix Digital Commerce Platform API Documentation

price model

Number of APIs: 5


1. Update price model

PUT {{api-url}}/price/{{tenant}}/priceModels/{{priceModelId}}

AVAILABLE for Price Service v2 only

Updates a price model definition.

A Price Model can be defined as a repeatable way to sell products in a market with the intention of making a profit. The price model defines basic structure for prices. Among other things, it allows you to determine whether the prices are gross or net, whether they contain markup, and the structure of tiers.

  • If the Content-Language is set to * the request body payload should contain localized fields not as a string, but as a map in format: key:value, where the key is the language code and value is the translation. ***



2. Create new price model

POST {{api-url}}/price/{{tenant}}/priceModels

AVAILABLE for Price Service v2 only

Creates a new price model definition.

A Price Model can be defined as a repeatable way to sell products in a market with the intention of making a profit. The price model defines basic structure for prices. Among other things, it allows you to determine whether the prices are gross or net, whether they contain markup, and the structure of tiers.

  • If the Content-Language is set to * the request body payload should contain localized fields not as a string, but as a map in format: key:value, where the key is the language code and value is the translation. ***



3. Get price model

GET {{api-url}}/price/{{tenant}}/priceModels/{{priceModelId}}

AVAILABLE for Price Service v2 only

Retrieves the 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. The price model defines basic structure for prices. Among other things, it allows you to determine whether the prices are gross or net, whether they have any restrictions, and the structure of tiers

  • If the Accept-Language is set to * each internationalized field is returned as a map that contains all of translations in a format of key:value pairs, where the key is the language code and value is the translation.
  • The Accept-Language can contain the priority list of languages which should be returned. Always one language is returned as a single string field.
  • If the Accept-Language header is empty default language defined in the Configuration service is taken.



4. Get all price models

GET {{api-url}}/price/{{tenant}}/priceModels?pageNumber=1&pageSize=16

AVAILABLE for Price Service v2 only

Retrieves all the price models. There is a possibility to filter by some price model simple fields.

A Price Model can be defined as a repeatable way to sell products in a market with the intention of making a profit. The price model defines basic structure for prices. Among other things, it allows you to determine whether the prices are gross or net, whether they have any restrictions, and the structure of tiers

  • If the Accept-Language is set to * each internationalized field is returned as a map that contains all of translations in a format of key:value pairs, where the key is the language code and value is the translation.
  • The Accept-Language can contain the priority list of languages which should be returned. Always one language is returned as a single string field.
  • If the Accept-Language header is empty default language defined in the Configuration service is taken.



5. Delete price model

DELETE {{api-url}}/price/{{tenant}}/priceModels/{{priceModelId}}

AVAILABLE for Price Service v2 only

Deletes the price model. As a consequence of the operation all prices related to the given price model will be deleted as well. The operation of prices deletion will be done in asynchronous manner.



ENDPOINTS