getInventorySummaries

Tested

GET

/fba/inventory/v1/summaries

fbaInventory

Last modified:2024-12-11 06:49:22

Maintainer:Not configured

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

Query Params

details

boolean

optional

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

Default:

false

granularityType

enum<string>

required

The granularity type for the inventory aggregation level.

Allowed value:

Marketplace

Example:

Marketplace

granularityId

string

required

The granularity ID for the inventory aggregation level.

Example:

startDateTime

string <date-time>

optional

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[string]

optional

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

<= 50 items

sellerSku

string

optional

A single seller SKU used for querying the specified seller SKU inventory summaries.

nextToken

string

optional

String token returned in the response of your previous request. The string token will expire 30 seconds after being created.

marketplaceIds

array[string]

required

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

<= 1 items

Example:

["{{MARKET_USA}}"]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/fba/inventory/v1/summaries?details&granularityType=Marketplace&granularityId={{MARKET_USA}}&startDateTime&sellerSkus&sellerSku&nextToken&marketplaceIds={{MARKET_USA}}'

Responses

🟢200OK

application/json

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The Response schema.

payload

object (GetInventorySummariesResult)

optional

The payload schema for the getInventorySummaries operation.

granularity

object (Granularity)

required

Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace.

inventorySummaries

array[object (InventorySummary) {9}]

required

A list of inventory summaries.

pagination

object (Pagination)

optional

The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.

nextToken

string

optional

A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

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

getItemEligibilityPreview

createInventoryItem