Stocks API Overview

The Stocks API can be used to set the available stock of an article. All stock updates in a single batch must have a unique combination of sales_channel_id and ean. A batch request can contain up to 1000 stock updates.

Stocks API Scopes

Updating stock levels with the Stocks API requires the products/stock/write scope.

Many zDirect APIs require clients to have specific permissions or scopes for read or write access. For more information on how to assign and configure app scopes, see the Applications section of our zDirect Portal guide.

Rate limiting

Each app may only make the following number of POST requests per second OR submit the following number of stock updates per minute:

Environment Requests / second Stock updates / minute
Production 1 1000
Sandbox 1 1000

For example, a client can send 1 request with a batch of 16 stock updates each every second of a minute. Or it can send one request with a batch of 1000 stock updates in the beginning of the minute, and then it would have to wait until the next minute starts.

For more information, see Rate Limiting.

Sandbox behaviour

Stock updates made in the sandbox environment are given the same validation upon submission, but submitted data is not persisted or propagated.

For more information, see Sandbox Testing in our Getting Started Guide.

Additional resources

Contact Support