Price lists
Was this helpful?
Was this helpful?
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Price list's unique identifier, generated when the price list 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.GET /price/{tenant}/price-lists/{priceListId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "example-id-1",
"name": {
"en": "Example Price List 1"
},
"currency": "EUR",
"countries": [
"PL"
],
"customerGroups": [
"customer-group-1",
"customer-group-2"
],
"siteCode": "example-site-1",
"validity": {
"from": "2022-05-01T00:00:00.000Z",
"to": "2025-05-01T00:00:00.000Z"
},
"metadata": {
"version": 1,
"createdAt": "2022-03-31T13:18:02.379Z",
"modifiedAt": "2022-03-31T13:18:02.379Z"
}
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Price list's unique identifier, generated when the price list is created.
DELETE /price/{tenant}/price-lists/{priceListId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
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:descPrice list's name.
Date on which retrieved prices should be valid, compliant with the ISO 8601 standard. Format:date-fullyear "-" date-month "-" date-mday "T" partial-time time-offset
2022-01-01T00:00:00ZCode of the currency in which the prices are expressed, as defined in the Currency Service.
Code of the country to which the price list applies, as defined in the Country Service.
Code of the site to which the price list applies.
Comma separated list of IDs of the customer groups to which the price list applies.
Code of the region to which the price list applies.
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.
falseGET /price/{tenant}/price-lists HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "example-id-1",
"name": {
"en": "Example Price List 1"
},
"currency": "EUR",
"countries": [
"PL"
],
"customerGroups": [
"customer-group-1",
"customer-group-2"
],
"siteCode": "example-site-1",
"validity": {
"from": "2022-05-01T00:00:00.000Z",
"to": "2025-05-01T00:00:00.000Z"
},
"metadata": {
"version": 1,
"createdAt": "2022-03-31T13:18:02.379Z",
"modifiedAt": "2022-03-31T13:18:02.379Z"
}
},
{
"id": "example-id-2",
"name": {
"en": "Example Price List 2"
},
"currency": "EUR",
"regions": [
"DACH"
],
"customerGroups": [
"customer-group-1"
],
"siteCode": "example-site-2",
"metadata": {
"version": 1,
"createdAt": "2022-03-31T13:18:02.379Z",
"modifiedAt": "2022-03-31T13:18:02.379Z"
}
}
]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, then the localized fields should be provided as a map of single translation, where the key is a language code and the value is in a respective language.Content-Language header is empty, then the localized fields should be provided as maps of single translation, where the key is a language code and the value is in a respective language. 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.
POST /price/{tenant}/price-lists HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238
{
"name": {
"en": "Example Price List 1"
},
"currency": "EUR",
"countries": [
"PL"
],
"customerGroups": [
"customer-group-1",
"customer-group-2"
],
"siteCode": "example-site-1",
"validity": {
"from": "2022-05-01T00:00:00.000Z",
"to": "2025-05-01T00:00:00.000Z"
}
}{
"id": "6245a8f578a8576e338fa9c2"
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Price list's unique identifier, generated when the price list 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, then the localized fields should be provided as a map of single translation, where the key is a language code and the value is in a respective language.Content-Language header is empty, then the localized fields should be provided as maps of single translation, where the key is a language code and the value is in a respective language. 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.
PUT /price/{tenant}/price-lists/{priceListId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 244
{
"name": {
"en": "Example Price List 1"
},
"currency": "EUR",
"countries": [
"DE"
],
"customerGroups": [
"customer-group-3"
],
"siteCode": "example-site-1",
"validity": {
"from": "2022-05-01T00:00:00.000Z",
"to": "2025-05-01T00:00:00.000Z"
},
"metadata": {
"version": 1
}
}{
"id": "12345678-1234-1234-1234-123456789012"
}