# 概述
FBA库存的销售伙伴API让你以编程方式检索亚马逊履约网络中的库存信息.
# Version information
版本 : v1
# Operations
# 路径
# getInventorySummaries
GET /fba/inventory/v1/summaries
# Description
返回一个库存摘要的列表. 返回的摘要取决于startDateTime和sellerSkus参数的存在与否
-当省略startDateTime和sellerSkus参数时,将返回所有具有可用细节的库存摘要.
- 当提供startDateTime时,该操作会返回在指定日期和时间之后发生变化的库存摘要. 忽略sellerSkus参数.
- 当提供sellerSkus参数时,该操作只返回指定sellerSkus的库存摘要.
使用计划:
Rate (requests per second) | Burst |
---|---|
2 | 2 |
更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
*Query | *details optional | true,返回带有额外汇总库存细节和数量的库存摘要.否则,仅返回库存摘要(default value). | boolean | "false" |
*Query | granularityType required | 库存汇总级别的粒度类型. | enum (GranularityType | - |
*Query | *granularityId required | 库存聚合级别的粒度ID. | string | - |
Query | startDateTime optional | A start date and time in ISO8601 format. 如果指定了,所有自那以后改变的库存汇总都会被返回. 你必须指定一个不早于你调用API时的18个月的日期和时间. 注意inboundWorkingQuantity、inboundShippedQuantity和inboundReceivingQuantity的变化不会被检测到. | string (date-time) | - |
Query | sellerSkus optional | A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. Max count : 50 | < string > array | - |
*Query | *nextToken optional | String token在你前一个请求的响应中返回. | string | - |
Query | marketplaceIds required | 用于返回库存摘要的市场ID. Max count : 1 | < string > array | - |
# Responses
HTTP Code | Description | Schema |
---|---|---|
200 | OK 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求. x-amzn-RequestId (string) Unique request reference ID. | GetInventorySummariesResponse |
关于错误状态代码、描述和模式,见错误响应和模式.
# Produces
应用/json
# 错误响应和模式
该表包含HTTP状态代码和错误响应的相关信息.
HTTP Code | Description | Schema |
---|---|---|
400 | Request有缺失或无效的参数,无法解析. Headers x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference ID. | GetInventorySummariesResponse |
403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌、无效签名或未找到资源. 头信息 x-amzn-RequestId (string):Unique request reference ID. | GetInventorySummariesResponse |
404 | 指定的资源不存在. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference ID. | GetInventorySummariesResponse |
429 | 请求的频率超过了允许的范围. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已经过时,不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | GetInventorySummariesResponse |
500 | 发生了一个意外情况,使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已经过时,不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | GetInventorySummariesResponse |
503 | 服务器的临时超载或维护. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码,速率限制头已经过时,不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | GetInventorySummariesResponse |
# Definitions
# Granularity
描述库存数据可以汇总的粒度. 例如,如果你使用市场粒度,可履行的数量将反映在给定市场中可以履行的库存.
Name | Description | Schema |
---|---|---|
granularityType optional | 库存汇总级别的颗粒度类型. | string |
granularityId optional | 指定颗粒度类型的颗粒度ID.当颗粒度类型是Marketplace时,指定marketplaceId. | string |
# ReservedQuantity
保留库存的数量.
Name | Description | Schema |
---|---|---|
totalReservedQuantity optional | 亚马逊履约网络中目前正在挑选、包装和运输的单位总数;或因测量、抽样或其他内部流程而被搁置的单位总数. | integer |
pendingCustomerOrderQuantity optional | 保留给客户订单的单位数量. | integer |
pendingTransshipmentQuantity optional | 正在从一个履行中心转移到另一个履行中心的单位数量. | integer |
fcProcessingQuantity optional | 被搁置在履行中心进行额外处理的单位数量. | integer |
# ResearchingQuantityEntry
在我们的履行中心积极确认的错位或仓库损坏的库存.
Name | Description | Schema |
---|---|---|
名称 要求 | 研究的期限. | enum (名称 |
数量 所需 | 单位的数量. | 整数 |
# ResearchingQuantity
在我们的执行中心正在积极确认的错位或仓库损坏的单位数量.
Name | Description | Schema |
---|---|---|
totalResearchingQuantity optional | 目前在亚马逊的履行网络中正在研究的单位总数. | integer |
researchingQuantityBreakdown optional | A list of quantity details for items currently being researched. | < ResearchingQuantityEntry > array |
# UnfulfillableQuantity
无法填满的库存数量.
Name | Description | Schema |
---|---|---|
totalUnfulfillableQuantity optional | 亚马逊履约网络中处于无法销售状态的单位总数. | integer |
customerDamagedQuantity optional | 客户受损处理的单位数量. | integer |
仓库损坏数量 可选 | 仓库损坏处理中的单位数量. | integer |
distributorDamagedQuantity optional | 分销商受损处理中的单位数量. | integer |
carrierDamagedQuantity optional | 承运人受损处置中的单位数量. | integer |
缺陷数量 可选择 | 缺陷处理中的单位数量. | integer |
expiredQuantity optional | 过期处理的数量. | integer |
# InventoryDetails
总结的库存细节.如果请求中的细节参数为false,这个对象将不会出现.
Name | Description | Schema |
---|---|---|
fulfillableQuantity optional | 可以被拣选、包装和运输的物品数量. | integer |
inboundWorkingQuantity optional | 您已经通知亚马逊的进货数量. | integer |
inboundShippedQuantity optional | 您已经通知亚马逊并提供了跟踪号码的进货数量. | integer |
inboundReceivingQuantity optional | 尚未被亚马逊履行中心接收处理的单位数量,但属于进货货物的一部分,有些单位已经被接收处理. | integer |
reservedQuantity optional | The quantity of reserved inventory. | ReservedQuantity |
researchingQuantity optional | 在我们的履行中心正在积极确认的错位或仓库损坏的单位数量. | ResearchingQuantity |
unfulfillableQuantity optional | The quantity of unfulfillable inventory. | UnfulfillableQuantity |
# InventorySummary
一个特定项目的库存摘要.
Name | Description | Schema |
---|---|---|
asin optional | 亚马逊的标准识别码(ASIN)的物品. | string |
fnSku optional | 亚马逊的履行网络SKU识别码. | string |
sellerSku optional | 物品的卖方SKU. | string |
condition optional | 卖家描述的物品状况(例如:New Item). | string |
inventoryDetails optional | Summarized inventory details.如果请求中的details参数为false,这个对象将不会出现. | InventoryDetails |
lastUpdatedTime optional | 任何数量最后更新的日期和时间. | string (date-time) |
productName optional | 该商品在特定市场中的本地化语言产品名称. | string |
totalQuantity optional | 进货或在亚马逊履行中心的单位总数. | integer |
# InventorySummaries
库存摘要的列表.
类型< InventorySummary >数组
# Pagination
将请求的结果分批返回的过程,定义的大小称为页数.这样做是为了对结果大小和总体吞吐量进行一些控制.这是一种流量管理的形式.
Name | Description | Schema |
---|---|---|
nextToken optional | A生成的字符串,用于检索结果的下一页.如果返回nextToken,将nextToken的值传递给下一个请求.如果不返回nextToken,则没有更多的项目可以返回. | string |
# GetInventorySummariesResult
getInventorySummaries操作的有效载荷模式.
Name | Description | Schema |
---|---|---|
granularity required | 描述了可以汇总库存数据的粒度.例如,如果你使用Marketplace粒度,可履行数量将反映在给定市场中可以履行的库存. | Granularity |
inventorySummaries required | A list of inventory summaries. | InventorySummaries |
# GetInventorySummariesResponse
响应模式.
Name | Description | Schema |
---|---|---|
payload optional | The payload for the getInventorySummaries operation. | GetInventorySummariesResult |
分页 可选 | 将请求的结果分批返回的过程,定义的大小称为分页.这样做是为了对结果大小和整体吞吐量进行一些控制.这是一种流量管理的形式. | 分页 |
errors optional | 在 getInventorySummaries 操作中,发生了一个或多个意外的错误. | ErrorList |
# Error
当请求不成功时返回的错误响应.
Name | Description | Schema |
---|---|---|
code required | 一个错误代码,用于识别所发生的错误类型. | string |
message 可选的 | 以人类可读的形式描述错误情况的信息. | string |
details optional | 可以帮助呼叫者理解或解决这个问题的额外信息. | string |
# ErrorList
当一个请求不成功时返回的错误响应列表.
类型 < Error > 数组
# GranularityType
库存汇总级别的颗粒度类型.
类型 : 枚举
Value | Description |
---|---|
Marketplace | Marketplace |
# Name
研究的持续时间.
类型 : 枚举
Value | Description |
---|---|
researchingQuantityInShortTerm | ShortTerm为1-10天. |
研究中期数量 | 中期为11-20天. |
研究长期数量 | 长期为21天或更长时间. |