Logo
Emporix Digital Commerce Platform API Documentation

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.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept-Language
string The Accept-Language request HTTP header defines which languages the client is able to understand, and which locale variant is preferred. If empty English language is returned. It can be a priority list working as a fallback mechanism.
Accept
string
X-Version
string




RESPONSES

status OK

{ "id": "722730472d440745d5b1b34e", "name": "Piece tiered price model", "description": "Price model description", "includesTax": false, "includesMarkup": false, "measurmentUnit": { "quantity": 1, "unitCode": "piece" }, "tiersDefinition": { "tierType": "TIER", "tiers": [ { "minQuantity": { "quantity": 5, "unitCode": "piece" } }, { "minQuantity": { "quantity": 10, "unitCode": "piece" } } ] } }



Curl
curl -X GET 'api-url/price/api-url/priceModels/api-url' -H 'Accept-Language: *' -H 'Accept: application/json' -H 'X-Version: v2'

ENDPOINTS