getInventorySummaries - Amazon SP API

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

All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.

When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.

When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.

When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.

Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.

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, see Usage Plans and Rate Limits in the Selling Partner API.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Headers

Body

Example

{
    "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,
                "stores": [
                    "string"
                ]
            }
        ]
    },
    "pagination": {
        "nextToken": "string"
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable