API-Related Information (AMP SP-API)

This article contains the following information related to APIs.

• API Version
• Pagination Info
• Throttling Info
• Handling Errors

API Version

This Connector supports these versions of SP APIs. Both FBM and FBA selling models are supported.

For more information on Amazon SP API Versions and release notes, please refer to https://developer-docs.amazon.com/sp-api/page/versions.

Pagination Information

When a request produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there will be no nextToken key in the pagination object.

For example, GetOrders.bps returns max 100 orders at a time in the response. If there are more than 100 orders to be retrieved, a NextToken field will be made available in the GetOrders.bps response. This NextToken value can be used to retrieve the orders instead of other criteria to retrieve the next set of orders. If NextToken is not returned, then there are no more orders.

Throttling Information

Throttling is the process of limiting the number of requests you can submit to a given operation in a given amount of time. In the Selling Partner API, requests are rate-limited using the token bucket algorithm. The algorithm is based on the analogy of a bucket that contains tokens, where each token can be exchanged to make a request. Tokens are automatically added to the bucket using a set rate-per-second until the maximum size of the bucket is reached. The maximum size is also called the burst rate. Each request subtracts a token from the bucket. Throttling occurs when a request is made for which no token is available because the bucket is empty. A throttled request results in an error response usually with 429 status code.

When you submit a request to a Selling Partner API operation, the current rate limits for that operation are returned in the x-amzn-RateLimit-Limit response header, on a best-effort basis, for HTTP status codes 20x, 400 and 404 only.

How to retrieve Throttling information from this Connector

In the integration project implemented, right after the step where a BP from the connector project is called, add a new step called Connector Response Header Parser that will retrieve header information such as x-amzn-RateLimit-Limit.

Sample Response Headers:

  {
    "x-amz-apigw-id": [
       "M6P96EE_oAMFT8w="
    ],
    "Connection": [
      "keep-alive"
    ],
    "x-amzn-RequestId": [
      "de937cf0-7867-4250-9e96-67ea58b2444b"
    ],
    "Content-Length": [
      "41059"
    ],
    "Date": [
      "Wed, 02 Feb 2022 10:43:38 GMT"
    ],
    "X-Amzn-Trace-Id": [
      "Root=1-61fa6058-26f254106be3da3c13f01feb"
    ],
    "Content-Type": [
      "application/json"
    ],
    "x-amzn-RateLimit-Limit": [
      "0.0167"
    ]
  }

For more information on Throttling please refer to the link: https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api

Handling Errors

If the Connector BP (i.e., API call) is successful (returns status code between 200 & 300), then the BP task passes and returns the response payload (in Studio>Admin Console> Auditor View the task is marked as completed).

Or

In case the Connector BP (i.e. API call) has failed (any response status code not between 200 & 300), then the BP task will fail without returning any response payload (in Studio>Admin Console> Auditor View the task is marked as failed, an error payload is returned from Amazon, and stack trace logged) 

Or

In case this Connector BP API call execution fails (which can be an internal error such as payload parse issue), then the task will fail without returning any response payload (in Studio>Admin Console>Auditor View, the task is marked as failed, and a stack trace is logged).

Below are some of the error codes for Amazon SP APIs.

For more information on specific SP API response codes please visit the Error Response and Schemas section of Amazon's documentation: https://developer-docs.amazon.com/sp-api/