Selling Partner API for FBA Inventory (v1)

Download OpenAPI specification:Download

The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon's fulfillment network.

fbaInventory

getInventorySummaries

Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime and sellerSkus parameters:

  • All inventory summaries with available details are returned when the startDateTime and sellerSkus parameters are omitted.
  • When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus parameter is ignored.
  • When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus.

Usage Plan:

Rate (requests per second) Burst
2 2

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
details
boolean
Default: false

true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).

granularityType
string
Value: "Marketplace"

The granularity type for the inventory aggregation level.

granularityId
required
string

The granularity ID for the inventory aggregation level.

startDateTime
string <date-time>

A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.

sellerSkus
Array of strings <= 50 items

A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.

nextToken
string

String token returned in the response of your previous request.

marketplaceIds
required
Array of strings <= 1 items

The marketplace ID for the marketplace for which to return inventory summaries.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "pagination": {
    },
  • "errors": [
    ]
}