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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
siteCode | string | A list of site codes should be passed. <b>This attribute is available for Price V1 and Price V2.</b> | |
currency | string | A list of currency should be passed. <b>This attribute is available for Price V1 and Price V2.</b> | |
effectiveDate | string | The date in ISO 8601 format to get the prices which are effective at the specified date. <b>This attribute is available for Price V1 and Price V2.</b> | |
sort | string | The list of comma-separated properties used to sort the results. | |
| By default, the column values are sorted in ascending order. | |||
| Can either be in the form of fieldName or fieldName:asc,fieldName:desc. | |||
| If you want to sort by localized attributes, you must use the following form: | |||
| fieldName.language or fieldName.language:asc,fieldName.language:desc. | |||
pageNumber | number | The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. | |
| The number of the first page is 1. | |||
pageSize | number | The number of documents being retrieved on the page. | |
itemId | string | A list of itemId should be returned. <b>This attribute is only available for Price V2.</b> | |
itemType | string | A list of item types that should be returned. <b>This attribute is only available for Price V2.</b> | |
country | string | A list of countries that should be returned. <b>This attribute is only available for Price V2.</b> | |
principalId | null | ||
priceModelId | null |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Version | string | The version of the schema that should be used in the request/response payload | |
Accept | string |
RESPONSES
status: OK
[{"id":"622f334aaa933c3be1f8eba0","productId":"53a358901b2e9dd2718b5c4e","itemId":{"itemType":"PRODUCT","id":"53a358901b2e9dd2718b5c4e"},"siteCode":"1111","currency":"USD","country":"USA","originalAmount":99.99,"measurementUnit":{"quantity":1,"unitCode":"kg"},"salePrice":{"discountRate":20,"description":"20% OFF, Amazing!"},"wholesale":{"minQuantity":2,"maxQuantity":10},"priceModelId":"622f11d76825075ab563ed79","restrictions":{"principals":[{"type":"USER","id":"4a1c3058b9ce48459daca560915549c5"}],"validity":{"from":"2021-08-31T00:07:42.518Z","to":"2022-08-31T00:07:42.518Z"},"siteCodes":["1111"]},"tierValues":[{"priceValueWithMarkup":"13.34","priceValueWithoutMarkup":"13.34"}],"mixins":{"test2":{"atr1":"test","atr2":"test2"},"test1":{"atr1":"test","atr2":"test2"}},"metadata":{"version":1,"createdAt":"2022-03-14T12:21:30.589Z","modifiedAt":"2022-03-14T12:21:30.589Z"}},{"id":"622f436e51b949194bdf6191","productId":"53a358901b2e9dd2718b5c4e","itemId":{"itemType":"PRODUCT","id":"53a358901b2e9dd2718b5c4e"},"siteCode":"1111","currency":"USD","country":"USA","originalAmount":99.99,"measurementUnit":{"quantity":1,"unitCode":"kg"},"salePrice":{"discountRate":20,"description":"20% OFF, Amazing!"},"wholesale":{"minQuantity":2,"maxQuantity":10},"priceModelId":"622f11d76825075ab563ed79","restrictions":{"principals":[{"type":"USER","id":"4a1c3058b9ce48459daca560915549c5"}],"validity":{"from":"2021-08-31T00:07:42.518Z","to":"2022-08-31T00:07:42.518Z"},"siteCodes":["1111"]},"tierValues":[{"priceValueWithMarkup":"13.34","priceValueWithoutMarkup":"13.34"}],"mixins":{"test2":{"atr1":"test","atr2":"test2"},"test1":{"atr1":"test","atr2":"test2"}},"metadata":{"version":1,"createdAt":"2022-03-14T13:30:22.032Z","modifiedAt":"2022-03-14T13:30:22.032Z","mixins":{"test2":"url2","test1":"url1"}}}]