listInventory

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.

Request

Query Params

sku

string

optional

Filter by seller or merchant SKU for the item.

Example:

TestSKU

sortOrder

enum<string>

optional

Sort the response in ASCENDING or DESCENDING order.

Allowed values:

ASCENDINGDESCENDING

details

enum<string>

optional

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

Allowed values:

SHOWHIDE

Example:

SHOW

nextToken

string

optional

Token to retrieve the next set of paginated results.

Example:

SampleToken

maxResults

integer <int32>

optional

Maximum number of results to return.

>= 1<= 200

Default:

Example:

Responses

🟢200OK

application/json

The 200 response for listInventory.

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

AWD inventory payload.

inventory

array[object (InventorySummary) {9}]

required

List of inventory summaries.

asin

string

optional

The Amazon Standard Identification Number (ASIN) of an item.

fnSku

string

optional

Amazon's fulfillment network SKU identifier.

sellerSku

string

optional

The seller SKU of the item.

condition

string

optional

The condition of the item as described by the seller (for example, New Item).

inventoryDetails

object (InventoryDetails)

optional

Summarized inventory details. This object will not appear if the details parameter in the request is false.

lastUpdatedTime

string <date-time>

optional

The date and time that any quantity was last updated.

productName

string

optional

The localized language product title of the item within the specific marketplace.

totalQuantity

integer

optional

The total number of units in an inbound shipment or in Amazon fulfillment centers.

stores

array[string]

optional

A list of seller-enrolled stores that apply to this seller SKU.

nextToken

string

optional

Token to retrieve the next set of paginated results.

Example:

SampleToken

Example

{
    "inventory": [
        {
            "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"
            ]
        }
    ],
    "nextToken": "SampleToken"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses