Download OpenAPI specification:Download
The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon's fulfillment network.
Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime and sellerSkus parameters:
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 2 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
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. |
{- "payload": {
- "granularity": {
- "granularityType": "string",
- "granularityId": "string"
}, - "inventorySummaries": [
- {
- "asin": "string",
- "fnSku": "string",
- "sellerSku": "string",
- "condition": "string",
- "inventoryDetails": {
- "fulfillableQuantity": 0,
- "inboundWorkingQuantity": 0,
- "inboundShippedQuantity": 0,
- "inboundReceivingQuantity": 0,
- "reservedQuantity": {
- "totalReservedQuantity": 0,
- "pendingCustomerOrderQuantity": 0,
- "pendingTransshipmentQuantity": 0,
- "fcProcessingQuantity": 0
}, - "researchingQuantity": {
- "totalResearchingQuantity": 0,
- "researchingQuantityBreakdown": [
- {
- "name": "researchingQuantityInShortTerm",
- "quantity": 0
}
]
}, - "unfulfillableQuantity": {
- "totalUnfulfillableQuantity": 0,
- "customerDamagedQuantity": 0,
- "warehouseDamagedQuantity": 0,
- "distributorDamagedQuantity": 0,
- "carrierDamagedQuantity": 0,
- "defectiveQuantity": 0,
- "expiredQuantity": 0
}
}, - "lastUpdatedTime": "2019-08-24T14:15:22Z",
- "productName": "string",
- "totalQuantity": 0
}
]
}, - "pagination": {
- "nextToken": "string"
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}