getInventorySummaries

北美(North America）

https://sellingpartnerapi-na.amazon.com

GET

/fba/inventory/v1/summaries

FBA Inventory

返回库存摘要的列表。返回的摘要依赖于startDateTime、sellerSkus和sellerSku参数的存在与否：

当省略startDateTime、sellerSkus和sellerSku参数时，返回所有具有可用详细信息的库存摘要。

当提供startDateTime时，该操作返回在指定日期和时间后发生更改的库存摘要。sellerSkus和sellerSku参数被忽略。重要提示：为了避免错误，请同时使用startDateTime和nextToken以获取在指定日期和时间后已更改的库存摘要的下一页面。

当提供sellerSkus参数时，该操作仅返回指定sellerSkus的库存摘要。sellerSku参数被忽略。

当提供sellerSku参数时，该操作仅返回指定sellerSku的库存摘要。

注意：与此操作相关的参数可能包含特殊字符，必须编码才能成功调用API。为了避免在编码URL时与SKU相关的错误，请参阅URL编码。

使用计划：

速率（每秒请求数）	突发
2	2

x-amzn-RateLimit-Limit响应头返回申请的操作所应用的使用计划速率限制（如适用）。上表指示了该操作的默认速率和突发值。其商业需求需要更高吞吐量的销售合作伙伴，可能会看到比这里显示的更高的速率和突发值。有关更多信息，请参见销售合作伙伴API中的使用计划和速率限制。

请求参数

Query 参数

details

boolean

可选

如果为真，则返回带有额外汇总库存细节和数量的库存摘要。否则，仅返回库存摘要（默认值）。

默认值:

false

granularityType

enum<string>

必需

库存汇总级别的粒度类型。

枚举值:

Marketplace

granularityId

string

必需

库存汇总级别的粒度 ID。

startDateTime

string <date-time>

可选

一个以ISO8601格式表示的开始日期和时间。如果指定，将返回自那时以来所有发生变化的库存总结。您必须指定一个时间，不能早于您调用API时的日期和时间的18个月之前。注意：不会检测到inboundWorkingQuantity、inboundShippedQuantity和inboundReceivingQuantity的变化。

sellerSkus

array[string]

可选

一份需要返回库存摘要的卖家SKU列表。您可以指定最多50个SKU。

<= 50 items

sellerSku

string

可选

用于查询指定卖家SKU库存摘要的单一卖家SKU。

nextToken

string

可选

字符串令牌在您之前请求的响应中返回。字符串令牌将在创建后 30 秒过期。

marketplaceIds

array[string]

必需

要返回库存摘要的市场的市场 ID。

<= 1 items

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sellingpartnerapi-na.amazon.com/fba/inventory/v1/summaries?granularityType&granularityId&marketplaceIds'

返回响应

🟢200成功

application/json

好的

Headers

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

响应模式。

payload

object (GetInventorySummariesResult)

可选

获取库存摘要操作的有效载荷架构。

granularity

object (Granularity)

必需

描述可以聚合库存数据的粒度。例如，如果您使用市场粒度，则可履行数量将反映在特定市场中可以履行的库存。

inventorySummaries

array[object (InventorySummary) {8}]

库存摘要清单。

必需

pagination

object (Pagination)

可选

将请求的结果以定义大小的批次返回的过程称为分页。这是为了对结果大小和总体吞吐量进行一些控制。这是一种流量管理的形式。

nextToken

string

可选

用于检索结果下一页的生成字符串。如果返回了 nextToken，请将 nextToken 的值传递到下一个请求。如果未返回 nextToken，则没有更多项目可以返回。

errors

array[object (Error) {3}]

可选

请求失败时返回的错误响应列表。

code

string

必需

一个标识发生错误类型的错误代码。

message

string

可选

一种以人类可读的形式描述错误状态的消息。

details

string

可选

可以帮助来电者理解或解决问题的额外信息。

示例

{
    "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"
        }
    ]
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠429429

🔴500服务器错误

🔴503服务器故障

getItemEligibilityPreview

createInventoryItem