listInventory

get https://sellingpartnerapi-na.amazon.com/awd/2024-05-09/inventory

Lists AWD inventory associated with a merchant with the ability to apply optional filters.

Usage Plan:

Rate (requests per second)	Burst
2	2

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Query Params

sku

string

Filter by seller or merchant SKU for the item.

sortOrder

string

Sort the response in ASCENDING or DESCENDING order.

details

string

Set to SHOW to return summaries with additional inventory details. Defaults to HIDE, which returns only inventory summary totals.

nextToken

string

A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

maxResults

int32

1 to 200

Defaults to 25

Maximum number of results to return.

Responses

`listInventory`.

400

Request has missing or invalid parameters and cannot be parsed.

403

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404

The resource specified does not exist.

413

The request size exceeded the maximum accepted size.

415

The request payload is in an unsupported format.

429

The frequency of requests was greater than allowed.

500

An unexpected condition occurred that prevented the server from fulfilling the request.

503

Temporary overloading or maintenance of the server.

xxxxxxxxxx
 
{
  "inventory": [
    {
      "expirationDetails": [
        {
          "expiration": "2025-04-01T15:22:36.156Z",
          "onhandQuantity": 0
        }
      ],
      "inventoryDetails": {
        "availableDistributableQuantity": 0,
        "replenishmentQuantity": 0,
        "reservedDistributableQuantity": 0
      },
      "sku": "string",
      "totalInboundQuantity": 0,
      "totalOnhandQuantity": 0
    }
  ],
  "nextToken": "SampleToken"
}

x-amzn-RateLimit-Limit	Your rate limit (requests per second) for this operation.
x-amzn-RequestId	Unique request reference identifier.

200The 200 response for listInventory.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.

`listInventory`.