Logo
Emporix Digital Commerce Platform API Documentation

price

Number of APIs: 13


1. Access Token

POST {{api-url}}/oauth/token



2. price model - 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. price model - 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. price model - 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. price model - 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. ***


6. price model - 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.



7. matching - Matching prices for session context

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

preview endpoint - the endpoint is not fully operated yet.
AVAILABLE for Price Service v2 only

This endpint allows to match the best available price for the provided item. The details about target currency, site and user/group identifier will be retrieved from the session context service. ### Required scopes * price.price_match_own



8. matching - Calculate gross price between countries

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



9. prices management - Creating price

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

Creates a new price for a product.
The endpoint is available in the following versions: v1 and v2.
The second version of the endpoint introduces new fields in the payload. Moreover, some fields known from version v1 become deprecated. In order to check details of changes for version v2 check data schema of the request body.

Required scopes

  • price.price_manage


10. prices management - Retrieving prices

GET {{api-url}}/price/{{tenant}}/prices

Retrieves prices for the given criteria.
The endpoint is available in the following versions: v1 and v2.
The second version of the endpoint introduces new fields in the response. Moreover, some fields known from version v1 become deprecated. In order to check details of changes for version v2 check data schema of the response body.



11. prices management - Retrieving price by id

GET {{api-url}}/price/{{tenant}}/prices/{{priceId}}?extendWithPriceModel=true

Retrieves a specific price by price ID.
The endpoint is available in the following versions: v1 and v2.
The second version of the endpoint introduces new fields in the response. Moreover, some fields known from version v1 become deprecated. In order to check details of changes for version v2 check data schema of the response body.



12. prices management - Updating price by id

PUT {{api-url}}/price/{{tenant}}/prices/{{priceId}}

Modifies an existing price by its price ID for a given product.
The endpoint is available in the following versions: v1 and v2.
The second version of the endpoint introduces new fields in the request. Moreover, some fields known from version v1 become deprecated. In order to check details of changes for version v2 check data schema of the request body.

Required scopes

  • price.price_manage


13. prices management - Deleting price by id

DELETE {{api-url}}/price/{{tenant}}/prices/{{priceId}}

Deletes a specific price by price ID.

Required scopes

  • price.price_manage


ENDPOINTS