Merchant API: rate limiting

About this article

This article describes the rate-limiting guidelines that apply to ChannelEngine's Merchant API.

Introduction

To ensure that ChannelEngine can continue serving its customers and partners efficiently and reliably, it is necessary to make use of rate limiting in the Merchant, Channel, and Channel Management APIs. The rate limits defined allow ChannelEngine's customers and partners to perform all calls required to conduct their business in a timely manner.

It is recommended that you make use of dynamic throttling and consider the limits and intervals communicated in the response headers.

Request rate limiting

To request the rate limit for each endpoint:

1. Go to ChannelEngine's OpenAPI/Swagger page for your environment. If you do not know its URL, replace the term 'example' in the URL https://example.channelengine.net/api/swagger/index.html with the first part of the URL of your ChannelEngine environment. E.g.: if your ChannelEngine environment is Sustainable Suits, its URL should be https://sustainable-suits.channelengine.net/ and its OpenAPI/Swagger URL should be https://sustainable-suits.channelengine.net/api/swagger/index.html.
2. Click Authorize and, in the Value field, enter your Merchant API key. To find your Merchant API key, log in to ChannelEngine and click Settings, Merchant API keys.
3. Click Close and select the endpoint for which you would like to know the limit.
4. Click Try it out. If the selected endpoint requires parameters, make sure to provide them before clicking Execute. Otherwise, click Execute.
5. In the Response headers section, check the values provided by the headers:

• • x-rate-limit-limit - provides you with an interval in minutes.
  • x-rate-limit-remaining - provides you with the number of calls remaining in that interval.