getInventorySummaries

get https://sellingpartnerapi-na.amazon.com/fba/inventory/v1/summaries

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.

Query Params

details

boolean

Defaults to false

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

granularityType

string

required

The granularity type for the inventory aggregation level.

granularityId

string

required

The granularity ID for the inventory aggregation level.

startDateTime

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

length ≤ 50

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

sellerSkus

sellerSku

string

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

nextToken

string

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

marketplaceIds

array of strings

required

length ≤ 1

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

marketplaceIds*

Responses

Response body

object

payload

object

The payload schema for the getInventorySummaries operation.

granularity

object

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 of objects

required

A list of inventory summaries.

inventorySummaries*

object

asin

string

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

fnSku

string

Amazon's fulfillment network SKU identifier.

sellerSku

string

The seller SKU of the item.

condition

string

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

inventoryDetails

object

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

lastUpdatedTime

date-time

The date and time that any quantity was last updated.

productName

string

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

totalQuantity

integer

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

stores

array of strings

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

stores

pagination

object

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

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 of objects

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

errors

object

code

string

required

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

message

string

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

The payload schema for the getInventorySummaries operation.

granularity

object

required

inventorySummaries

array of objects

required

A list of inventory summaries.

inventorySummaries*

object

asin

string

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

fnSku

string

Amazon's fulfillment network SKU identifier.

sellerSku

string

The seller SKU of the item.

condition

string

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

inventoryDetails

object

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

lastUpdatedTime

date-time

The date and time that any quantity was last updated.

productName

string

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

totalQuantity

integer

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

stores

array of strings

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

stores

pagination

object

nextToken

string

errors

array of objects

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

errors

object

code

string

required

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

message

string

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

The payload schema for the getInventorySummaries operation.

granularity

object

required

inventorySummaries

array of objects

required

A list of inventory summaries.

inventorySummaries*

object

asin

string

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

fnSku

string

Amazon's fulfillment network SKU identifier.

sellerSku

string

The seller SKU of the item.

condition

string

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

inventoryDetails

object

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

lastUpdatedTime

date-time

The date and time that any quantity was last updated.

productName

string

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

totalQuantity

integer

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

stores

array of strings

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

stores

pagination

object

nextToken

string

errors

array of objects

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

errors

object

code

string

required

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

message

string

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

The payload schema for the getInventorySummaries operation.

granularity

object

required

inventorySummaries

array of objects

required

A list of inventory summaries.

inventorySummaries*

object

asin

string

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

fnSku

string

Amazon's fulfillment network SKU identifier.

sellerSku

string

The seller SKU of the item.

condition

string

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

inventoryDetails

object

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

lastUpdatedTime

date-time

The date and time that any quantity was last updated.

productName

string

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

totalQuantity

integer

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

stores

array of strings

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

stores

pagination

object

nextToken

string

errors

array of objects

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

errors

object

code

string

required

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

message

string

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

The payload schema for the getInventorySummaries operation.

granularity

object

required

inventorySummaries

array of objects

required

A list of inventory summaries.

inventorySummaries*

object

asin

string

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

fnSku

string

Amazon's fulfillment network SKU identifier.

sellerSku

string

The seller SKU of the item.

condition

string

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

inventoryDetails

object

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

lastUpdatedTime

date-time

The date and time that any quantity was last updated.

productName

string

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

totalQuantity

integer

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

stores

array of strings

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

stores

pagination

object

nextToken

string

errors

array of objects

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

errors

object

code

string

required

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

message

string

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

The payload schema for the getInventorySummaries operation.

granularity

object

required

inventorySummaries

array of objects

required

A list of inventory summaries.

inventorySummaries*

object

asin

string

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

fnSku

string

Amazon's fulfillment network SKU identifier.

sellerSku

string

The seller SKU of the item.

condition

string

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

inventoryDetails

object

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

lastUpdatedTime

date-time

The date and time that any quantity was last updated.

productName

string

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

totalQuantity

integer

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

stores

array of strings

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

stores

pagination

object

nextToken

string

errors

array of objects

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

errors

object

code

string

required

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

message

string

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

The payload schema for the getInventorySummaries operation.

granularity

object

required

inventorySummaries

array of objects

required

A list of inventory summaries.

inventorySummaries*

object

asin

string

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

fnSku

string

Amazon's fulfillment network SKU identifier.

sellerSku

string

The seller SKU of the item.

condition

string

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

inventoryDetails

object

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

lastUpdatedTime

date-time

The date and time that any quantity was last updated.

productName

string

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

totalQuantity

integer

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

stores

array of strings

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

stores

pagination

object

nextToken

string

errors

array of objects

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

errors

object

code

string

required

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

message

string

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sellingpartnerapi-na.amazon.com/fba/inventory/v1/summaries?details=false&granularityType=Marketplace' \
3
     --header 'accept: application/json'


xxxxxxxxxx
62
}
1
{
2
  "payload": {
3
    "granularity": {
4
      "granularityType": "string",
5
      "granularityId": "string"
6
    },
7
    "inventorySummaries": [
8
      {
9
        "asin": "string",
10
        "fnSku": "string",
11
        "sellerSku": "string",
12
        "condition": "string",
13
        "inventoryDetails": {
14
          "fulfillableQuantity": 0,
15
          "inboundWorkingQuantity": 0,
16
          "inboundShippedQuantity": 0,
17
          "inboundReceivingQuantity": 0,
18
          "reservedQuantity": {
19
            "totalReservedQuantity": 0,
20
            "pendingCustomerOrderQuantity": 0,
21
            "pendingTransshipmentQuantity": 0,
22
            "fcProcessingQuantity": 0
23
          },
24
          "researchingQuantity": {
25
            "totalResearchingQuantity": 0,

200OK

400Request has missing or invalid parameters and cannot be parsed.

403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.

404The specified resource does not exist.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.