Rate Limits

The Admin API limits the number of calls to its endpoints to keep the system load under the manageable level.

Rate Limit Scopes

Most Admin API endpoints belong to a rate limit scope such as stockWrite, productRead, etc. Each scope defines its own rate limit, meaning that there might be no more than X requests within Y minutes to an endpoint of the particular scope.

There are usually dedicated scopes for read and write operations. For example, if you have reached the limit by adding new stocks in the system, you can still retrieve stocks for a specific variant.

You can find the actual scope limits and the relation between an endpoint and a scope in the API Reference. If the scope is not given, there are no rate limits.

Rate Limit Headers

Every API response includes the following rate limit related headers:

Rate Limits

Response Example

The response for an exceeded rate limit is as follows:

json

Copy

{
    "errors": [
        {
            "errorKey": "RATE_LIMIT_EXCEED",
            "message": "The request rate limit exceeded. Please try again later.",
            "context": {}
        }
    ]
}