Appearance
Contact
Channel API
Operations
GET/v1/api/channelPOST/v1/api/channelGET/v1/api/channel/activeGET/v1/api/channel/{code}DELETE/v1/api/channel/{code}PATCH/v1/api/channel/{code}GET/v1/api/channel/{code}/customer-groupsGET/v1/api/channel/{code}/trade-conditionsGET/v1/api/channel/{code}/promotionsGET/v1/api/channel/{code}/pricelistPOST/v1/api/channel/{code}/pricelistGET/v1/api/channel/{code}/customersPUT/v1/api/channel/{code}/pricelist/primaryDELETE/v1/api/channel/{code}/pricelist/primaryDELETE/v1/api/channel/{code}/pricelist/{pricelistId}POST/v1/api/channel/{code}/customerPOST/v1/api/channel/{code}/customer/unassignPOST/v1/api/channel/{code}/customer-groupPOST/v1/api/channel/{code}/customer-group/unassignPOST/v1/api/channel/{code}/trade-conditionDELETE/v1/api/channel/{code}/trade-condition/{tradeConditionId}
Find all channels
GET
/v1/api/channel
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
- code
- isActive
- createdAt
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: name,code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- name
- code
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Create new channel
Get all active channels
Get channel by code
Delete channel
Update channel
Get customer groups assigned to channel
Get trade conditions assigned to channel
Get promotions assigned to channel
Get pricelist assigned to channel
Assign pricelist to channel
Get customers assigned to channel (direct and via group)
Set primary pricelist for channel (auto-assigns if not yet assigned)
Remove primary pricelist flag from channel
Unassign pricelist from channel
Bulk assign customers to channel by code
Bulk unassign customers from channel by code
Bulk assign customer groups to channel by code
Bulk unassign customer groups from channel by code
Assign trade condition to channel
Unassign trade condition from channel
Customer API
Operations
GET/v1/api/customerPOST/v1/api/customerGET/v1/api/customer/{code}DELETE/v1/api/customer/{code}PATCH/v1/api/customer/{code}GET/v1/api/customer/{code}/trade-conditionsGET/v1/api/customer/{code}/pricelist/individualGET/v1/api/customer/{code}/pricelistPOST/v1/api/customer/{code}/pricelistGET/v1/api/customer/{code}/pricesGET/v1/api/customer/{code}/catalogGET/v1/api/customer/{code}/promotionsGET/v1/api/customer/{code}/channelsPOST/v1/api/customer/{code}/pricelist/unassignPOST/v1/api/customer/{code}/trade-conditionPOST/v1/api/customer/{code}/trade-condition/unassign
Find all customers
GET
/v1/api/customer
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- code
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": "string", "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Create new customer
Get customer by code
Delete customer
Update customer
Get customer trade conditions
GET
/v1/api/customer/{code}/trade-conditions
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.scope
Filter by scope query param.
Format: filter.scope={$not}:OPERATION:VALUE
Example: filter.scope=$not:$like:John Doe&filter.scope=like:John
Available Operations
- $eq
- $not
Type
array
filter.status
Filter by status query param.
Format: filter.status={$not}:OPERATION:VALUE
Example: filter.status=$not:$like:John Doe&filter.status=like:John
Available Operations
- $eq
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: tradeCondition.type
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- tradeCondition.type
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Get customer individual pricelist
GET
/v1/api/customer/{code}/pricelist/individual
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- priceList.name
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": "string", "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Get customer assigned pricelist
GET
/v1/api/customer/{code}/pricelist
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.priceList.status
Filter by priceList.status query param.
Format: filter.priceList.status={$not}:OPERATION:VALUE
Example: filter.priceList.status=$not:$like:John Doe&filter.priceList.status=like:John
Available Operations
- $eq
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- priority
- priceList.priority
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Assign pricelist to customer
Get customer price and their base prices
GET
/v1/api/customer/{code}/prices
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.price
Filter by price query param.
Format: filter.price={$not}:OPERATION:VALUE
Example: filter.price=$not:$like:John Doe&filter.price=like:John
Available Operations
- $eq
- $gt
- $gte
- $lt
- $lte
Type
array
filter.finalPrice
Filter by finalPrice query param.
Format: filter.finalPrice={$not}:OPERATION:VALUE
Example: filter.finalPrice=$not:$like:John Doe&filter.finalPrice=like:John
Available Operations
- $eq
- $gt
- $gte
- $lt
- $lte
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: No default sorting specified, the result order is not guaranteed
Available Fields
- id
- pricelist
- product.code
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: product.code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- product.code
Type
array
select
List of fields to select.
Example: *,product.code,product.name
Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
Type
string
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Get products and their catalog prices (included promotions)
GET
/v1/api/customer/{code}/catalog
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel*
Channel code. Required — returns 400 if absent.
Type
Requiredstring
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: No default sorting specified, the result order is not guaranteed
Available Fields
- id
- code
- name
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- code
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": "string", "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Get promotions by code
GET
/v1/api/customer/{code}/promotions
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel
Channel code for filtering. If absent, returns all (global mode).
Type
string
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: No default sorting specified, the result order is not guaranteed
Available Fields
- id
Type
array
select
List of fields to select.
Example: id,status,sort,name,code
Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
Type
string
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Get available channels for customer
Unassign pricelist from customer
Assign trade condition to customer
Unassign trade condition from customer
Customer Group API
Operations
GET/v1/api/customer-groupPOST/v1/api/customer-groupGET/v1/api/customer-group/{code}DELETE/v1/api/customer-group/{code}PATCH/v1/api/customer-group/{code}GET/v1/api/customer-group/{code}/trade-conditionsGET/v1/api/customer-group/{code}/pricelistPOST/v1/api/customer-group/{code}/pricelistPOST/v1/api/customer-group/{code}/pricelist/unassignPOST/v1/api/customer-group/{code}/trade-conditionPOST/v1/api/customer-group/{code}/trade-condition/unassign
Find all customer groups
GET
/v1/api/customer-group
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- code
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": "string", "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Create new customer group
Get customer group by code
Delete customer group
Update customer group
Get customer group trade conditions
GET
/v1/api/customer-group/{code}/trade-conditions
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.scope
Filter by scope query param.
Format: filter.scope={$not}:OPERATION:VALUE
Example: filter.scope=$not:$like:John Doe&filter.scope=like:John
Available Operations
- $eq
- $not
Type
array
filter.status
Filter by status query param.
Format: filter.status={$not}:OPERATION:VALUE
Example: filter.status=$not:$like:John Doe&filter.status=like:John
Available Operations
- $eq
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: tradeCondition.type
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- tradeCondition.type
Type
array
Responses
application/json
JSON
"string"
Get customer group pricelist
GET
/v1/api/customer-group/{code}/pricelist
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.priceList.status
Filter by priceList.status query param.
Format: filter.priceList.status={$not}:OPERATION:VALUE
Example: filter.priceList.status=$not:$like:John Doe&filter.priceList.status=like:John
Available Operations
- $eq
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- priority
- priceList.priority
Type
array
Responses
application/json
JSON
"string"
Assign pricelist to customer group
Unassign pricelist from customer group
Assign trade condition to customer group
Unassign trade condition from customer group
POST
/v1/api/customer-group/{code}/trade-condition/unassign
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Customer group code
Type
Requiredstring
Request Body
application/json
JSON
"string"
Responses
Trade condition unassigned from group successfully
Get promotion list
GET
/v1/api/promotion
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel
Channel code for filtering. If absent, returns all (global mode).
Type
string
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.products.code
Filter by products.code query param.
Format: filter.products.code={$not}:OPERATION:VALUE
Example: filter.products.code=$not:$like:John Doe&filter.products.code=like:John
Available Operations
- $in
Type
array
filter.customers.code
Filter by customers.code query param.
Format: filter.customers.code={$not}:OPERATION:VALUE
Example: filter.customers.code=$not:$like:John Doe&filter.customers.code=like:John
Available Operations
- $in
Type
array
filter.status
Filter by status query param.
Format: filter.status={$not}:OPERATION:VALUE
Example: filter.status=$not:$like:John Doe&filter.status=like:John
Available Operations
- $eq
Type
array
filter.date_end
Filter by date_end query param.
Format: filter.date_end={$not}:OPERATION:VALUE
Example: filter.date_end=$not:$like:John Doe&filter.date_end=like:John
Available Operations
- $gte
- $lte
Type
array
filter.date_start
Filter by date_start query param.
Format: filter.date_start={$not}:OPERATION:VALUE
Example: filter.date_start=$not:$like:John Doe&filter.date_start=like:John
Available Operations
- $gte
- $lte
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
select
List of fields to select.
Example: id,status,date_created,date_updated,code
Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
Type
string
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Get active promotion list for SKUS/Customer
GET
/v1/api/promotion/active
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel
Channel code for filtering. If absent, returns all (global mode).
Type
string
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.products.code
Filter by products.code query param.
Format: filter.products.code={$not}:OPERATION:VALUE
Example: filter.products.code=$not:$like:John Doe&filter.products.code=like:John
Available Operations
- $in
Type
array
filter.customers.code
Filter by customers.code query param.
Format: filter.customers.code={$not}:OPERATION:VALUE
Example: filter.customers.code=$not:$like:John Doe&filter.customers.code=like:John
Available Operations
- $in
Type
array
filter.status
Filter by status query param.
Format: filter.status={$not}:OPERATION:VALUE
Example: filter.status=$not:$like:John Doe&filter.status=like:John
Available Operations
- $eq
Type
array
filter.date_end
Filter by date_end query param.
Format: filter.date_end={$not}:OPERATION:VALUE
Example: filter.date_end=$not:$like:John Doe&filter.date_end=like:John
Available Operations
- $gte
- $lte
Type
array
filter.date_start
Filter by date_start query param.
Format: filter.date_start={$not}:OPERATION:VALUE
Example: filter.date_start=$not:$like:John Doe&filter.date_start=like:John
Available Operations
- $gte
- $lte
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
select
List of fields to select.
Example: id,status,date_created,date_updated,code
Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
Type
string
customer
Customer information as a JSON string
Type
string
Example
"klient-x"products
List of products as a JSON string
Type
string
Example
"08G, 08GK"context
Promotion Context
Type
string
Valid values
"catalog""cart""all"Responses
application/json
JSON
"string"
Get promotion by ID
Get catalog prices
GET
/v1/api/catalog
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel
Channel code for multi-channel pricing. If not provided, uses default channel.
Type
string
Query Parameters
products*
Comma-separated list of products as a JSON string
Type
Requiredstring
Example
"08G,08GK"customer
Customer information as a JSON string
Type
string
Example
"klient-x"debug*
Type
Requiredboolean
Responses
application/json
JSON
[
]
Get catalog prices
POST
/v1/api/catalog
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel
Channel code for multi-channel pricing. If not provided, uses default channel.
Type
string
Query Parameters
debug*
Type
Requiredboolean
Request Body
application/json
JSON
"string"
Responses
application/json
JSON
[
]
Get cart prices
POST
/v1/api/cart
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel
Channel code for multi-channel pricing. If not provided, uses default channel.
Type
string
Query Parameters
debug*
Type
Requiredboolean
Request Body
application/json
JSON
"string"
Responses
application/json
JSON
"string"
Get products list
GET
/v1/api/products
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Current page
Type
string
Example
"1"perPage
Products per page
Type
string
Example
"10"customer
Customer reqeusting the list
Type
string
Example
"klient-x"products
List of products as a JSON string
Type
string
Example
"08G, 08GK"search
Search phrase (searches in product names)
Type
string
Example
"08"Responses
List all products (paginated, searchable by code)
GET
/v1/api/product
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- code
Type
array
select
List of fields to select.
Example: id,code,name
Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
Type
string
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Create a new product
Get a product by code (includes attributes and categories)
Delete a product and all related pricing data
Partially update a product (code is immutable)
Pricelist API
Operations
GET/v1/api/pricelistPOST/v1/api/pricelistGET/v1/api/pricelist/regularGET/v1/api/pricelist/customerPOST/v1/api/pricelist/individualGET/v1/api/pricelist/{id}DELETE/v1/api/pricelist/{id}PATCH/v1/api/pricelist/{id}GET/v1/api/pricelist/{id}/pricesPUT/v1/api/pricelist/{id}/pricesPATCH/v1/api/pricelist/{id}/pricesDELETE/v1/api/pricelist/individual/{id}GET/v1/api/pricelist/{id}/customersPOST/v1/api/pricelist/{id}/customersGET/v1/api/pricelist/{id}/customer-groupsPOST/v1/api/pricelist/{id}/customer-groupsPOST/v1/api/pricelist/{id}/customers/unassignPOST/v1/api/pricelist/{id}/customer-groups/unassign
Find all pricelists
GET
/v1/api/pricelist
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.scope
Filter by scope query param.
Format: filter.scope={$not}:OPERATION:VALUE
Example: filter.scope=$not:$like:John Doe&filter.scope=like:John
Available Operations
- $eq
- $not
Type
array
filter.status
Filter by status query param.
Format: filter.status={$not}:OPERATION:VALUE
Example: filter.status=$not:$like:John Doe&filter.status=like:John
Available Operations
- $eq
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": "string", "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Create a new standard pricelist
Find all regular pricelist
GET
/v1/api/pricelist/regular
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
Responses
application/json
JSON
"string"
Find all pricelist with customer scope
GET
/v1/api/pricelist/customer
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
Responses
application/json
JSON
"string"
Create an individual pricelist for a customer
Get a pricelist by ID
Delete a DRAFT pricelist
Partially update a pricelist
Get pricelist prices
GET
/v1/api/pricelist/{id}/prices
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
id*
Pricelist ID
Type
Requirednumber
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: No default sorting specified, the result order is not guaranteed
Available Fields
- id
Type
array
select
List of fields to select.
Example: *,priceList.id,product.id,product.code
Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
Type
string
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Strict upsert: all productCodes must exist or request fails with 400
Tolerant upsert: unknown productCodes are skipped, rest are saved
Delete an individual (DRAFT) pricelist
Get customers assigned to pricelist
Assign customers to a pricelist
Get customer groups assigned to pricelist
Assign customer groups to a pricelist
Unassign customers from a pricelist
Unassign customer groups from a pricelist
Find all supplier pricelists
GET
/v1/api/supplier-pricelist
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.scope
Filter by scope query param.
Format: filter.scope={$not}:OPERATION:VALUE
Example: filter.scope=$not:$like:John Doe&filter.scope=like:John
Available Operations
- $eq
- $not
Type
array
filter.status
Filter by status query param.
Format: filter.status={$not}:OPERATION:VALUE
Example: filter.status=$not:$like:John Doe&filter.status=like:John
Available Operations
- $eq
Type
array
filter.currencyCode
Filter by currencyCode query param.
Format: filter.currencyCode={$not}:OPERATION:VALUE
Example: filter.currencyCode=$not:$like:John Doe&filter.currencyCode=like:John
Available Operations
- $eq
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Find single supplier pricelist
Get supplier pricelist products
GET
/v1/api/supplier-pricelist/{id}/products
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
id*
Pricelist ID
Type
Requirednumber
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": "string", "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}
Trade Conditions API
Operations
GET/v1/api/trade-conditionsPOST/v1/api/trade-conditionsGET/v1/api/trade-conditions/{id}DELETE/v1/api/trade-conditions/{id}PATCH/v1/api/trade-conditions/{id}POST/v1/api/trade-conditions/{id}/customersPOST/v1/api/trade-conditions/{id}/customers/unassignPOST/v1/api/trade-conditions/{id}/customer-groupsPOST/v1/api/trade-conditions/{id}/customer-groups/unassignGET/v1/api/trade-conditions/{id}/products
Find all trade conditions
GET
/v1/api/trade-conditions
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Header Parameters
x-channel
Channel code for filtering. If absent, returns all (global mode).
Type
string
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.scope
Filter by scope query param.
Format: filter.scope={$not}:OPERATION:VALUE
Example: filter.scope=$not:$like:John Doe&filter.scope=like:John
Available Operations
- $eq
Type
array
filter.status
Filter by status query param.
Format: filter.status={$not}:OPERATION:VALUE
Example: filter.status=$not:$like:John Doe&filter.status=like:John
Available Operations
- $eq
Type
array
filter.validFrom
Filter by validFrom query param.
Format: filter.validFrom={$not}:OPERATION:VALUE
Example: filter.validFrom=$not:$like:John Doe&filter.validFrom=like:John
Available Operations
- $gte
- $lte
Type
array
filter.validTo
Filter by validTo query param.
Format: filter.validTo={$not}:OPERATION:VALUE
Example: filter.validTo=$not:$like:John Doe&filter.validTo=like:John
Available Operations
- $gte
- $lte
Type
array
filter.discountType
Filter by discountType query param.
Format: filter.discountType={$not}:OPERATION:VALUE
Example: filter.discountType=$not:$like:John Doe&filter.discountType=like:John
Available Operations
- $eq
Type
array
filter.type
Filter by type query param.
Format: filter.type={$not}:OPERATION:VALUE
Example: filter.type=$not:$like:John Doe&filter.type=like:John
Available Operations
- $eq
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
- name
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: name
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- name
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}