Getting started
Authentication
How to get your access token, based on OAuth 2.0 grants
All API requests must be authenticated. To get authorized, you must include a valid access token in the Authorization header:
1
Authorization: Bearer your-access-token
Copied!
Authorization grant flows
To get an access token, you need to execute an authorization flow by using a valid application as the client.
Grant type
Sales channel
Integration
Webapp
Client credentials
Password
Authorization code
Refresh token
For security reasons, access tokens expire after 2 hours. Refresh tokens expire after 2 weeks. Please note that the
/oauth/token endpoint is subject to a rate limit of max 50 reqs / 5 mins.Authorization scopes
For each of the above authorization flows you can restrict the scope to a specific market and/or stock location.
The access token scope is a string composed by
"{{resource_name}}:{{resource_number}}", where resource_number is the number — not the ID — of the market or stock location you want to put in scope.Putting a market in scope
By including a market scope in the access token request —
market:1234 — all the resources (e.g. SKUs, prices, stock items) that you fetch are automatically filtered.1
{
2
"grant_type": "authorization-grant",
3
"client_id": "your-client-id",
4
...,
5
"scope": "market:1234"
6
}
Copied!
When fetching a collection of SKUs with a market in scope only the SKUs that are sellable in that market are returned. To be sellable in a market an SKU must have a price in the market's price list and at least one stock item in one of the market's stock locations, regardless of its quantity.
Sales channel applications require a market in scope when requesting their access token to perform the permitted CRUD actions. If the market in scope is associated with a customer group, it becomes private and can be accessed only by the customers belonging to the group — in that case, to get your token you must use the password flow.
Putting a stock location in scope
By including a stock location scope in the access token request —
stock_location:4567 — the stock is restricted to the SKUs available in that specific stock location.1
{
2
"grant_type": "authorization-grant",
3
"client_id": "your-client-id",
4
...,
5
"scope": "market:1234 stock_location:4567"
6
}
Copied!
When putting a stock location in scope, adding the associated market in the access token request is mandatory. If the market scope is missing or the stock location doesn't belong to the market in scope the API responds with a
400 Bad Request error code.Last modified 14d ago
Copy link