这是用户在 2024-12-18 24:02 为 https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference 保存的双语快照页面,由 沉浸式翻译 提供双语支持。了解如何保存?

Fulfillment Inbound API v2024-03-20 Reference
满足入站 API v2024-03-20 参考文档

Create and update inbound inventory to Amazon's fulfillment network.
创建和更新进入亚马逊履行网络的库存。

Overview 概述

The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon's fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
亚马逊 FBA 入库销售伙伴 API。FBA 入库 API 允许构建入库工作流程,以创建、管理和发送货物进入亚马逊的履行网络。该 API 与“发送至亚马逊”用户界面具有互操作性。

Version information 版本信息

Version : 2024-03-20 版本:2024-03-20

Contact information 联系方式

Contact : Selling Partner API Developer Support
联系:销售合作伙伴 API 开发者支持

Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
联系网址:https://sellercentral.amazon.com/gp/mws/contactus.html

License information 授权信息

License : Apache License 2.0
许可证:Apache 许可证 2.0

License URL : http://www.apache.org/licenses/LICENSE-2.0
许可证 URL:http://www.apache.org/licenses/LICENSE2.0

URI scheme URI 方案

Host : sellingpartnerapi-na.amazon.com
主机:sellingpartnerapi-na.amazon.com

Schemes : HTTPS 方案:HTTPS

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Operations 运营

listInboundPlans 列出入站计划
createInboundPlan 创建进货计划
getInboundPlan 获取入境计划
listInboundPlanBoxes 列表入站计划箱
cancelInboundPlan 取消入站计划
listInboundPlanItems 列出入站计划项
updateInboundPlanName 更新入站计划名称
listPackingGroupBoxes 列表包装分组框
listPackingGroupItems 列出包装组项目
setPackingInformation 设置包装信息
listPackingOptions 列表包装选项
generatePackingOptions 生成包装选项
confirmPackingOption 确认包装选项
listInboundPlanPallets 列出入库计划托盘
listPlacementOptions 列表放置选项
generatePlacementOptions
生成放置选项

confirmPlacementOption 确认放置选项
getShipment 获取货运
listShipmentBoxes 清单运输箱
listShipmentContentUpdatePreviews
列出货运内容更新预览

generateShipmentContentUpdatePreviews
生成发货内容更新预览

getShipmentContentUpdatePreview
获取运输内容更新预览

confirmShipmentContentUpdatePreview
确认发货内容更新预览

getDeliveryChallanDocument
获取送货单据

listDeliveryWindowOptions
列出配送时间选项

generateDeliveryWindowOptions
生成配送时间选项

confirmDeliveryWindowOptions
确认配送时间选项

listShipmentItems 列出货运项目
updateShipmentName 更新运输名称
listShipmentPallets 列出装货托盘
cancelSelfShipAppointment
取消自寄预约

getSelfShipAppointmentSlots
获取自提预约时段

generateSelfShipAppointmentSlots
生成自寄预约时段

scheduleSelfShipAppointment
安排自寄预约

updateShipmentSourceAddress
更新发货源地址

updateShipmentTrackingDetails
更新物流跟踪详情

listTransportationOptions
列出运输选项

generateTransportationOptions
生成运输选项

confirmTransportationOptions
确认运输选项

listItemComplianceDetails
商品合规详情

updateItemComplianceDetails
更新商品合规详情

createMarketplaceItemLabels
创建市场商品标签

listPrepDetails 列表准备详情
setPrepDetails 设置准备详情
getInboundOperationStatus
获取入站操作状态


Paths 路径

GET /inbound/fba/2024-03-20/inboundPlans
获取 /inbound/fba/2024-03-20/inboundPlans

Operation: listInboundPlans
操作:列出入站计划

Description 描述

Provides a list of inbound plans with minimal information.
提供一份包含最少信息的入境计划列表。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Query 查询pageSize 页面大小
optional 可选
The number of inbound plans to return in the response matching the given query.
响应中匹配给定查询的返回计划数量。

Minimum : 1 最少:1
Maximum : 30 最大:30
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-
Query 查询status 状态
optional 可选
The status of an inbound plan.
入境计划的状况。
enum (Status) 枚举(状态)-
Query 查询sortBy 排序
optional 可选
Sort by field. 按字段排序。enum (SortBy) 枚举(按排序方式)-
Query 查询sortOrder 排序顺序
optional 可选
The sort order. 排序方式。enum (SortOrder) 枚举(排序顺序)-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListInboundPlans 200 response
列出入站计划 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListInboundPlansResponse
列表入站计划响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans

Operation: createInboundPlan
操作:创建进货计划

Description 描述

Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.
创建一个入库计划。入库计划包含发送货物到亚马逊履行网络所需的所有必要信息。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Body 身体body 身体
required 必需的
The body of the request to createInboundPlan.
请求正文至 createInboundPlan
CreateInboundPlanRequest
创建入站计划请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202CreateInboundPlan 202 response
创建入站计划 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
CreateInboundPlanResponse
创建入站计划响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "destinationMarketplaces" : [ "ATVPDKIKX0DER" ], "items" : [ { "expiration" : "2024-01-01", "labelOwner" : "AMAZON", "manufacturingLotCode" : "manufacturingLotCode", "msku" : "Sunglasses", "prepOwner" : "AMAZON", "quantity" : 10 } ], "name" : "My inbound plan", "sourceAddress" : { "addressLine1" : "123 example street", "addressLine2" : "Floor 19", "city" : "Toronto", "companyName" : "Acme", "countryCode" : "CA", "email" : "email@email.com", "name" : "name", "phoneNumber" : "1234567890", "postalCode" : "M1M1M1", "stateOrProvinceCode" : "ON" } }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}

Operation: getInboundPlan
操作:getInboundPlan

Description 描述

Fetches the top level information about an inbound plan.
获取关于入境计划的顶级信息。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200GetInboundPlan 200 response
获取入站计划 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
InboundPlan 进口计划

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

Example HTTP response 示例 HTTP 响应

Response 200 响应 200
{ "createdAt" : "2024-03-20T12:01:00Z", "inboundPlanId" : "wf1234abcd-1234-abcd-5678-1234abcd5678", "lastUpdatedAt" : "2024-03-28T13:15:30Z", "marketplaceIds" : [ "A2EUQ1WTGCTBG2" ], "name" : "FBA (03/20/2024, 12:01 PM)", "packingOptions" : [ ], "placementOptions" : [ ], "shipments" : [ ], "sourceAddress" : { "addressLine1" : "123 example street", "addressLine2" : "Floor 19", "city" : "Toronto", "companyName" : "Acme", "countryCode" : "CA", "email" : "email@email.com", "name" : "name", "phoneNumber" : "1234567890", "postalCode" : "M1M1M1", "stateOrProvinceCode" : "ON" }, "status" : "ACTIVE" }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes

Operation: listInboundPlanBoxes
操作:列出入库计划箱

Description 描述

Provides a paginated list of box packages in an inbound plan.
提供进货计划中箱包装的分页列表。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of boxes to return in the response matching the given query.
响应中返回的与给定查询匹配的箱数。

Minimum : 1 最少:1
Maximum : 1000 最大:1000
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListInboundPlanBoxes 200 response
列出入站计划箱 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListInboundPlanBoxesResponse
列表入站计划箱响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/cancellation
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/cancellation PUT /入站/fba/2024-03-20/入站计划/{inboundPlanId}/取消

Operation: cancelInboundPlan
操作:取消进货计划

Description 描述

Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
取消入站计划。如果取消操作在空档期之外进行,可能会产生费用。亚马逊合作伙伴承运人的空档期为小型包裹配送(SPD)24 小时,以及整车运输承运人货物一小时内。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202CancelInboundPlan 202 response
取消入站计划 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
CancelInboundPlanResponse
取消入站计划响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items

Operation: listInboundPlanItems
操作:列出入站计划项

Description 描述

Provides a paginated list of item packages in an inbound plan.
提供进货计划中项目包装的分页列表。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of items to return in the response matching the given query.
响应中匹配给定查询的退货项目数量。

Minimum : 1 最少:1
Maximum : 1000 最大:1000
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListInboundPlanItems 200 response
列出入站计划项 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListInboundPlanItemsResponse
列表入站计划项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/name

Operation: updateInboundPlanName
操作:更新进货计划名称

Description 描述

Updates the name of an existing inbound plan.
更新现有入站计划的名称。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to updateInboundPlanName.
请求正文至 updateInboundPlanName
UpdateInboundPlanNameRequest
更新入站计划名称请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
204UpdateInboundPlanName 204 response
更新入站计划名称 204 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
No Content 无内容

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "name" : "name" }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes

Operation: listPackingGroupBoxes
操作:listPackingGroupBoxes

Description 描述

Retrieves a page of boxes from a given packing group. These boxes were previously provided through the setPackingInformation operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
从指定的包装组中检索一页的箱子。这些箱子之前通过 setPackingInformation 操作提供。此 API 用于在亚马逊确定分装前箱子已打包的工作流程。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径packingGroupId 包装组 ID
required 必需的
Identifier of a packing group.
包装组标识符。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of packing group boxes to return in the response matching the given query.
响应中返回的包装箱数量与给定查询匹配。

Minimum : 1 最少:1
Maximum : 100 最大:100
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListPackingGroupBoxes 200 response
列表包装分组框 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListPackingGroupBoxesResponse
列表包装分组框响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items

Operation: listPackingGroupItems
操作:listPackingGroupItems

Description 描述

Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
获取指定包装组的一页商品。在列出包装组商品之前,必须先通过相应操作生成包装选项。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径packingGroupId 包装组 ID
required 必需的
Identifier of a packing group.
包装组标识符。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of packing group items to return in the response matching the given query.
响应中返回的与给定查询匹配的包装组项目数量。

Minimum : 1 最少:1
Maximum : 100 最大:100
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListPackingGroupItems 200 response
列表包装组项目 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListPackingGroupItemsResponse
列表包装组项目响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingInformation

Operation: setPackingInformation
操作:设置包装信息

Description 描述

Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.
设置进货计划的包装信息。应在创建进货计划后调用,以填充规划及运输估算所需的箱级信息。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to setPackingInformation.
请求正文至 setPackingInformation
SetPackingInformationRequest
设置包装信息请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202SetPackingInformation 202 response
设置包装信息 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
SetPackingInformationResponse
设置包装信息响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "packageGroupings" : [ { "boxes" : [ { "contentInformationSource" : "BOX_CONTENT_PROVIDED", "dimensions" : { "height" : 5, "length" : 3, "unitOfMeasurement" : "CM", "width" : 4 }, "items" : [ { "expiration" : "2024-01-01", "labelOwner" : "AMAZON", "manufacturingLotCode" : "manufacturingLotCode", "msku" : "Sunglasses", "prepOwner" : "AMAZON", "quantity" : 10 } ], "quantity" : 2, "weight" : { "unit" : "KG", "value" : 5.5 } } ], "packingGroupId" : "pg1234abcd-1234-abcd-5678-1234abcd5678", "shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678" } ] }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/包装选项

Operation: listPackingOptions
操作:listPackingOptions

Description 描述

Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
获取所有入站计划的包装选项列表。包装选项必须首先由相应的操作生成,然后才能可用。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of packing options to return in the response matching the given query.
响应中返回的与给定查询匹配的包装选项数量。

Minimum : 1 最少:1
Maximum : 20 最大:20
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListPackingOptions 200 response
列出包装选项 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListPackingOptionsResponse
列表包装选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions

Operation: generatePackingOptions
操作:生成包装选项

Description 描述

Generates available packing options for the inbound plan.
生成进货计划的可用包装选项。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202GeneratePackingOptions 202 response
生成包装选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GeneratePackingOptionsResponse
生成包装选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/confirmation

Operation: confirmPackingOption
操作:确认包装选项

Description 描述

Confirms the packing option for an inbound plan.
确认进货计划的包装选项。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径packingOptionId 包装选项 ID
required 必需的
Identifier of a packing option.
包装选项的标识符。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202ConfirmPackingOption 202 response
确认包装选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ConfirmPackingOptionResponse
确认包装选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/pallets
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/pallets GET /入站/fba/2024-03-20/入站计划/{入站计划 ID}/托盘

Operation: listInboundPlanPallets
操作:列出入库计划托盘

Description 描述

Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
提供进货计划中托盘包装的分页列表。在生成不足整车运输(LTL)承运人运输的相关详情后,进货计划将包含托盘。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of pallets to return in the response matching the given query.
响应中返回的托盘数量与给定查询匹配。

Minimum : 1 最少:1
Maximum : 1000 最大:1000
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListInboundPlanPallets 200 response
列出入库计划托盘 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListInboundPlanPalletsResponse
列表进货计划托盘响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions

Operation: listPlacementOptions
操作:列出放置选项

Description 描述

Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
提供所有入站计划的放置选项列表。放置选项必须首先由相应的操作生成,然后才能可用。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of placement options to return in the response matching the given query.
响应中返回与给定查询匹配的放置选项数量。

Minimum : 1 最少:1
Maximum : 20 最大:20
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListPlacementOptions 200 response
列表放置选项 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListPlacementOptionsResponse
列表放置选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions

Operation: generatePlacementOptions
操作:生成放置选项

Description 描述

Generates placement options for the inbound plan.
生成进件计划的摆放选项。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to generatePlacementOptions.
请求正文至 generatePlacementOptions
GeneratePlacementOptionsRequest
生成放置选项请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202GeneratePlacementOptions 202 response
生成放置选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GeneratePlacementOptionsResponse
生成放置选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "customPlacement" : [ { "items" : [ { "expiration" : "2024-01-01", "labelOwner" : "AMAZON", "manufacturingLotCode" : "manufacturingLotCode", "msku" : "Sunglasses", "prepOwner" : "AMAZON", "quantity" : 10 } ], "warehouseId" : "YYZ14" } ] }

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions/{placementOptionId}/confirmation

Operation: confirmPlacementOption
操作:确认放置选项

Description 描述

Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
确认入站计划的放置选项。一旦确认,入站计划将无法更改。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径placementOptionId 放置选项 ID
required 必需的
The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
放置选项的标识符。放置选项代表 SKU 的发货拆分和目的地。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202ConfirmPlacementOption 202 response
确认放置选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ConfirmPlacementOptionResponse
确认放置选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}

Operation: getShipment 操作:获取运输

Description 描述

Provides the full details for a specific shipment within an inbound plan. The transportationOptionId inside acceptedTransportationSelection can be used to retrieve the transportation details for the shipment.
提供入站计划中特定货物的全部详细信息。在 acceptedTransportationSelection 中的 transportationOptionId 可以用来检索该货物的运输详情。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200GetShipment 200 response
获取运输 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
Shipment 发货

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

Example HTTP response 示例 HTTP 响应

Response 200 响应 200
{ "destination" : { "destinationType" : "AMAZON_OPTIMIZED" }, "freightInformation" : { "declaredValue" : { "amount" : 5.5, "code" : "CAD" }, "freightClass" : "FC_50" }, "inboundPlanId" : "wf1234abcd-1234-abcd-5678-1234abcd5678", "placementOptionId" : "pl1234abcd-1234-abcd-5678-1234abcd5678", "selectedDeliveryWindow" : { "availabilityType" : "AVAILABLE", "deliveryWindowOptionId" : "dw1234abcd-1234-abcd-5678-1234abcd5678", "editableUntil" : "2024-01-05T20:00:00.000Z", "endDate" : "2024-01-05T20:00:00.000Z", "startDate" : "2024-01-05T14:00:00.000Z" }, "shipmentConfirmationId" : "shipmentConfirmationId", "shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678", "source" : { "sourceType" : "SELLER_FACILITY" } }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes

Operation: listShipmentBoxes
操作:列出货运箱

Description 描述

Provides a paginated list of box packages in a shipment.
提供装运中纸箱包装的分页列表。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of boxes to return in the response matching the given query.
响应中返回的与给定查询匹配的箱数。

Minimum : 1 最少:1
Maximum : 1000 最大:1000
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListShipmentBoxes 200 response
清单发货箱 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListShipmentBoxesResponse
清单发货箱响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/内容更新预览

Operation: listShipmentContentUpdatePreviews
操作:listShipmentContentUpdatePreviews

Description 描述

Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
获取指定运单的 shipment content update 预览的分页列表。shipment content update 预览是请求的运单内容变更的摘要,以及变更带来的运输成本影响,这些影响只能在指定的截止日期之前确认。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of content update previews to return.
返回的内容更新预览数量。

Minimum : 1 最少:1
Maximum : 20 最大:20
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListShipmentContentUpdatePreviews 200 response
清单发货内容更新预览 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListShipmentContentUpdatePreviewsResponse
列表发货内容更新预览响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews Translated Text: POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/内容更新预览

Operation: generateShipmentContentUpdatePreviews
操作:生成发货内容更新预览

Description 描述

Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
生成一个基于已确认承运商的预定包裹和/或物品的运输内容更新预览。运输内容更新预览将在确认前显示更新后的成本和内容。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to generateShipmentContentUpdatePreviews.
请求正文至 generateShipmentContentUpdatePreviews
GenerateShipmentContentUpdatePreviewsRequest
生成发货内容更新预览请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202GenerateShipmentContentUpdatePreviews 202 response
生成发货内容更新预览 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GenerateShipmentContentUpdatePreviewsResponse
生成发货内容更新预览响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "boxes" : [ { "contentInformationSource" : "BOX_CONTENT_PROVIDED", "dimensions" : { "height" : 5, "length" : 3, "unitOfMeasurement" : "CM", "width" : 4 }, "items" : [ { "expiration" : "2024-01-01", "labelOwner" : "AMAZON", "manufacturingLotCode" : "manufacturingLotCode", "msku" : "Sunglasses", "prepOwner" : "AMAZON", "quantity" : 10 } ], "packageId" : "pk1234abcd-1234-abcd-5678-1234abcd5678", "quantity" : 2, "weight" : { "unit" : "KG", "value" : 5.5 } } ], "items" : [ { "expiration" : "2024-01-01", "labelOwner" : "AMAZON", "manufacturingLotCode" : "manufacturingLotCode", "msku" : "Sunglasses", "prepOwner" : "AMAZON", "quantity" : 10 } ] }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}

Operation: getShipmentContentUpdatePreview
操作:getShipmentContentUpdatePreview

Description 描述

Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
获取一个装运内容更新预览,该预览提供了所请求的装运内容变更的摘要,以及变更的交通成本影响,这些影响只能在指定的到期日之前确认。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径contentUpdatePreviewId 内容更新预览 ID
required 必需的
Identifier of a content update preview.
内容更新预览的标识符。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200GetShipmentContentUpdatePreview 200 response
获取货运内容更新预览 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ContentUpdatePreview 内容更新预览

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}/confirmation

Operation: confirmShipmentContentUpdatePreview
操作:确认发货内容更新预览

Description 描述

Confirm a shipment content update preview and accept the changes in transportation cost.
确认发货内容更新预览并接受运输成本的变更。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径contentUpdatePreviewId 内容更新预览 ID
required 必需的
Identifier of a content update preview.
内容更新预览的标识符。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202ConfirmShipmentContentUpdatePreview 202 response
确认发货内容更新预览 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ConfirmShipmentContentUpdatePreviewResponse
确认发货内容更新预览响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryChallanDocument
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/交付单据

Operation: getDeliveryChallanDocument
操作:获取送货单据

Description 描述

Provide delivery challan document for PCP transportation in IN marketplace.
提供 IN 市场 PCP 运输的提货单据。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200GetDeliveryChallanDocument 200 response
获取送货单据 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GetDeliveryChallanDocumentResponse
获取送货单据响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions

Operation: listDeliveryWindowOptions
操作:列出配送时间选项

Description 描述

Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before becoming available.
获取所有配送时间窗口选项。配送时间窗口选项必须首先通过 generateDeliveryWindowOptions 操作生成,然后才能可用。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径shipmentId 发货 ID
required 必需的
The shipment to get delivery window options for.
获取配送时间选项的发货。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of delivery window options to return in the response matching the given query.
响应中匹配给定查询的退货时间窗口选项数量。

Minimum : 1 最少:1
Maximum : 100 最大:100
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListDeliveryWindowOptions 200 response
列出配送时间选项 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListDeliveryWindowOptionsResponse
列表配送时间选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions

Operation: generateDeliveryWindowOptions
操作:生成配送时间选项

Description 描述

Generates available delivery window options for a given shipment.
生成给定货物的可用配送时间窗口选项。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
The shipment to generate delivery window options for.
为生成配送时间窗口选项的发货。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202GenerateDeliveryWindowOptions 202 response
生成配送时间选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GenerateDeliveryWindowOptionsResponse
生成配送时间选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions/{deliveryWindowOptionId}/confirmation

Operation: confirmDeliveryWindowOptions
操作:确认配送时间选项

Description 描述

Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program CONFIRMED_DELIVERY_WINDOW require a delivery window to be confirmed prior to transportation option confirmation.
确认所选入站计划中运输方式的配送时间窗口选项。在使用此 API 之前必须确认放置选项。一旦确认,新的配送时间窗口选项将无法生成,但可以在运输关闭前更新所选的配送时间窗口选项。该窗口用于提供预计的货物到达仓库的时间。所有具有程序 CONFIRMED_DELIVERY_WINDOW 的运输方式在确认运输选项之前必须确认配送时间窗口。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
The shipment to confirm the delivery window option for.
确认送货时间选项的发货。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径deliveryWindowOptionId 配送窗口选项 ID
required 必需的
The id of the delivery window option to be confirmed.
交付时间选项的 ID 待确认。

minLength : 36 最小长度:36
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202ConfirmDeliveryWindowOptions 202 response
确认配送时间选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ConfirmDeliveryWindowOptionsResponse
确认配送时间选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

Example HTTP response 示例 HTTP 响应

Response 202 响应 202
{ "operationId" : "1234abcd-1234-abcd-5678-1234abcd5678" }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items

Operation: listShipmentItems
操作:列出货运项目

Description 描述

Provides a paginated list of item packages in a shipment.
提供一份分页显示的货物包装清单。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of items to return in the response matching the given query.
响应中匹配给定查询的退货项目数量。

Minimum : 1 最少:1
Maximum : 1000 最大:1000
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListShipmentItems 200 response
清单发货项 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListShipmentItemsResponse
清单发货项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/name

Operation: updateShipmentName
操作:更新运货名称

Description 描述

Updates the name of an existing shipment.
更新现有运货单的名称。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to updateShipmentName.
请求正文至 updateShipmentName
UpdateShipmentNameRequest
更新发货名称请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
204UpdateShipmentName 204 response
更新运货名称 204 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
No Content 无内容

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "name" : "name" }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/托盘

Operation: listShipmentPallets
操作:列出装货托盘

Description 描述

Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
提供分页显示的托盘包装清单。在生成不足整车(LTL)承运人运输后,提供相关详情时,托盘化运输将包含托盘。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of pallets to return in the response matching the given query.
响应中返回的托盘数量与给定查询匹配。

Minimum : 1 最少:1
Maximum : 1000 最大:1000
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListShipmentPallets 200 response
列出装货托盘 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListShipmentPalletsResponse
清单装运托盘响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation PUT /入站/fba/2024-03-20/入站计划/{inboundPlanId}/运输/{shipmentId}/自行运输预约取消

Operation: cancelSelfShipAppointment
操作:取消自寄预约

Description 描述

Cancels a self-ship appointment slot against a shipment.
取消与发货相关的自寄送预约时段。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to cancelSelfShipAppointment.
请求正文至 cancelSelfShipAppointment
CancelSelfShipAppointmentRequest
取消自寄送预约请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202CancelSelfShipAppointment 202 response
取消自寄预约 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
CancelSelfShipAppointmentResponse
取消自寄预约响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "reasonComment" : "OTHER" }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots

Operation: getSelfShipAppointmentSlots
操作:getSelfShipAppointmentSlots

Description 描述

Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
获取可用于在仓库交付货物的自寄送预约时段列表。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of self ship appointment slots to return in the response matching the given query.
响应中匹配给定查询的自寄回预约时段数量。

Minimum : 1 最少:1
Maximum : 100 最大:100
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200GetSelfShipAppointmentSlots 200 response
获取自寄预约时段 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GetSelfShipAppointmentSlotsResponse
获取自寄预约时段响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots

Operation: generateSelfShipAppointmentSlots
操作:generateSelfShipAppointmentSlots

Description 描述

Initiates the process of generating the appointment slots list.
启动生成预约时段列表的过程。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to generateSelfShipAppointmentSlots.
请求正文至 generateSelfShipAppointmentSlots
GenerateSelfShipAppointmentSlotsRequest
生成自寄送预约时段请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
201GenerateSelfShipAppointmentSlots 201 response
生成自寄送预约时段 201 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GenerateSelfShipAppointmentSlotsResponse
生成自寄送预约时段响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "desiredEndDate" : "2024-01-06T14:48:00.000Z", "desiredStartDate" : "2024-01-05T14:48:00.000Z" }

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule

Operation: scheduleSelfShipAppointment
操作:scheduleSelfShipAppointment 翻译文本:安排自寄送预约

Description 描述

Confirms or reschedules a self-ship appointment slot against a shipment.
确认或重新安排与运输的预约时段。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径slotId 槽位 ID
required 必需的
An identifier to a self-ship appointment slot.
一个指向自选预约时段的标识符。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to scheduleSelfShipAppointment.
请求正文至 scheduleSelfShipAppointment
ScheduleSelfShipAppointmentRequest
安排自寄预约请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ScheduleSelfShipAppointment 200 response
安排自寄预约 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ScheduleSelfShipAppointmentResponse
自定发货预约响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "reasonComment" : "OTHER" }

Example HTTP response 示例 HTTP 响应

Response 200 响应 200
{ "selfShipAppointmentDetails" : { "appointmentId" : 1000, "appointmentSlotTime" : { "endTime" : "2023-03-09T13:15:30Z", "startTime" : "2023-03-08T13:15:30Z" }, "appointmentStatus" : "ARRIVAL_SCHEDULED" } }

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress PUT /入站/fba/2024-03-20/入站计划/{inboundPlanId}/运输/{shipmentId}/源地址

Operation: updateShipmentSourceAddress
操作:更新发货源地址

Description 描述

Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
更新现有货物的源地址。货物的源地址只能在确认承运人之前进行更新。由于更新了源地址,现有的运输选项将失效,需要重新生成以捕捉由于新的源地址而产生的潜在运输选项和报价差异。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to updateShipmentSourceAddress.
请求正文至 updateShipmentSourceAddress
UpdateShipmentSourceAddressRequest
更新发货源地址请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202UpdateShipmentSourceAddress 202 response
更新发货源地址 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
UpdateShipmentSourceAddressResponse
更新发货源地址响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "address" : { "addressLine1" : "123 example street", "addressLine2" : "Floor 19", "city" : "Toronto", "companyName" : "Acme", "countryCode" : "CA", "email" : "email@email.com", "name" : "name", "phoneNumber" : "1234567890", "postalCode" : "M1M1M1", "stateOrProvinceCode" : "ON" } }

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails

Operation: updateShipmentTrackingDetails
操作:更新运输跟踪详情

Description 描述

Updates a shipment's tracking details.
更新货物的跟踪详情。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Path 路径shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to updateShipmentTrackingDetails.
请求正文至 updateShipmentTrackingDetails
UpdateShipmentTrackingDetailsRequest
更新物流跟踪详情请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202UpdateShipmentTrackingDetails 202 response
更新物流跟踪详情 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
UpdateShipmentTrackingDetailsResponse
更新物流跟踪详情响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "trackingDetails" : { "spdTrackingDetail" : { "spdTrackingItems" : [ { "boxId" : "FBA10ABC0YY100001", "trackingId" : "FBA10002000" } ] } } }

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions Translated Text: GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/运输选项

Operation: listTransportationOptions
操作:列出运输选项

Description 描述

Retrieves all transportation options for a shipment. Transportation options must first be generated by the generateTransportationOptions operation before becoming available.
获取所有运输方式。运输方式必须先通过 generateTransportationOptions 操作生成,才能变得可用。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构Default 默认
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询pageSize 页面大小
optional 可选
The number of transportation options to return in the response matching the given query.
响应中匹配给定查询的退货运输方式数量。

Minimum : 1 最少:1
Maximum : 20 最大:20
integer 整数10
Query 查询paginationToken 分页令牌
optional 可选
A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
一个用于获取特定页面的令牌,当有多个页面结果时。此令牌的值从 API 响应中返回的 pagination 中获取。如果查询参数中没有令牌值,API 将返回结果的第一页。

minLength : 0 最小长度:0
maxLength : 1024 最大长度:1024
string 字符串-
Query 查询placementOptionId 放置选项 ID
optional 可选
The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
获取运输选项的放置选项。必须指定 placementOptionId

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-
Query 查询shipmentId 发货 ID
optional 可选
The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
为运输方式选择运输方式。必须指定 placementOptionId

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串-

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListTransportationOptions 200 response
列出运输选项 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListTransportationOptionsResponse
列表运输选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions

Operation: generateTransportationOptions
操作:生成运输选项

Description 描述

Generates available transportation options for a given placement option.
生成给定位置选项的可用交通方式。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to generateTransportationOptions.
请求正文至 generateTransportationOptions
GenerateTransportationOptionsRequest
生成运输选项请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202GenerateTransportationOptions 202 response
生成运输选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
GenerateTransportationOptionsResponse
生成运输选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "placementOptionId" : "pl1234abcd-1234-abcd-5678-1234abcd5678", "shipmentTransportationConfigurations" : [ { "contactInformation" : { "email" : "email@email.com", "name" : "John Smithy", "phoneNumber" : "1234567890" }, "freightInformation" : { "declaredValue" : { "amount" : 5.5, "code" : "CAD" }, "freightClass" : "FC_50" }, "pallets" : [ { "dimensions" : { "height" : 5, "length" : 3, "unitOfMeasurement" : "CM", "width" : 4 }, "quantity" : 2, "stackability" : "STACKABLE", "weight" : { "unit" : "KG", "value" : 5.5 } } ], "readyToShipWindow" : { "start" : "2024-01-01T00:00Z" }, "shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678" } ] }

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions/confirmation
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions/confirmation 翻译文本:POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions/确认

Operation: confirmTransportationOptions
操作:确认运输选项

Description 描述

Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan.
确认所有入站计划的运输选项。在使用此 API 之前必须确认一个放置选项。一旦确认,将无法为入站计划生成或确认新的运输选项。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38 最大长度:38
string 字符串
Body 身体body 身体
required 必需的
The body of the request to confirmTransportationOptions.
请求正文至 confirmTransportationOptions
ConfirmTransportationOptionsRequest
确认运输选项请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202ConfirmTransportationOptions 202 response
确认运输选项 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ConfirmTransportationOptionsResponse
确认运输选项响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "transportationSelections" : [ { "contactInformation" : { "email" : "email@email.com", "name" : "John Smithy", "phoneNumber" : "1234567890" }, "deliveryWindow" : { "start" : "2024-01-01T00:00Z" }, "shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678", "transportationOptionId" : "to1234abcd-1234-abcd-5678-1234abcd5678" } ] }

GET /inbound/fba/2024-03-20/items/compliance
获取 /inbound/fba/2024-03-20/items/compliance

Operation: listItemComplianceDetails
操作:listItemComplianceDetails

Description 描述

List the inbound compliance details for MSKUs in a given marketplace.
列出给定市场中 MSKUs 的入境合规详情。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Query 查询mskus mskus mskus
required 必需的
A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
商家 SKU 列表,特定 SKU 的商家提供的标识符。


Min count : 1 最少数量:1
Max count : 100 最大数量:100
< string > array(multi) < string > 数组(多)
Query 查询marketplaceId 市场 ID
required 必需的
The Marketplace ID. For a list of possible values, refer to Marketplace IDs.
市场 ID。有关可能的值列表,请参阅市场 ID。

minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListItemComplianceDetails 200 response
项目合规详情 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListItemComplianceDetailsResponse
项目合规详情响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

PUT /inbound/fba/2024-03-20/items/compliance
PUT /inbound/fba/2024-03-20/items/compliance PUT /入站/FBA/2024-03-20/项目/合规

Operation: updateItemComplianceDetails
操作:更新商品合规详情

Description 描述

Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
更新 MSKU 列表的合规详情。此处提供的详情仅用于印度(IN - A21TJRUUN4KGV)市场合规验证。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Query 查询marketplaceId 市场 ID
required 必需的
The Marketplace ID. For a list of possible values, refer to Marketplace IDs.
市场 ID。有关可能的值列表,请参阅市场 ID。

minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串
Body 身体body 身体
required 必需的
The body of the request to updateItemComplianceDetails.
请求正文至 updateItemComplianceDetails
UpdateItemComplianceDetailsRequest
更新商品合规详情请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202UpdateItemComplianceDetails 202 response
更新商品合规详情 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
UpdateItemComplianceDetailsResponse
更新商品合规详情响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "msku" : "Sunglasses", "taxDetails" : { "declaredValue" : { "amount" : 5.5, "code" : "CAD" }, "hsnCode" : "hsnCode" } }

POST /inbound/fba/2024-03-20/items/labels

Operation: createMarketplaceItemLabels
操作:创建市场商品标签

Description 描述

For a given marketplace - creates labels for a list of MSKUs.
为特定市场 - 为一系列 MSKU 创建标签。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Body 身体body 身体
required 必需的
The body of the request to createMarketplaceItemLabels.
请求正文至 createMarketplaceItemLabels
CreateMarketplaceItemLabelsRequest
创建市场商品标签请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200CreateMarketplaceItemLabels 200 response
创建市场商品标签 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
CreateMarketplaceItemLabelsResponse
创建市场商品标签响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "height" : 25, "labelType" : "STANDARD_FORMAT", "localeCode" : "en_US", "marketplaceId" : "A2EUQ1WTGCTBG2", "mskuQuantities" : [ { "msku" : "msku", "quantity" : 5 } ], "pageType" : "A4_21", "width" : 100 }

GET /inbound/fba/2024-03-20/items/prepDetails
获取 /inbound/fba/2024-03-20/items/prepDetails

Operation: listPrepDetails
操作:listPrepDetails

Description 描述

Get preparation details for a list of MSKUs in a specified marketplace.
获取指定市场内一系列 MSKU 的准备详情。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Query 查询marketplaceId 市场 ID
required 必需的
The marketplace ID. For a list of possible values, refer to Marketplace IDs.
市场 ID。有关可能的值列表,请参阅市场 ID。

minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串
Query 查询mskus mskus mskus
required 必需的
A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
商家 SKU 列表,特定 SKU 的商家提供的标识符。


Min count : 1 最少数量:1
Max count : 100 最大数量:100
< string > array(multi) < string > 数组(多)

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200ListPrepDetails 200 response
列表准备详情 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ListPrepDetailsResponse 列表准备详情响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

POST /inbound/fba/2024-03-20/items/prepDetails
POST /inbound/fba/2024-03-20/items/prepDetails 翻译文本:POST /inbound/fba/2024-03-20/items/prepDetails

Operation: setPrepDetails
操作:设置准备详情

Description 描述

Set the preparation details for a list of MSKUs in a specified marketplace.
设置指定市场中一系列 MSKU 的准备工作详情。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Body 身体body 身体
required 必需的
The body of the request to setPrepDetails.
请求正文至 setPrepDetails
SetPrepDetailsRequest 设置预准备详情请求

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
202SetPrepDetails 202 response
设置预览详情 202 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
SetPrepDetailsResponse 设置预准备详情响应

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Consumes 消耗

  • application/json

Produces 生产

  • application/json

Example HTTP request 示例 HTTP 请求

Request body 请求体
{ "marketplaceId" : "A2EUQ1WTGCTBG2", "mskuPrepDetails" : [ { "msku" : "msku", "prepCategory" : "NONE", "prepTypes" : [ "ITEM_NO_PREP" ] } ] }

GET /inbound/fba/2024-03-20/operations/{operationId}
获取 /inbound/fba/2024-03-20/operations/{operationId}

Operation: getInboundOperationStatus
操作:getInboundOperationStatus

Description 描述

Gets the status of the processing of an asynchronous API call.
获取异步 API 调用处理的状况。

Usage Plan: 使用计划:

Rate (requests per second)
评分(每秒请求次数)
Burst 爆裂
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
返回的 x-amzn-RateLimit-Limit 响应头提供了对请求操作应用的使用计划速率限制(如有)。前表包含此操作的默认速率和突发值。对于业务需求需要更高吞吐量的销售合作伙伴,其速率和突发值可能高于此处所示。有关更多信息,请参阅销售合作伙伴 API 中的使用计划和速率限制。

Parameters 参数

Type 类型Name 名称Description 描述Schema 架构
Path 路径operationId 操作 ID
required 必需的
Identifier of an asynchronous operation.
异步操作的标识符

minLength : 36 最小长度:36
maxLength : 38 最大长度:38
string 字符串

Responses 回复

HTTP Code HTTP 状态码Description 描述Schema 架构
200GetInboundOperationStatus 200 response
获取入站操作状态 200 响应

Headers :  标题:
x-amzn-RequestId (string) : Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
InboundOperationStatus 入站操作状态

For error status codes, descriptions and schemas, see Error responses and schemas.
错误状态码、描述和架构信息,请参阅“错误响应和架构”。

Produces 生产

  • application/json

Error Responses and Schemas
错误响应和模式

This table contains HTTP status codes and associated information for error responses.
这个表格包含了错误响应的 HTTP 状态码及其相关信息。

HTTP Code HTTP 状态码Description 描述Schema 架构
400Request has missing or invalid parameters and cannot be parsed.
请求缺少或无效的参数,无法解析。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ErrorList 错误列表
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
指示访问资源被禁止。可能的原因包括访问被拒绝、未经授权、令牌过期或签名无效。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。
ErrorList 错误列表
404The resource specified does not exist.
指定的资源不存在。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。

x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
您的操作速率限制(每秒请求次数)。
ErrorList 错误列表
413The request size exceeded the maximum accepted size.
请求大小超过了最大接受大小。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。
ErrorList 错误列表
415The request payload is in an unsupported format.
请求负载格式不受支持。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。
ErrorList 错误列表
429The frequency of requests was greater than allowed.
请求频率超过了允许的范围。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。
ErrorList 错误列表
500An unexpected condition occurred that prevented the server from fulfilling the request.
发生了一个意外情况,导致服务器无法完成请求。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。
ErrorList 错误列表
503Temporary overloading or maintenance of the server.
临时服务器过载或维护。

Headers:  Headers: 标题:
x-amzn-RequestId (string):Unique request reference identifier.
唯一请求参考标识符。
ErrorList 错误列表

Definitions 定义

Address 地址

Specific details to identify a place.
具体细节以识别地点。

Name 名称Description 描述Schema 架构
addressLine1 地址行 1
required 必需的
Street address information.
街道地址信息。

minLength : 1 最小长度:1
maxLength : 180 最大长度:180
string 字符串
addressLine2 地址行 2
optional 可选
Additional street address information.
额外街道地址信息。

minLength : 1 最小长度:1
maxLength : 60 最大长度:60
string 字符串
city 城市
required 必需的
The city. 城市。
minLength : 1 最小长度:1
maxLength : 30 最大长度:30
string 字符串
companyName 公司名称
optional 可选
The name of the business.
企业名称

minLength : 1 最小长度:1
maxLength : 50 最大长度:50
string 字符串
countryCode 国家代码
required 必需的
The country code in two-character ISO 3166-1 alpha-2 format.
国家代码,采用两位字符的 ISO 3166-1 alpha-2 格式。

minLength : 2 最小长度:2
maxLength : 2  最大长度:2
Pattern : "^[A-Z]{2}$"
模式: "^[A-Z]{2}$"
string 字符串
email 邮箱
optional 可选
The email address. 邮箱地址。
minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
name 名字
required 必需的
The name of the individual who is the primary contact.
该主要联系人的姓名。

minLength : 1 最小长度:1
maxLength : 50 最大长度:50
string 字符串
phoneNumber 电话号码
optional 可选
The phone number. 电话号码。
minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串
postalCode 邮政编码
required 必需的
The postal code. 邮政编码。
minLength : 1 最小长度:1
maxLength : 32 最大长度:32
string 字符串
stateOrProvinceCode 省份代码
optional 可选
The state or province code.
省份或州代码。

minLength : 1 最小长度:1
maxLength : 64 最大长度:64
string 字符串

AddressInput 地址输入

Specific details to identify a place.
具体细节以识别地点。

Name 名称Description 描述Schema 架构
addressLine1 地址行 1
required 必需的
Street address information.
街道地址信息。

minLength : 1 最小长度:1
maxLength : 180 最大长度:180
string 字符串
addressLine2 地址行 2
optional 可选
Additional street address information.
额外街道地址信息。

minLength : 1 最小长度:1
maxLength : 60 最大长度:60
string 字符串
city 城市
required 必需的
The city. 城市。
minLength : 1 最小长度:1
maxLength : 30 最大长度:30
string 字符串
companyName 公司名称
optional 可选
The name of the business.
企业名称

minLength : 1 最小长度:1
maxLength : 50 最大长度:50
string 字符串
countryCode 国家代码
required 必需的
The country code in two-character ISO 3166-1 alpha-2 format.
国家代码,采用两位字符的 ISO 3166-1 alpha-2 格式。

minLength : 2 最小长度:2
maxLength : 2  最大长度:2
Pattern : "^[A-Z]{2}$"
模式: "^[A-Z]{2}$"
string 字符串
email 邮箱
optional 可选
The email address. 邮箱地址。
minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
name 名字
required 必需的
The name of the individual who is the primary contact.
该主要联系人的姓名。

minLength : 1 最小长度:1
maxLength : 50 最大长度:50
string 字符串
phoneNumber 电话号码
required 必需的
The phone number. 电话号码。
minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串
postalCode 邮政编码
required 必需的
The postal code. 邮政编码。
minLength : 1 最小长度:1
maxLength : 32 最大长度:32
string 字符串
stateOrProvinceCode 省份代码
optional 可选
The state or province code.
省份或州代码。

minLength : 1 最小长度:1
maxLength : 64 最大长度:64
string 字符串

AllOwnersConstraint 所有者约束

A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints.
所有所有者都适用的约束。如果没有指定约束,则遵循任何个别所有者的约束。

Type : enum 类型:枚举

Value 价值Description 描述
MUST_MATCHAll owners must match. 所有所有者必须匹配。

AppointmentSlot 预约时段

The fulfillment center appointment slot for the transportation option.
运输选项的配送中心预约时段

Name 名称Description 描述Schema 架构
slotId 槽位 ID
required 必需的
An identifier to a self-ship appointment slot.
一个指向自选预约时段的标识符。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
slotTime 插槽时间
required 必需的
An appointment slot time with start and end.
一个带有开始和结束时间的预约时段。
AppointmentSlotTime 预约时段

AppointmentSlotTime 预约时段

An appointment slot time with start and end.
一个带有开始和结束时间的预约时段。

Name 名称Description 描述Schema 架构
endTime 结束时间
required 必需的
The end timestamp of the appointment in UTC.
预约结束时间戳(UTC 时间)。
string (date-time) 字符串(日期时间)
startTime 开始时间
required 必需的
The start timestamp of the appointment in UTC.
预约的起始时间戳(UTC 时间)。
string (date-time) 字符串(日期时间)

Box 盒子

Contains information about a box that is used in the inbound plan. The box is a container that holds multiple items.
包含有关用于进货计划的盒子的信息。该盒子是一个容纳多个物品的容器。

Name 名称Description 描述Schema 架构
boxId 盒子 ID
optional 可选
The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.
亚马逊提供的用于识别特定箱子的 ID。此 ID 由外部运输 ID(在运输确认后生成)和箱子的索引组成。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
contentInformationSource
内容信息来源

optional 可选
Indication of how box content is meant to be provided.
指示如何提供盒内内容。
BoxContentInformationSource
包装内容信息来源
destinationRegion 目标区域
optional 可选
Representation of a location used within the inbounding experience.
位置在包裹体验中的表示。
Region 区域
dimensions 尺寸
optional 可选
Measurement of a package's dimensions.
包装尺寸的测量。
Dimensions 尺寸
items 商品
optional 可选
Items contained within the box.
盒内物品。
< Item > array < 项目 > 数组
packageId 包 ID
required 必需的
Primary key to uniquely identify a Package (Box or Pallet).
主键用于唯一标识一个包装(箱或托盘)。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
quantity 数量
optional 可选
The number of containers where all other properties like weight or dimensions are identical.
所有其他属性如重量或尺寸都相同的集装箱数量。

Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数
templateName 模板名称
optional 可选
Template name of the box.
盒模板名称。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
weight 重量
optional 可选
The weight of a package.
包装重量
Weight 重量

BoxContentInformationSource
包装内容信息来源

Indication of how box content is meant to be provided.
指示如何提供盒内内容。

Type : enum 类型:枚举

Value 价值Description 描述
BOX_CONTENT_PROVIDEDBox contents have been provided by the seller.
商品内容已由卖家提供。
MANUAL_PROCESSBox contents will be manually processed during receive. This service incurs charges.
包装内容将在接收时手动处理。此服务会产生费用。
BARCODE_2DBox contents information is provided by a barcode on the shipment. For more information, refer to Using 2D barcodes for box content information on Seller Central.
包装内物信息由运输上的条形码提供。更多信息,请参阅卖家中心上的“使用二维条码获取包装内容信息”。

BoxInput 盒子输入

Input information for a given box.
输入指定盒子的信息。

Name 名称Description 描述Schema 架构
contentInformationSource
内容信息来源

required 必需的
Indication of how box content is meant to be provided.
指示如何提供盒内内容。
BoxContentInformationSource
包装内容信息来源
dimensions 尺寸
required 必需的
Measurement of a package's dimensions.
包装尺寸的测量。
Dimensions 尺寸
items 商品
optional 可选
The items and their quantity in the box. This must be empty if the box contentInformationSource is BARCODE_2D or MANUAL_PROCESS.
物品及其在盒子中的数量。如果盒子为 contentInformationSourceBARCODE_2DMANUAL_PROCESS ,则必须为空。
< ItemInput > array < ItemInput > 数组
quantity 数量
required 必需的
The number of containers where all other properties like weight or dimensions are identical.
所有其他属性如重量或尺寸都相同的集装箱数量。

Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数
weight 重量
required 必需的
The weight of a package.
包装重量
Weight 重量

BoxUpdateInput 盒子更新输入

Input information for updating a box
输入更新盒子的信息

Name 名称Description 描述Schema 架构
contentInformationSource
内容信息来源

required 必需的
Indication of how box content is meant to be provided.
指示如何提供盒内内容。
BoxContentInformationSource
包装内容信息来源
dimensions 尺寸
required 必需的
Measurement of a package's dimensions.
包装尺寸的测量。
Dimensions 尺寸
items 商品
optional 可选
The items and their quantity in the box. This must be empty if the box contentInformationSource is BARCODE_2D or MANUAL_PROCESS.
物品及其在盒子中的数量。如果盒子为 contentInformationSourceBARCODE_2DMANUAL_PROCESS ,则必须为空。
< ItemInput > array < ItemInput > 数组
packageId 包 ID
optional 可选
Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed
主键用于唯一标识一个箱包。若意图更新现有箱包,则必须提供 PackageId。添加新箱包时无需提供此值。未提供的现有 PackageId 将被视为待删除

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
quantity 数量
required 必需的
The number of containers where all other properties like weight or dimensions are identical.
所有其他属性如重量或尺寸都相同的集装箱数量。

Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数
weight 重量
required 必需的
The weight of a package.
包装重量
Weight 重量

CancelInboundPlanResponse
取消入站计划响应

The cancelInboundPlan response.
响应《 cancelInboundPlan 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

CancelSelfShipAppointmentRequest
取消自寄送预约请求

The cancelSelfShipAppointment request.
请求《 cancelSelfShipAppointment 》。

Name 名称Description 描述Schema 架构
reasonComment 原因評論
optional 可选
Reason for cancelling or rescheduling a self-ship appointment.
取消或重新安排自提预约的原因。
ReasonComment 原因评论

CancelSelfShipAppointmentResponse
取消自寄预约响应

The CancelSelfShipAppointment response.
响应《 CancelSelfShipAppointment 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

Carrier 搬运工

The carrier for the inbound shipment.
承运入境货物的载体。

Name 名称Description 描述Schema 架构
alphaCode alphaCode 翻译文本:alphaCode
optional 可选
The carrier code. For example, USPS or DHLEX.
承运商代码。例如,USPS 或 DHLEX。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
name 名字
optional 可选
The name of the carrier.
承运人名称

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

CarrierAppointment 承运预约

Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up.
包含运输承运人预约的详细信息。此预约由亚马逊提供,是运输承运人接受提货货物的指示。

Name 名称Description 描述Schema 架构
endTime 结束时间
required 必需的
The end timestamp of the appointment in UTC.
预约结束时间戳(UTC 时间)。
string (date-time) 字符串(日期时间)
startTime 开始时间
required 必需的
The start timestamp of the appointment in UTC.
预约的起始时间戳(UTC 时间)。
string (date-time) 字符串(日期时间)

ComplianceDetail 合规详情

Contains item identifiers and related tax information.
包含项目标识符和相关税费信息。

Name 名称Description 描述Schema 架构
asin asin 翻译文本:asin
optional 可选
The Amazon Standard Identification Number, which identifies the detail page identifier.
亚马逊标准识别号,用于标识详情页标识符。

minLength : 1 最小长度:1
maxLength : 10 最大长度:10
string 字符串
fnsku fnsku 翻译文本:fnsku
optional 可选
The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition.
Fulfillment Network SKU,用于识别具有目录数据和状况的实际可履行物品。

minLength : 1 最小长度:1
maxLength : 10 最大长度:10
string 字符串
msku msku msku
optional 可选
The merchant SKU, a merchant-supplied identifier for a specific SKU.
商家 SKU,指商家提供的特定 SKU 的标识符。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
taxDetails 税费详情
optional 可选
Information used to determine the tax compliance.
用于确定税务合规的信息。
TaxDetails 税费详情

ConfirmDeliveryWindowOptionsResponse
确认配送时间选项响应

The confirmDeliveryWindowOptions response.
响应《 confirmDeliveryWindowOptions 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

ConfirmPackingOptionResponse
确认包装选项响应

The confirmPackingOption response.
响应《 confirmPackingOption 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

ConfirmPlacementOptionResponse
确认放置选项响应

The confirmPlacementOption response.
响应《 confirmPlacementOption 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

ConfirmShipmentContentUpdatePreviewResponse
确认发货内容更新预览响应

The confirmShipmentContentUpdatePreview response.
响应《 confirmShipmentContentUpdatePreview 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

ConfirmTransportationOptionsRequest
确认运输选项请求

The confirmTransportationOptions request.
请求《 confirmTransportationOptions 》。

Name 名称Description 描述Schema 架构
transportationSelections
交通选择

required 必需的
Information needed to confirm one of the available transportation options.
所需确认可用运输方式之一的信息。
< TransportationSelection > array
< 交通选择 > 数组

ConfirmTransportationOptionsResponse
确认运输选项响应

The confirmTransportationOptions response.
响应《 confirmTransportationOptions 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

ContactInformation 联系方式

The seller's contact information.
卖家联系方式。

Name 名称Description 描述Schema 架构
email 邮箱
optional 可选
The email address. 邮箱地址。
minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
name 名字
required 必需的
The contact's name. 联系人姓名。
minLength : 1 最小长度:1
maxLength : 50 最大长度:50
string 字符串
phoneNumber 电话号码
required 必需的
The phone number. 电话号码。
minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串

ContentUpdatePreview 内容更新预览

Preview of the changes that will be applied to the shipment.
预览将应用于运输的变更。

Name 名称Description 描述Schema 架构
contentUpdatePreviewId 内容更新预览 ID
required 必需的
Identifier of a content update preview.
内容更新预览的标识符。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
expiration 过期
required 必需的
The time at which the content update expires. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ.
内容更新过期的时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ss.sssZ
string (date-time) 字符串(日期时间)
requestedUpdates 请求更新
required 必需的
Objects that were included in the update request.
更新请求中包含的对象。
RequestedUpdates 请求更新
transportationOption 运输选项
required 必需的
Contains information pertaining to a transportation option and the related carrier.
包含有关运输选项及其相关承运人的信息。
TransportationOption 运输选项

CreateInboundPlanRequest 创建入站计划请求

The createInboundPlan request.
请求《 createInboundPlan 》。

Name 名称Description 描述Schema 架构
destinationMarketplaces 目标市场
required 必需的
Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request.
市场需要发货的商品所在平台。当前此请求中只能选择一个平台。
< string > array 字符串数组
items 商品
required 必需的
Items included in this plan.
此计划包含的物品。
< ItemInput > array < ItemInput > 数组
name 名字
optional 可选
Name for the Inbound Plan. If one isn't provided, a default name will be provided.
名称为入境计划。如果没有提供,将提供默认名称。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
sourceAddress 源地址
required 必需的
Specific details to identify a place.
具体细节以识别地点。
AddressInput 地址输入

CreateInboundPlanResponse
创建入站计划响应

The createInboundPlan response.
响应《 createInboundPlan 》。

Name 名称Description 描述Schema 架构
inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

CreateMarketplaceItemLabelsRequest
创建市场商品标签请求

The createMarketplaceItemLabels request.
请求《 createMarketplaceItemLabels 》。

Name 名称Description 描述Schema 架构
height 高度
optional 可选
The height of the item label.
项目标签的高度。

Minimum value : 25
最小值: 25

Maximum value : 100
最大值: 100
number 数字
labelType 标签类型
required 必需的
Indicates the type of print type for a given label.
指示特定标签的印刷类型。
LabelPrintType 标签打印类型
localeCode 地区代码
optional 可选
The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character.
从 ISO 639 语言代码和 ISO 3166-1 alpha-2 国家代码标准构成的地区代码,由下划线字符分隔。

Default : "en_US"
默认: "en_US"

Pattern : "^[a-z]{2}_[A-Z]{2}$"
模式: "^[a-z]{2}_[A-Z]{2}$"
string 字符串
marketplaceId 市场 ID
required 必需的
The Marketplace ID. For a list of possible values, refer to Marketplace IDs.
市场 ID。有关可能的值列表,请参阅市场 ID。

minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串
mskuQuantities msku 数量
required 必需的
Represents the quantity of an MSKU to print item labels for.
表示打印商品标签所需 MSKU 的数量。
< MskuQuantity > array < MskuQuantity > 数组
pageType 页面类型
optional 可选
The page type to use to print the labels. Possible values: 'A4_21', 'A4_24', 'A4_24_64x33', 'A4_24_66x35', 'A4_24_70x36', 'A4_24_70x37', 'A4_24i', 'A4_27', 'A4_40_52x29', 'A4_44_48x25', 'Letter_30'.
打印标签时使用的页面类型。可能的值:'A4_21'、'A4_24'、'A4_24_64x33'、'A4_24_66x35'、'A4_24_70x36'、'A4_24_70x37'、'A4_24i'、'A4_27'、'A4_40_52x29'、'A4_44_48x25'、'Letter_30'。
ItemLabelPageType 商品标签页面类型
width 宽度
optional 可选
The width of the item label.
项目标签的宽度。

Minimum value : 25
最小值: 25

Maximum value : 100
最大值: 100
number 数字

CreateMarketplaceItemLabelsResponse
创建市场商品标签响应

The createMarketplaceItemLabels response.
响应《 createMarketplaceItemLabels 》。

Name 名称Description 描述Schema 架构
documentDownloads 文档下载
required 必需的
Resources to download the requested document.
资源下载所需文档。
< DocumentDownload > array
< 文档下载 > 数组

Currency 货币

The type and amount of currency.
货币的类型和数量。

Name 名称Description 描述Schema 架构
amount 数量
required 必需的
Decimal value of the currency.
货币的十进制值。
number 数字
code 代码
required 必需的
ISO 4217 standard of a currency code.
ISO 4217 货币代码标准。

minLength : 3 最小长度:3
maxLength : 3 最大长度:3
string 字符串

CustomPlacementInput 自定义放置输入

Provide units going to the warehouse.
提供即将送往仓库的单位。

Name 名称Description 描述Schema 架构
items 商品
required 必需的
Items included while creating Inbound Plan.
创建进货计划时包含的项目。
< ItemInput > array < ItemInput > 数组
warehouseId 仓库 ID
required 必需的
Warehouse Id. 仓库 ID
minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

Dates 日期

Specifies the date that the seller expects their shipment will be shipped.
指定卖家预计发货的日期。

Name 名称Description 描述Schema 架构
readyToShipWindow 待发货时间
optional 可选
Contains a start and end DateTime representing a time range.
包含表示时间范围的起始和结束 DateTime。
Window 窗户

DeliveryWindowOption 配送时间选项

Contains information pertaining to a delivery window option.
包含有关配送时间窗口选项的信息。

Name 名称Description 描述Schema 架构
availabilityType 可用类型
required 必需的
Identifies type of Delivery Window Availability. Values: AVAILABLE, CONGESTED
识别配送时间窗口可用性类型。值: AVAILABLECONGESTED
string 字符串
deliveryWindowOptionId 配送窗口选项 ID
required 必需的
Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered.
配送时间窗口选项的标识符。配送时间窗口选项代表一种预计货物送达的选项。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
endDate 结束日期
required 必需的
The time at which this delivery window option ends. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ.
此配送时间窗口选项结束的时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mmZ
string (date-time) 字符串(日期时间)
startDate 开始日期
required 必需的
The time at which this delivery window option starts. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ.
这个配送时间窗口选项开始的时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mmZ
string (date-time) 字符串(日期时间)
validUntil 有效期至
required 必需的
The time at which this window delivery option is no longer valid. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ.
此窗口配送选项失效的时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mmZ
string (date-time) 字符串(日期时间)

Dimensions 尺寸

Measurement of a package's dimensions.
包装尺寸的测量。

Name 名称Description 描述Schema 架构
height 高度
required 必需的
The height of a package.
包装的高度。

Minimum value : 0
最小值: 0

Maximum value : 100000
最大值: 100000
number 数字
length 长度
required 必需的
The length of a package.
包装的长度。

Minimum value : 0
最小值: 0

Maximum value : 100000
最大值: 100000
number 数字
unitOfMeasurement 单位
required 必需的
Unit of linear measure. 长度单位。UnitOfMeasurement 计量单位
width 宽度
required 必需的
The width of a package.
包装的宽度。

Minimum value : 0
最小值: 0

Maximum value : 100000
最大值: 100000
number 数字

DocumentDownload 文档下载

Resource to download the requested document.
资源下载所需文档。

Name 名称Description 描述Schema 架构
downloadType 下载类型
required 必需的
The type of download. Possible values: URL.
下载类型。可能的值: URL
string 字符串
expiration 过期
optional 可选
The URI's expiration time. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ.
URI 的过期时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ss.sssZ
string (date-time) 字符串(日期时间)
uri uri 翻译文本:uri
required 必需的
Uniform resource identifier to identify where the document is located.
统一资源标识符,用于标识文档所在位置。
string 字符串

Error 错误

Error object containing information about what went wrong.
错误对象,包含关于出错信息的说明。

Name 名称Description 描述Schema 架构
code 代码
required 必需的
An error code that identifies the type of error that occurred.
错误代码,用于识别发生的错误类型。

minLength : 1 最小长度:1
maxLength : 256 最大长度:256
string 字符串
details 详情
optional 可选
Additional details that can help the caller understand or fix the issue.
额外细节,有助于呼叫者理解或解决问题。

minLength : 0 最小长度:0
maxLength : 8192 最大长度:8192
string 字符串
message 消息
required 必需的
A message that describes the error condition.
错误状态描述的消息。

minLength : 1 最小长度:1
maxLength : 2048 最大长度:2048
string 字符串

ErrorList 错误列表

A list of error responses returned when a request is unsuccessful.
请求失败时返回的错误响应列表。

Name 名称Description 描述Schema 架构
errors 错误
required 必需的
List of errors. 错误列表。< Error > array < 错误 > 数组

FreightInformation 货运信息

Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided.
货运信息描述正在运输的 SKU。只有在提供货运信息的情况下,才会返回货运承运人选项和报价。

Name 名称Description 描述Schema 架构
declaredValue 申报价值
optional 可选
The type and amount of currency.
货币的类型和数量。
Currency 货币
freightClass 货运等级
optional 可选
Freight class. 货运等级。

Possible values: NONE, FC_50, FC_55, FC_60, FC_65, FC_70, FC_77_5, FC_85, FC_92_5, FC_100, FC_110, FC_125, FC_150, FC_175, FC_200, FC_250, FC_300, FC_400, FC_500.
可能的值: NONEFC_50FC_55FC_60FC_65FC_70FC_77_5FC_85FC_92_5FC_100FC_110FC_125FC_150FC_175FC_200FC_250FC_300FC_400FC_500

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

GenerateDeliveryWindowOptionsResponse
生成配送时间选项响应

The generateDeliveryWindowOptions response.
响应《 generateDeliveryWindowOptions 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

GeneratePackingOptionsResponse
生成包装选项响应

The generatePackingOptions response.
响应《 generatePackingOptions 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

GeneratePlacementOptionsRequest
生成放置选项请求

The generatePlacementOptions request.
请求《 generatePlacementOptions 》。

Name 名称Description 描述Schema 架构
customPlacement 自定义放置
optional 可选
Custom placement options you want to add to the plan. This is only used for the India (IN - A21TJRUUN4KGV) marketplace.
您想添加到计划中的自定义位置选项。此选项仅用于印度(IN - A21TJRUUN4KGV)市场。
< CustomPlacementInput > array
< 自定义放置输入 > 数组

GeneratePlacementOptionsResponse
生成放置选项响应

The generatePlacementOptions response.
响应《 generatePlacementOptions 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

GenerateSelfShipAppointmentSlotsRequest
生成自寄送预约时段请求

The generateSelfShipAppointmentSlots request.
请求《 generateSelfShipAppointmentSlots 》。

Name 名称Description 描述Schema 架构
desiredEndDate 期望结束日期
optional 可选
The desired end date. In ISO 8601 datetime format.
期望的结束日期。按照 ISO 8601 日期时间格式。
string (date-time) 字符串(日期时间)
desiredStartDate 期望开始日期
optional 可选
The desired start date. In ISO 8601 datetime format.
期望的起始日期。按照 ISO 8601 日期时间格式。
string (date-time) 字符串(日期时间)

GenerateSelfShipAppointmentSlotsResponse
生成自寄送预约时段响应

The generateSelfShipAppointmentSlots response.
响应《 generateSelfShipAppointmentSlots 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

GenerateShipmentContentUpdatePreviewsRequest
生成发货内容更新预览请求

The GenerateShipmentContentUpdatePreviews request.
请求《 GenerateShipmentContentUpdatePreviews 》。

Name 名称Description 描述Schema 架构
boxes 箱子
required 必需的
A list of boxes that will be present in the shipment after the update.
更新后的运输中将出现的盒子清单。
< BoxUpdateInput > array < BoxUpdateInput > 数组
items 商品
required 必需的
A list of all items that will be present in the shipment after the update.
更新后装运中将出现的所有物品清单。
< ItemInput > array < ItemInput > 数组

GenerateShipmentContentUpdatePreviewsResponse
生成发货内容更新预览响应

The GenerateShipmentContentUpdatePreviews response.
响应《 GenerateShipmentContentUpdatePreviews 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

GenerateTransportationOptionsRequest
生成运输选项请求

The generateTransportationOptions request.
请求《 generateTransportationOptions 》。

Name 名称Description 描述Schema 架构
placementOptionId 放置选项 ID
required 必需的
The placement option to generate transportation options for.
为生成运输选项的放置选项。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
shipmentTransportationConfigurations
运输配置

required 必需的
List of shipment transportation configurations.
运输配置清单。
< ShipmentTransportationConfiguration > array
< 配送运输配置 > 数组

GenerateTransportationOptionsResponse
生成运输选项响应

The generateTransportationOptions response.
响应《 generateTransportationOptions 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

GetDeliveryChallanDocumentResponse
获取送货单据响应

The getDeliveryChallanDocumentResponse response.
响应《 getDeliveryChallanDocumentResponse 》。

Name 名称Description 描述Schema 架构
documentDownload 文档下载
required 必需的
Resource to download the requested document.
资源下载所需文档。
DocumentDownload 文档下载

GetSelfShipAppointmentSlotsResponse
获取自寄预约时段响应

The getSelfShipAppointmentSlots response.
响应《 getSelfShipAppointmentSlots 》。

Name 名称Description 描述Schema 架构
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页
selfShipAppointmentSlotsAvailability
自助预约发货时段可用

required 必需的
The self ship appointment time slots availability and an expiration date for which the slots can be scheduled.
自提预约时间段的有效性和预约时间的截止日期。
SelfShipAppointmentSlotsAvailability
自寄送预约时段可用性

InboundOperationStatus 入站操作状态

GetInboundOperationStatus response.
获取入站操作状态响应。

Name 名称Description 描述Schema 架构
operation 操作
required 必需的
The name of the operation in the asynchronous API call.
异步 API 调用中操作的名称。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
operationId 操作 ID
required 必需的
The operation ID returned by the asynchronous API call.
异步 API 调用返回的操作 ID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
operationProblems 操作问题
required 必需的
The problems in the processing of the asynchronous operation.
异步操作处理中的问题。
< OperationProblem > array
< 操作问题 > 数组
operationStatus 操作状态
required 必需的
The status of an operation.
操作的状态。
OperationStatus 操作状态

InboundPlan 入境计划

Inbound plan containing details of the inbound workflow.
进口计划包含进口工作流程的详细信息。

Name 名称Description 描述Schema 架构
createdAt 创建时间
required 必需的
The time at which the inbound plan was created. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ssZ.
创建入站计划的时间。按照 ISO 8601 日期时间格式,模式为 yyyy-MM-ddTHH:mm:ssZ
string (date-time) 字符串(日期时间)
inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
lastUpdatedAt 最后更新时间
required 必需的
The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.
最后更新入境计划的时刻。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ssZ
string (date-time) 字符串(日期时间)
marketplaceIds 市场 ID
required 必需的
A list of marketplace IDs.
市场 ID 列表
< string > array 字符串数组
name 名字
required 必需的
Human-readable name of the inbound plan.
入站计划的易读名称。
string 字符串
packingOptions 包装选项
optional 可选
Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details.
包装选项供进货计划使用。当通过相应操作生成时,此属性将被填充。如果选择了放置选项,则仅返回该放置选项的包装选项。如果有已确认的运输,则仅返回那些运输的包装选项。查询包装选项以获取更多详细信息。
< PackingOptionSummary > array
< 包装选项摘要 > 数组
placementOptions 放置选项
optional 可选
Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details.
入站计划的放置选项。当通过相应操作生成时,此属性将被填充。如果已选择放置选项,则该选项将是唯一返回的选项。查询放置选项以获取更多详细信息。
< PlacementOptionSummary > array
< PlacementOptionSummary > 数组
shipments 发货
optional 可选
A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the confirmPlacementOptions operation. Only shipments from the chosen placement option are returned. Query the shipment for more details.
货单 ID 列表。当使用 confirmPlacementOptions 操作生成时,此属性将被填充。仅返回所选放置选项的货单。查询货单以获取更多详细信息。
< ShipmentSummary > array
< 发货摘要 > 数组
sourceAddress 源地址
required 必需的
Specific details to identify a place.
具体细节以识别地点。
Address 地址
status 状态
required 必需的
Current status of the inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.
当前进货计划状态。可能值: ACTIVEVOIDEDSHIPPEDERRORED

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

InboundPlanSummary 进口计划摘要

A light-weight inbound plan.
轻量级入境计划。

Name 名称Description 描述Schema 架构
createdAt 创建时间
required 必需的
The time at which the inbound plan was created. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.
创建入站计划的时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ssZ
string (date-time) 字符串(日期时间)
inboundPlanId 入站计划 ID
required 必需的
Identifier of an inbound plan.
计划标识符

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
lastUpdatedAt 最后更新时间
required 必需的
The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.
最后更新入境计划的时刻。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ssZ
string (date-time) 字符串(日期时间)
marketplaceIds 市场 ID
required 必需的
A list of marketplace IDs.
市场 ID 列表
< string > array 字符串数组
name 名字
required 必需的
Human-readable name of the inbound plan.
入站计划的易读名称。
string 字符串
sourceAddress 源地址
required 必需的
Specific details to identify a place.
具体细节以识别地点。
Address 地址
status 状态
required 必需的
The current status of the inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.
当前进货计划的状况。可能的值有: ACTIVEVOIDEDSHIPPEDERRORED

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

Incentive 激励

Contains details about cost related modifications to the placement cost.
包含关于放置成本相关修改的详细信息。

Name 名称Description 描述Schema 架构
description 描述
required 必需的
Description of the incentive.
激励措施描述

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
target 目标
required 必需的
Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'.
激励目标。可能值:'推广服务', '履行费用折扣'。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
type 类型
required 必需的
Type of incentive. Possible values: FEE, DISCOUNT.
激励类型。可能值: FEEDISCOUNT

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
value 价值
required 必需的
The type and amount of currency.
货币的类型和数量。
Currency 货币

Item 商品

Information associated with a single SKU in the seller's catalog.
与卖家目录中单个 SKU 相关的信息。

Name 名称Description 描述Schema 架构
asin asin 翻译文本:asin
required 必需的
The Amazon Standard Identification Number (ASIN) of the item.
该商品的亚马逊标准识别号(ASIN)。

minLength : 1 最小长度:1
maxLength : 10 最大长度:10
string 字符串
expiration 过期
optional 可选
The expiration date of the MSKU. In ISO 8601 datetime format with patternYYYY-MM-DD. The same MSKU with different expiration dates cannot go into the same box.
MSKU 的过期日期。按照 ISO 8601 日期时间格式,格式为 YYYY-MM-DD 。同一 MSKU 的不同过期日期不能放入同一个盒子中。

Pattern : "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"
模式: "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"
string 字符串
fnsku fnsku 翻译文本:fnsku
required 必需的
A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.
亚马逊分配给存储在并从亚马逊履行中心配送的产品的一个唯一标识符。

minLength : 1 最小长度:1
maxLength : 10 最大长度:10
string 字符串
labelOwner 标签所有者
required 必需的
Specifies who will label the items. Options include AMAZON, SELLER, and NONE.
指定谁将标记商品。选项包括 AMAZONSELLERNONE

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
manufacturingLotCode 生产批号
optional 可选
The manufacturing lot code.
生产批次代码。

minLength : 1 最小长度:1
maxLength : 256 最大长度:256
string 字符串
msku msku msku
required 必需的
The merchant SKU, a merchant-supplied identifier of a specific SKU.
商家 SKU,特定 SKU 的商家提供的标识符。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
prepInstructions 准备说明
required 必需的
Special preparations that are required for an item.
特殊准备,适用于该商品。
< PrepInstruction > array
< 准备说明 > 数组
quantity 数量
required 必需的
The number of the specified MSKU.
指定的 MSKU 编号。

Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数

ItemInput 商品输入

Defines an item's input parameters.
定义一个项目的输入参数。

Name 名称Description 描述Schema 架构
expiration 过期
optional 可选
The expiration date of the MSKU. In ISO 8601 datetime format with pattern YYYY-MM-DD. Items with the same MSKU but different expiration dates cannot go into the same box.
MSKU 的过期日期。按照 ISO 8601 日期时间格式,格式为 YYYY-MM-DD 。相同 MSKU 但不同过期日期的物品不能放入同一个盒子里。

Pattern : "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"
模式: "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"
string 字符串
labelOwner 标签所有者
required 必需的
Specifies who will label the items. Options include AMAZON, SELLER or NONE.
指定谁将标记商品。选项包括 AMAZONSELLERNONE
LabelOwner 标签所有者
manufacturingLotCode 生产批号
optional 可选
The manufacturing lot code.
生产批次代码。

minLength : 1 最小长度:1
maxLength : 256 最大长度:256
string 字符串
msku msku msku
required 必需的
The merchant SKU, a merchant-supplied identifier of a specific SKU.
商家 SKU,特定 SKU 的商家提供的标识符。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
prepOwner 准备所有者
required 必需的
The owner of the preparations, if special preparations are required.
制备的所有者,如需特殊制备。
PrepOwner 准备所有者
quantity 数量
required 必需的
The number of units of the specified MSKU that will be shipped.
指定 MSKU 将发货的单位数量。

Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数

ItemLabelPageType 商品标签页面类型

The page type to use to print the labels. Possible values: 'A4_21', 'A4_24', 'A4_24_64x33', 'A4_24_66x35', 'A4_24_70x36', 'A4_24_70x37', 'A4_24i', 'A4_27', 'A4_40_52x29', 'A4_44_48x25', 'Letter_30'.
打印标签时使用的页面类型。可能的值:'A4_21'、'A4_24'、'A4_24_64x33'、'A4_24_66x35'、'A4_24_70x36'、'A4_24_70x37'、'A4_24i'、'A4_27'、'A4_40_52x29'、'A4_44_48x25'、'Letter_30'。

Type : enum 类型:枚举

Value 价值Description 描述
A4_21-
A4_24-
A4_24_64x33-
A4_24_66x35-
A4_24_70x36-
A4_24_70x37-
A4_24i-
A4_27-
A4_40_52x29-
A4_44_48x25-
Letter_30 信件_30-

LabelOwner 标签所有者

Specifies who will label the items. Options include AMAZON, SELLER or NONE.
指定谁将标记商品。选项包括 AMAZONSELLERNONE

Type : enum 类型:枚举

Value 价值Description 描述
AMAZONAmazon provides the information.
亚马逊提供信息。
SELLERSeller provides the information.
卖家提供信息。
NONENo owner is required for the labelling.
无需标签所有者。

LabelPrintType 标签打印类型

Indicates the type of print type for a given label.
指示特定标签的印刷类型。

Type : enum 类型:枚举

Value 价值Description 描述
STANDARD_FORMAT-
THERMAL_PRINTING-

ListDeliveryWindowOptionsResponse
列表配送时间选项响应

The listDeliveryWindowOptions response.
响应《 listDeliveryWindowOptions 》。

Name 名称Description 描述Schema 架构
deliveryWindowOptions 配送时间选项
required 必需的
Delivery window options generated for the placement option.
为放置选项生成的配送时间选项。
< DeliveryWindowOption > array
< 交货时间选项 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListInboundPlanBoxesResponse
列表入站计划箱响应

The listInboundPlanBoxes response.
响应《 listInboundPlanBoxes 》。

Name 名称Description 描述Schema 架构
boxes 箱子
required 必需的
A list of boxes in an inbound plan.
一個進口計劃中箱子的清單。
< Box > array < 盒 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListInboundPlanItemsResponse
列表入站计划项响应

The listInboundPlanItems response.
响应《 listInboundPlanItems 》。

Name 名称Description 描述Schema 架构
items 商品
required 必需的
The items in an inbound plan.
入站计划中的项目。
< Item > array < 项目 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListInboundPlanPalletsResponse
列表进货计划托盘响应

The listInboundPlanPallets response.
响应《 listInboundPlanPallets 》。

Name 名称Description 描述Schema 架构
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页
pallets 托盘
required 必需的
The pallets in an inbound plan.
入站计划中的托盘。
< Pallet > array 托盘 > 数组

ListInboundPlansResponse 列表入站计划响应

The listInboundPlans response.
响应《 listInboundPlans 》。

Name 名称Description 描述Schema 架构
inboundPlans 进口计划
optional 可选
A list of inbound plans with minimal information.
一份包含最少信息的入境计划清单。
< InboundPlanSummary > array
< InboundPlanSummary > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListItemComplianceDetailsResponse
列表项合规详情响应

The listItemComplianceDetails response.
响应《 listItemComplianceDetails 》。

Name 名称Description 描述Schema 架构
complianceDetails 合规详情
optional 可选
List of compliance details.
合规详情列表。
< ComplianceDetail > array
< 合规详情 > 数组

ListPackingGroupBoxesResponse
列表包装分组框响应

The listPackingGroupBoxes response.
响应《 listPackingGroupBoxes 》。

Name 名称Description 描述Schema 架构
boxes 箱子
required 必需的
Provides the information about the list of boxes in the packing group.
提供包装组中盒子的列表信息。
< Box > array < 盒 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListPackingGroupItemsResponse
列表包装组项目响应

The listPackingGroupItems response.
响应《 listPackingGroupItems 》。

Name 名称Description 描述Schema 架构
items 商品
required 必需的
Provides the information about the list of items in the packing group.
提供包装组中物品清单的信息。
< Item > array < 项目 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListPackingOptionsResponse
列表包装选项响应

The listPlacementOptions response.
响应《 listPlacementOptions 》。

Name 名称Description 描述Schema 架构
packingOptions 包装选项
required 必需的
List of packing options. 包装选项列表。< PackingOption > array < 包装选项 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListPlacementOptionsResponse
列表放置选项响应

The listPlacementOptions response.
响应《 listPlacementOptions 》。

Name 名称Description 描述Schema 架构
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页
placementOptions 放置选项
required 必需的
Placement options generated for the inbound plan.
为入境计划生成的放置选项。
< PlacementOption > array
< PlacementOption > 数组

ListPrepDetailsResponse 列表准备详情响应

The response to the listPrepDetails operation.
listPrepDetails 操作的响应。

Name 名称Description 描述Schema 架构
mskuPrepDetails mskuPrepDetails msku 准备详情
required 必需的
A list of MSKUs and related prep details.
一份 MSKU 列表及相关准备细节。
< MskuPrepDetail > array < MskuPrepDetail > 数组

ListShipmentBoxesResponse
清单发货箱响应

The listShipmentBoxes response.
响应《 listShipmentBoxes 》。

Name 名称Description 描述Schema 架构
boxes 箱子
required 必需的
A list of boxes in a shipment.
一個運輸中的箱子清單。
< Box > array < 盒 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListShipmentContentUpdatePreviewsResponse
清单发货内容更新预览响应

The ListShipmentContentUpdatePreviews response.
响应《 ListShipmentContentUpdatePreviews 》。

Name 名称Description 描述Schema 架构
contentUpdatePreviews 内容更新预览
required 必需的
A list of content update previews in a shipment.
发货内容更新预览列表。
< ContentUpdatePreview > array
< 内容更新预览 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListShipmentItemsResponse
清单发货项响应

The listShipmentItems response.
响应《 listShipmentItems 》。

Name 名称Description 描述Schema 架构
items 商品
required 必需的
The items in a shipment.
运输中的商品。
< Item > array < 项目 > 数组
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页

ListShipmentPalletsResponse
清单装货托盘响应

The listShipmentPallets response.
响应《 listShipmentPallets 》。

Name 名称Description 描述Schema 架构
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页
pallets 托盘
required 必需的
The pallets in a shipment.
货物的托盘。
< Pallet > array 托盘 > 数组

ListTransportationOptionsResponse
列表运输选项响应

The listTransportationOptions response.
响应《 listTransportationOptions 》。

Name 名称Description 描述Schema 架构
pagination 分页
optional 可选
Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。
Pagination 分页
transportationOptions 运输选项
required 必需的
Transportation options generated for the placement option.
为放置选项生成的运输选项。
< TransportationOption > array
< 交通运输选项 > 数组

LtlTrackingDetail LtlTrackingDetail Ltl 跟踪详情

Contains information related to Less-Than-Truckload (LTL) shipment tracking.
包含有关不足整车(LTL)运输跟踪的信息。

Name 名称Description 描述Schema 架构
billOfLadingNumber 提单号
optional 可选
The number of the carrier shipment acknowledgement document.
运输承运确认单的编号。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
freightBillNumber 货运账单号码
optional 可选
The number associated with the freight bill.
与运费单相关的数字。
< string > array 字符串数组

LtlTrackingDetailInput LtlTrackingDetailInput 翻译文本:Ltl 跟踪详情输入

Contains input information to update Less-Than-Truckload (LTL) tracking information.
包含输入信息以更新不足卡车装载量(LTL)跟踪信息。

Name 名称Description 描述Schema 架构
billOfLadingNumber 提单号
optional 可选
The number of the carrier shipment acknowledgement document.
运输承运确认单的编号。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
freightBillNumber 货运账单号码
required 必需的
Number associated with the freight bill.
与运费单相关的编号。
< string > array 字符串数组

MskuPrepDetail MskuPrepDetail 翻译文本:MskuPrepDetail

An MSKU and its related prep details.
一个 MSKU 及其相关准备细节。

Name 名称Description 描述Schema 架构
allOwnersConstraint 所有所有者约束
optional 可选
A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints.
所有所有者都适用的约束。如果没有指定约束,则遵循任何个别所有者的约束。
AllOwnersConstraint 所有者约束
labelOwnerConstraint 标签所有者约束
optional 可选
A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable.
一个可以应用于单个所有者的约束。如果没有指定约束, AMAZONSELLER 都是可接受的。
OwnerConstraint 所有者约束
msku msku msku
required 必需的
The merchant SKU, a merchant-supplied identifier for a specific SKU.
商家 SKU,指商家提供的特定 SKU 的标识符。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
prepCategory 准备类别
required 必需的
The preparation category for shipping an item to Amazon's fulfillment network.
商品寄送至亚马逊履行网络的准备类别。
PrepCategory 准备类别
prepOwnerConstraint 准备所有者约束
optional 可选
A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable.
一个可以应用于单个所有者的约束。如果没有指定约束, AMAZONSELLER 都是可接受的。
OwnerConstraint 所有者约束
prepTypes 准备类型
required 必需的
A list of preparation types associated with a preparation category.
与准备类别相关的准备类型列表。
< PrepType > array < PrepType > 数组

MskuPrepDetailInput MskuPrepDetailInput 翻译文本:MskuPrepDetailInput

An MSKU and its related prep details.
一个 MSKU 及其相关准备细节。

Name 名称Description 描述Schema 架构
msku msku msku
required 必需的
The merchant SKU, a merchant-supplied identifier for a specific SKU.
商家 SKU,指商家提供的特定 SKU 的标识符。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
prepCategory 准备类别
required 必需的
The preparation category for shipping an item to Amazon's fulfillment network.
商品寄送至亚马逊履行网络的准备类别。
PrepCategory 准备类别
prepTypes 准备类型
required 必需的
A list of preparation types associated with a preparation category.
与准备类别相关的准备类型列表。
< PrepType > array < PrepType > 数组

MskuQuantity MSKU 数量

Represents an MSKU and the related quantity.
代表一个 MSKU 及其相关数量。

Name 名称Description 描述Schema 架构
msku msku msku
required 必需的
The merchant SKU, a merchant-supplied identifier for a specific SKU.
商家 SKU,指商家提供的特定 SKU 的标识符。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
quantity 数量
required 必需的
A positive integer.  一个正整数。
Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数

OperationProblem 操作问题

A problem with additional properties persisted to an operation.
附加属性的问题持续到操作中。

Name 名称Description 描述Schema 架构
code 代码
required 必需的
An error code that identifies the type of error that occurred.
错误代码,用于识别发生的错误类型。

minLength : 1 最小长度:1
maxLength : 256 最大长度:256
string 字符串
details 详情
optional 可选
Additional details that can help the caller understand or fix the issue.
额外细节,有助于呼叫者理解或解决问题。

minLength : 0 最小长度:0
maxLength : 8192 最大长度:8192
string 字符串
message 消息
required 必需的
A message that describes the error condition.
错误状态描述的消息。

minLength : 1 最小长度:1
maxLength : 2048 最大长度:2048
string 字符串
severity 严重程度
required 必需的
The severity of the problem. Possible values: WARNING, ERROR.
问题严重程度。可能值: WARNINGERROR

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

OperationStatus 运行状态

The status of an operation.
操作的状态。

Type : enum 类型:枚举

Value 价值Description 描述
SUCCESSIndicates a request has successfully finished processing.
指示请求已成功完成处理。
FAILEDIndicates a request has finished processing but is in a failed state.
指示请求已处理完成但处于失败状态。
IN_PROGRESSIndicates a request is still processing.
指示请求仍在处理中。

OwnerConstraint 所有者约束

A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable.
一个可以应用于单个所有者的约束。如果没有指定约束, AMAZONSELLER 都是可接受的。

Type : enum 类型:枚举

Value 价值Description 描述
AMAZON_ONLYOnly AMAZON is accepted as an owner.
只有 AMAZON
NONE_ONLYOnly NONE is accepted as an owner.
只有 NONE
SELLER_ONLYOnly SELLER is accepted as an owner.
只有 SELLER

PackageGroupingInput 包装分组输入

Packing information for the inbound plan.
包装信息,针对进货计划。

Name 名称Description 描述Schema 架构
boxes 箱子
required 必需的
Box level information being provided.
提供箱级信息。
< BoxInput > array < BoxInput > 数组
packingGroupId 包装组 ID
optional 可选
The ID of the packingGroup that packages are grouped according to. The PackingGroupId can only be provided before placement confirmation, and it must belong to the confirmed PackingOption. One of ShipmentId or PackingGroupId must be provided with every request.
包装分组依据的 packingGroup ID。该 PackingGroupId 只能在确认放置之前提供,并且必须属于已确认的 PackingOption 。每个请求都必须提供 ShipmentIdPackingGroupId 之一。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
shipmentId 发货 ID
optional 可选
The ID of the shipment that packages are grouped according to. The ShipmentId can only be provided after placement confirmation, and the shipment must belong to the confirmed placement option. One of ShipmentId or PackingGroupId must be provided with every request.
货物的 ID,根据该 ID 将包裹分组。在确认下单后才能提供 ShipmentId ,且该货物必须属于已确认的下单选项。每个请求都必须提供 ShipmentIdPackingGroupId 之一。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

PackingOption 包装选项

A packing option contains a set of pack groups plus additional information about the packing option, such as any discounts or fees if it's selected.
包装选项包含一组包装组以及关于包装选项的附加信息,例如选择后是否有任何折扣或费用。

Name 名称Description 描述Schema 架构
discounts 折扣
required 必需的
Discount for the offered option.
优惠选项折扣。
< Incentive > array < 促销 > 数组
expiration 过期
optional 可选
The time at which this packing option is no longer valid. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ.
此包装选项不再有效的具体时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ss.sssZ
string (date-time) 字符串(日期时间)
fees 费用
required 必需的
Fee for the offered option.
选项费用。
< Incentive > array < 促销 > 数组
packingGroups 包装组
required 必需的
Packing group IDs. 包装组 ID。< string > array 字符串数组
packingOptionId 包装选项 ID
required 必需的
Identifier of a packing option.
包装选项的标识符。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
status 状态
required 必需的
The status of the packing option. Possible values: OFFERED, ACCEPTED, EXPIRED.
包装选项的状态。可能的值: OFFEREDACCEPTEDEXPIRED

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
supportedShippingConfigurations
支持配送配置

required 必需的
List of supported shipping modes.
支持配送方式列表。
< ShippingConfiguration > array
< 配送配置 > 数组

PackingOptionSummary 包装选项摘要

Summary information about a packing option.
包装选项的简要信息。

Name 名称Description 描述Schema 架构
packingOptionId 包装选项 ID
required 必需的
Identifier of a packing option.
包装选项的标识符。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
status 状态
required 必需的
The status of a packing option. Possible values: 'OFFERED', 'ACCEPTED', 'EXPIRED'.
包装选项的状态。可能的值:'提供中', '已接受', '已过期'。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

Pagination 分页

Contains tokens to fetch from a certain page.
包含从特定页面获取令牌的代码。

Name 名称Description 描述Schema 架构
nextToken 下一个令牌
optional 可选
When present, pass this string token in the next request to return the next response page.
当存在时,在下一次请求中传递此字符串令牌以返回下一页响应。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

Pallet 托盘

Contains information about a pallet that is used in the inbound plan. The pallet is a container that holds multiple items or boxes.
包含有关用于进货计划的托盘的信息。该托盘是一种可以容纳多个物品或箱子的容器。

Name 名称Description 描述Schema 架构
dimensions 尺寸
optional 可选
Measurement of a package's dimensions.
包装尺寸的测量。
Dimensions 尺寸
packageId 包 ID
required 必需的
Primary key to uniquely identify a Package (Box or Pallet).
主键用于唯一标识一个包装(箱或托盘)。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
quantity 数量
optional 可选
The number of containers where all other properties like weight or dimensions are identical.
所有其他属性如重量或尺寸都相同的集装箱数量。

Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数
stackability 可堆叠
optional 可选
Indicates whether pallets will be stacked when carrier arrives for pick-up.
指示承运人到达取货时是否堆叠托盘。
Stackability 可堆叠
weight 重量
optional 可选
The weight of a package.
包装重量
Weight 重量

PalletInput 托盘输入

Contains input information about a pallet to be used in the inbound plan.
包含有关用于进货计划的托盘的输入信息。

Name 名称Description 描述Schema 架构
dimensions 尺寸
optional 可选
Measurement of a package's dimensions.
包装尺寸的测量。
Dimensions 尺寸
quantity 数量
required 必需的
The number of containers where all other properties like weight or dimensions are identical.
所有其他属性如重量或尺寸都相同的集装箱数量。

Minimum value : 1
最小值: 1

Maximum value : 10000
最大值: 10000
integer 整数
stackability 可堆叠
optional 可选
Indicates whether pallets will be stacked when carrier arrives for pick-up.
指示承运人到达取货时是否堆叠托盘。
Stackability 可堆叠
weight 重量
optional 可选
The weight of a package.
包装重量
Weight 重量

PlacementOption 放置选项

Contains information pertaining to the placement of the contents of an inbound plan and the related costs.
包含有关入境计划内容放置及相关成本的信息。

Name 名称Description 描述Schema 架构
discounts 折扣
required 必需的
Discount for the offered option.
优惠选项折扣。
< Incentive > array < 促销 > 数组
expiration 过期
optional 可选
The expiration date of the placement option. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ.
到期日期的放置选项。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ss.sssZ
string (date-time) 字符串(日期时间)
fees 费用
required 必需的
The fee for the offered option.
提供的选项费用。
< Incentive > array < 促销 > 数组
placementOptionId 放置选项 ID
required 必需的
The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
放置选项的标识符。放置选项代表 SKU 的发货拆分和目的地。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
shipmentIds 发货 ID
required 必需的
Shipment ids. 运单号。< string > array 字符串数组
status 状态
required 必需的
The status of a placement option. Possible values: OFFERED, ACCEPTED, EXPIRED.
放置选项的状态。可能的值: OFFEREDACCEPTEDEXPIRED

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

PlacementOptionSummary 放置选项摘要

Summary information about a placement option.
关于放置选项的摘要信息。

Name 名称Description 描述Schema 架构
placementOptionId 放置选项 ID
required 必需的
The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
放置选项的标识符。放置选项代表 SKU 的发货拆分和目的地。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
status 状态
required 必需的
The status of a placement option. Possible values: OFFERED, ACCEPTED.
放置选项的状态。可能的值: OFFEREDACCEPTED

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

PrepCategory 准备类别

The preparation category for shipping an item to Amazon's fulfillment network.
商品寄送至亚马逊履行网络的准备类别。

Type : enum 类型:枚举

Value 价值Description 描述
ADULTDisplays potentially offensive material such as profanity or nudity.
显示可能令人反感的材料,如粗俗或裸露内容。
BABYMade for a child aged three years or younger, packaging with cutouts greater than one square inch.
专为三岁或以下儿童设计,包装上有大于一平方英寸的镂空。
FC_PROVIDEDA prep type has been defined by the Fulfillment Center. This value is provided by Amazon and cannot be used as an input.
已由履约中心定义了预准备类型。此值由亚马逊提供,不能用作输入。
FRAGILEGlass or otherwise fragile, or a liquid in a glass container.
玻璃或易碎物品,或玻璃容器中的液体。
GRANULARMade of powder, pellets, or granular material.
由粉末、颗粒或颗粒状材料制成。
HANGERMade of cloth or fabric and intended to be put on a hanger.
由布或织物制成,旨在挂在衣架上。
LIQUIDLiquid or viscous without a double seal.
液体或粘稠,无双层密封。
PERFORATEDIn packaging that has a perforated opening.
在带有穿孔开口的包装中。
SETMultiple items that are sold as one unit.
多个商品作为一个单元出售。
SHARPSharp and easily exposed, not already contained in protective packaging.
锋利且易暴露,尚未包含在保护包装内。
SMALLLongest side less than 2 1/8 inches (width of a credit card).
最长边小于 2 又 1/8 英寸(信用卡宽度)。
TEXTILEMade of cloth or fabric that could be damaged by dirt, dust, moisture, or liquid.
由可能被灰尘、尘埃、湿气或液体损坏的布料或织物制成。
UNKNOWNAn unknown prep category was found and needs to be updated. This value is provided by Amazon and cannot be used as an input.
发现了一个未知的准备类别,需要更新。此值由亚马逊提供,不能用作输入。
NONEDoes not require prep. 无需准备。

PrepInstruction 准备说明

Information pertaining to the preparation of inbound goods.
有关进货准备的信息。

Name 名称Description 描述Schema 架构
fee 费用
optional 可选
The type and amount of currency.
货币的类型和数量。
Currency 货币
prepOwner 准备所有者
optional 可选
In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include AMAZON, SELLER or NONE.
在某些情况下,对商品需要特殊准备,这个字段反映了准备者的信息。选项包括 AMAZONSELLERNONE

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
prepType 准备类型
optional 可选
Type of preparation that should be done.
应做的准备类型。


Possible values: ITEM_LABELING, ITEM_BUBBLEWRAP, ITEM_POLYBAGGING, ITEM_TAPING, ITEM_BLACK_SHRINKWRAP, ITEM_HANG_GARMENT, ITEM_BOXING, ITEM_SETCREAT, ITEM_RMOVHANG, ITEM_SUFFOSTK, ITEM_CAP_SEALING, ITEM_DEBUNDLE, ITEM_SETSTK, ITEM_SIOC, ITEM_NO_PREP, ADULT, BABY, TEXTILE, HANGER, FRAGILE, LIQUID, SHARP, SMALL, PERFORATED, GRANULAR, SET, FC_PROVIDED, UNKNOWN, NONE.
可能的值: ITEM_LABELINGITEM_BUBBLEWRAPITEM_POLYBAGGINGITEM_TAPINGITEM_BLACK_SHRINKWRAPITEM_HANG_GARMENTITEM_BOXINGITEM_SETCREATITEM_RMOVHANGITEM_SUFFOSTKITEM_CAP_SEALINGITEM_DEBUNDLEITEM_SETSTKITEM_SIOCITEM_NO_PREPADULTBABYTEXTILEHANGERFRAGILELIQUIDSHARPSMALLPERFORATEDGRANULARSETFC_PROVIDEDUNKNOWNNONE

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

PrepOwner 准备所有者

The owner of the preparations, if special preparations are required.
制备的所有者,如需特殊制备。

Type : enum 类型:枚举

Value 价值Description 描述
AMAZONAmazon provides the information.
亚马逊提供信息。
SELLERThe seller provides the information.
卖家提供信息。
NONENo owner is required for the preparations.
无需业主准备。

PrepType 准备类型

Preparation instructions for shipping an item to Amazon's fulfillment network. For more information about preparing items for shipment to Amazon's fulfillment network, refer to Seller Central Help for your marketplace.
准备将商品发送至亚马逊履行网络的说明。有关为发送至亚马逊履行网络准备商品的更多信息,请参阅您所在市场的卖家中心帮助。

Type : enum 类型:枚举

Value 价值Description 描述
ITEM_BLACK_SHRINKWRAPThe item requires black shrink wrapping.
该商品需要黑色收缩包装。
ITEM_BLANKSTKThe item requires a blank sticker to obscure a bad barcode that cannot be covered by another sticker.
该商品需要一个空白标签来遮挡无法被其他标签覆盖的损坏条形码。
ITEM_BOXINGProducts may require overboxing when there are safety concerns over sharp items, fragile items, hazardous liquids, and vinyl records. For items over 4.5 kg, use double-wall corrugated boxes.
产品可能需要过度包装,当对尖锐物品、易碎物品、危险液体和乙烯基唱片存在安全顾虑时。对于重量超过 4.5 公斤的物品,请使用双层瓦楞纸箱。
ITEM_BUBBLEWRAPThe item requires bubble wrapping.
该商品需要气泡包装。
ITEM_CAP_SEALINGTo prevent leakage, the product needs to have a secondary seal in one of the following types: Induction seal, safety ring, clips, heat shrink plastic band, or boxing.
为防止泄漏,产品需要在以下类型之一中具有一个次级密封:感应密封、安全环、夹子、热缩塑料带或包装盒。
ITEM_DEBUNDLEThe item requires taking apart a set of items labeled for individual sale. Remove tape or shrink wrap that groups multiple inventory units together.
该商品需要拆开一套标有单独销售的物品。移除将多个库存单位捆绑在一起的保护胶带或收缩膜。
ITEM_HANG_GARMENTThe item must be placed on a hanger.
物品必须挂在衣架上。
ITEM_LABELINGThe FNSKU label must be applied to the item.
商品上必须贴上 FNSKU 标签。
ITEM_NO_PREPThe item does not require any prep.
该商品无需准备。
ITEM_POLYBAGGINGThe item requires polybagging.
该商品需要使用塑料袋包装。
ITEM_RMOVHANGThe item cannot be shipped on a hanger.
该商品不能挂衣架上发货。
ITEM_SETCREATUnits that are sets must be labeled as sets on their packaging. The barcodes on the individual items must not face outward and must not require covering.
单品组成套装的必须在其包装上标明为套装。单品上的条形码不得朝外,且不得需要覆盖。
ITEM_SETSTKProducts that are sets must be marked as sets on their packaging. Add a label to the unit that clearly states that the products must be received and sold as a single unit. For example, if a set of six unique toy cars is sold as one unit, the packaging for each car must indicate that it is part of the set.
产品套装必须在包装上标明为套装。在单个单位上添加标签,明确指出产品必须作为一个单独的单位接收和销售。例如,如果一套六款独特的玩具车作为一个单位出售,每辆车的包装必须标明它是套装的一部分。
ITEM_SIOCThe item ships in its original product packaging.
该商品以原装产品包装发货。
ITEM_SUFFOSTKPoly bags with an opening of 12 cm or larger (measured when flat) must have a suffocation warning. This warning must be printed on the bag or attached as a label.
塑料袋开口 12 厘米或更大(平放时测量)必须要有窒息警告。此警告必须印在袋子上或作为标签附着。
ITEM_TAPINGIndicates that taping is required.
表示需要贴胶带。

Quote 报价

The estimated shipping cost associated with the transportation option.
与运输选项相关的预估运费。

Name 名称Description 描述Schema 架构
cost 成本
required 必需的
The type and amount of currency.
货币的类型和数量。
Currency 货币
expiration 过期
optional 可选
The time at which this transportation option quote expires. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ss.sssZ.
此运输选项报价失效的时间。按照 ISO 8601 日期时间格式,格式为 yyyy-MM-ddTHH:mm:ss.sssZ
string (date-time) 字符串(日期时间)
voidableUntil 可撤销至
optional 可选
Voidable until timestamp.
可撤销至时间戳。
string (date-time) 字符串(日期时间)

ReasonComment 原因评论

Reason for cancelling or rescheduling a self-ship appointment.
取消或重新安排自提预约的原因。

Type : enum 类型:枚举

Value 价值Description 描述
APPOINTMENT_REQUESTED_BY_MISTAKE-
VEHICLE_DELAY-
SLOT_NOT_SUITABLE-
OUTSIDE_CARRIER_BUSINESS_HOURS-
UNFAVOURABLE_EXTERNAL_CONDITIONS-
PROCUREMENT_DELAY-
SHIPPING_PLAN_CHANGED-
INCREASED_QUANTITY-
OTHER-

Region 区域

Representation of a location used within the inbounding experience.
位置在包裹体验中的表示。

Name 名称Description 描述Schema 架构
countryCode 国家代码
optional 可选
ISO 3166 standard alpha-2 country code.
ISO 3166 标准 alpha-2 国家代码。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
state 状态
optional 可选
State. 状态
minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
warehouseId 仓库 ID
optional 可选
An identifier for a warehouse, such as a FC, IXD, upstream storage.
仓库的标识符,例如 FC、IXD、上游存储。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

RequestedUpdates 请求更新

Objects that were included in the update request.
更新请求中包含的对象。

Name 名称Description 描述Schema 架构
boxes 箱子
optional 可选
A list of boxes that will be present in the shipment after the update.
更新后的运输中将出现的盒子清单。
< BoxUpdateInput > array < BoxUpdateInput > 数组
items 商品
optional 可选
A list of all items that will be present in the shipment after the update.
更新后装运中将出现的所有物品清单。
< ItemInput > array < ItemInput > 数组

ScheduleSelfShipAppointmentRequest
安排自寄送预约请求

The scheduleSelfShipAppointment request.
请求《 scheduleSelfShipAppointment 》。

Name 名称Description 描述Schema 架构
reasonComment 原因評論
optional 可选
Reason for cancelling or rescheduling a self-ship appointment.
取消或重新安排自提预约的原因。
ReasonComment 原因评论

ScheduleSelfShipAppointmentResponse
安排自寄预约响应

The scheduleSelfShipAppointment response.
响应《 scheduleSelfShipAppointment 》。

Name 名称Description 描述Schema 架构
selfShipAppointmentDetails
自寄送预约详情

required 必需的
Appointment details for carrier pickup or fulfillment center appointments.
预约承运人取货或配送中心预约的详细信息。
SelfShipAppointmentDetails
自寄送预约详情

SelectedDeliveryWindow 精选配送时间窗口

Selected delivery window attributes.
选定的配送时间窗口属性。

Name 名称Description 描述Schema 架构
availabilityType 可用类型
required 必需的
Identifies type of Delivery Window Availability. Values: AVAILABLE, CONGESTED
识别配送时间窗口可用性类型。值: AVAILABLECONGESTED
string 字符串
deliveryWindowOptionId 配送窗口选项 ID
required 必需的
Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered.
配送时间窗口选项的标识符。配送时间窗口选项代表一种预计货物送达的选项。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
editableUntil 可编辑至
optional 可选
The timestamp at which this Window can no longer be edited.
此窗口无法再编辑的时间戳。
string (date-time) 字符串(日期时间)
endDate 结束日期
required 必需的
The end timestamp of the window.
窗口的结束时间戳。
string (date-time) 字符串(日期时间)
startDate 开始日期
required 必需的
The start timestamp of the window.
窗口的开始时间戳。
string (date-time) 字符串(日期时间)

SelfShipAppointmentDetails
自寄送预约详情

Appointment details for carrier pickup or fulfillment center appointments.
预约承运人取货或配送中心预约的详细信息。

Name 名称Description 描述Schema 架构
appointmentId 预约 ID
optional 可选
Identifier for appointment.
预约标识符
number 数字
appointmentSlotTime 预约时段
optional 可选
An appointment slot time with start and end.
一个带有开始和结束时间的预约时段。
AppointmentSlotTime 预约时段
appointmentStatus 预约状态
optional 可选
Status of the appointment.
预约状态

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

SelfShipAppointmentSlotsAvailability
自寄送预约时段可用

The self ship appointment time slots availability and an expiration date for which the slots can be scheduled.
自提预约时间段的有效性和预约时间的截止日期。

Name 名称Description 描述Schema 架构
expiresAt 过期时间
optional 可选
The time at which the self ship appointment slot expires. In ISO 8601 datetime format.
自提预约时段到期的时间。采用 ISO 8601 日期时间格式。
string (date-time) 字符串(日期时间)
slots 插槽
optional 可选
A list of appointment slots.
预约时段列表。
< AppointmentSlot > array
预约时段数组

SetPackingInformationRequest
设置包装信息请求

The setPackingInformation request.
请求《 setPackingInformation 》。

Name 名称Description 描述Schema 架构
packageGroupings 包装组合
required 必需的
List of packing information for the inbound plan.
包装信息清单,适用于进货计划。
< PackageGroupingInput > array
< 包组输入 > 数组

SetPackingInformationResponse
设置包装信息响应

The setPackingInformation response.
响应《 setPackingInformation 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

SetPrepDetailsRequest 设置预准备详情请求

The setPrepDetails request.
请求《 setPrepDetails 》。

Name 名称Description 描述Schema 架构
marketplaceId 市场 ID
required 必需的
The marketplace ID. For a list of possible values, refer to Marketplace IDs.
市场 ID。有关可能的值列表,请参阅市场 ID。

minLength : 1 最小长度:1
maxLength : 20 最大长度:20
string 字符串
mskuPrepDetails mskuPrepDetails msku 准备详情
required 必需的
A list of MSKUs and related prep details.
一份 MSKU 列表及相关准备细节。
< MskuPrepDetailInput > array
< MskuPrepDetailInput > 数组

SetPrepDetailsResponse 设置预准备详情响应

The setPrepDetails response.
响应《 setPrepDetails 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

Shipment 发货

Contains information pertaining to a shipment in an inbound plan.
包含有关进口计划中运输的信息。

Name 名称Description 描述Schema 架构
amazonReferenceId 亚马逊参考 ID
optional 可选
A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment.
亚马逊创建的唯一标识符,用于识别此亚马逊合作伙伴的不足一车/整车(LTL/FTL)运输。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
contactInformation 联系方式
optional 可选
The seller's contact information.
卖家联系方式。
ContactInformation 联系方式
dates 日期
optional 可选
Specifies the date that the seller expects their shipment will be shipped.
指定卖家预计发货的日期。
Dates 日期
destination 目的地
required 必需的
The Amazon fulfillment center address and warehouse ID.
亚马逊配送中心地址和仓库 ID。
ShipmentDestination 发货目的地
freightInformation 货运信息
optional 可选
Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided.
货运信息描述正在运输的 SKU。只有在提供货运信息的情况下,才会返回货运承运人选项和报价。
FreightInformation 货运信息
name 名字
optional 可选
The name of the shipment.
运输名称
string 字符串
placementOptionId 放置选项 ID
required 必需的
The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
放置选项的标识符。放置选项代表 SKU 的发货拆分和目的地。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
selectedDeliveryWindow 已选配送时间
optional 可选
Selected delivery window attributes.
选定的配送时间窗口属性。
SelectedDeliveryWindow 已选送货时间
selectedTransportationOptionId
selectedTransportationOptionId 已选运输选项 ID

optional 可选
Identifier of a transportation option. A transportation option represent one option for how to send a shipment.
运输方式标识符。一种运输方式代表一种发送货物的选择。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
selfShipAppointmentDetails
自寄送预约详情

optional 可选
List of self ship appointment details.
自寄送预约详情列表。
< SelfShipAppointmentDetails > array
< 自行安排配送详情 > 数组
shipmentConfirmationId 发货确认 ID
optional 可选
The confirmed shipment ID which shows up on labels (for example, FBA1234ABCD).
已确认的运单号,显示在标签上(例如, FBA1234ABCD )。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
source 
required 必需的
Specifies the 'ship from' address for the shipment.
指定发货地址。
ShipmentSource 发货来源
status 状态
optional 可选
The status of a shipment. The state of the shipment will typically start as UNCONFIRMED, then transition to WORKING after a placement option has been confirmed, and then to READY_TO_SHIP once labels are generated.
运输状态。运输状态通常从 UNCONFIRMED


Possible values: ABANDONED, CANCELLED, CHECKED_IN, CLOSED, DELETED, DELIVERED, IN_TRANSIT, MIXED, READY_TO_SHIP, RECEIVING, SHIPPED, UNCONFIRMED, WORKING
可能的值: ABANDONEDCANCELLEDCHECKED_INCLOSEDDELETEDDELIVEREDIN_TRANSITMIXEDREADY_TO_SHIPRECEIVINGSHIPPEDUNCONFIRMEDWORKING

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
trackingDetails 跟踪详情
optional 可选
Tracking information for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments.
物流跟踪信息,适用于不足整车货物(LTL)和小包裹配送(SPD)运输。
TrackingDetails 跟踪详情

ShipmentDestination 发货目的地

The Amazon fulfillment center address and warehouse ID.
亚马逊配送中心地址和仓库 ID。

Name 名称Description 描述Schema 架构
address 地址
optional 可选
The address the shipment should be sent to. Empty if the destination type is AMAZON_OPTIMIZED.
收货地址,当目的地类型为 AMAZON_OPTIMIZED 时为空。
Address 地址
destinationType 目的地类型
required 必需的
The type of destination for this shipment. Possible values: AMAZON_OPTIMIZED, AMAZON_WAREHOUSE.
目的地类型,此运输的。可能的值: AMAZON_OPTIMIZEDAMAZON_WAREHOUSE

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
warehouseId 仓库 ID
optional 可选
The warehouse that the shipment should be sent to. Empty if the destination type is AMAZON_OPTIMIZED.
仓库,应将货物发送到的地点。如果目的地类型是 AMAZON_OPTIMIZED ,则为空。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

ShipmentSource 发货来源

Specifies the 'ship from' address for the shipment.
指定发货地址。

Name 名称Description 描述Schema 架构
address 地址
optional 可选
Specific details to identify a place.
具体细节以识别地点。
Address 地址
sourceType 源类型
required 必需的
The type of source for this shipment. Possible values: SELLER_FACILITY.
该批次的货源类型。可能值: SELLER_FACILITY

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

ShipmentSummary 发货摘要

Summary information about a shipment.
关于运输的摘要信息。

Name 名称Description 描述Schema 架构
shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
status 状态
required 必需的
The status of a shipment. The state of the shipment will typically start as UNCONFIRMED, then transition to WORKING after a placement option has been confirmed, and then to READY_TO_SHIP once labels are generated.
运输状态。运输状态通常从 UNCONFIRMED


Possible values: ABANDONED, CANCELLED, CHECKED_IN, CLOSED, DELETED, DELIVERED, IN_TRANSIT, MIXED, READY_TO_SHIP, RECEIVING, SHIPPED, UNCONFIRMED, WORKING
可能的值: ABANDONEDCANCELLEDCHECKED_INCLOSEDDELETEDDELIVEREDIN_TRANSITMIXEDREADY_TO_SHIPRECEIVINGSHIPPEDUNCONFIRMEDWORKING

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

ShipmentTransportationConfiguration
运输配置

Details needed to generate the transportation options.
所需生成运输选项的详细信息。

Name 名称Description 描述Schema 架构
contactInformation 联系方式
optional 可选
The seller's contact information.
卖家联系方式。
ContactInformation 联系方式
freightInformation 货运信息
optional 可选
Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided.
货运信息描述正在运输的 SKU。只有在提供货运信息的情况下,才会返回货运承运人选项和报价。
FreightInformation 货运信息
pallets 托盘
optional 可选
List of pallet configuration inputs.
货架配置输入列表。
< PalletInput > array < PalletInput > 数组
readyToShipWindow 待发货时间
required 必需的
The range of dates within which the seller intends to ship their items. This is the pick-up date or 'ready to ship' date, not an estimated delivery date.
卖家打算发货的日期范围。这是取货日期或“准备发货”日期,而不是预计的送达日期。
WindowInput 窗口输入
shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

ShippingConfiguration 物流配置

The shipping configurations supported for the packing option. Available modes are ground small parcel, freight less-than-truckload (LTL), freight full-truckload (FTL) palletized, freight FTL non-palletized, ocean less-than-container-load (LCL), ocean full-container load (FCL), air small parcel, and air small parcel express.
支持的包装选项的运输配置。可用模式包括地面小包裹、货运不足整车(LTL)、货运整车(FTL)托盘化、货运 FTL 非托盘化、海运不足集装箱装载(LCL)、海运整集装箱装载(FCL)、航空小包裹和航空小包裹快递。

Name 名称Description 描述Schema 架构
shippingMode 运输方式
optional 可选
Mode of shipment transportation that this option will provide.
运输方式,本选项将提供的运输方式。


Possible values: GROUND_SMALL_PARCEL, FREIGHT_LTL, FREIGHT_FTL_PALLET, FREIGHT_FTL_NONPALLET, OCEAN_LCL, OCEAN_FCL, AIR_SMALL_PARCEL, AIR_SMALL_PARCEL_EXPRESS.
可能的值: GROUND_SMALL_PARCELFREIGHT_LTLFREIGHT_FTL_PALLETFREIGHT_FTL_NONPALLETOCEAN_LCLOCEAN_FCLAIR_SMALL_PARCELAIR_SMALL_PARCEL_EXPRESS

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
shippingSolution 物流解决方案
optional 可选
Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER, USE_YOUR_OWN_CARRIER.
物流方案选项。可能值: AMAZON_PARTNERED_CARRIERUSE_YOUR_OWN_CARRIER

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

SpdTrackingDetail SpdTrackingDetail 追踪详情

Contains information related to Small Parcel Delivery (SPD) shipment tracking.
包含与小型包裹配送(SPD)运输跟踪相关的信息。

Name 名称Description 描述Schema 架构
spdTrackingItems spdTrackingItems 追踪项
optional 可选
List of Small Parcel Delivery (SPD) tracking items.
快递包裹跟踪项目列表。
< SpdTrackingItem > array
< SpdTrackingItem > 数组

SpdTrackingDetailInput SpdTrackingDetailInput 追踪详情输入

Contains input information to update Small Parcel Delivery (SPD) tracking information.
包含输入信息以更新小包裹配送(SPD)跟踪信息。

Name 名称Description 描述Schema 架构
spdTrackingItems spdTrackingItems 追踪项
required 必需的
List of Small Parcel Delivery (SPD) tracking items input.
小件快递(SPD)跟踪项目输入清单。
< SpdTrackingItemInput > array
< SpdTrackingItemInput > 数组

SpdTrackingItem SpdTrackingItem 跟踪项

Contains information used to track and identify a Small Parcel Delivery (SPD) item.
包含用于跟踪和识别小型包裹配送(SPD)物品的信息。

Name 名称Description 描述Schema 架构
boxId 盒子 ID
optional 可选
The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.
亚马逊提供的用于识别特定箱子的 ID。此 ID 由外部运输 ID(在运输确认后生成)和箱子的索引组成。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
trackingId 跟踪 ID
optional 可选
The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment.
与每个非亚马逊合作的小包裹快递(SPD)运输中的包裹关联的跟踪 ID。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
trackingNumberValidationStatus
跟踪号码验证状态

optional 可选
Whether or not Amazon has validated the tracking number. If more than 24 hours have passed and the status is not yet 'VALIDATED', please verify the number and update if necessary. Possible values: VALIDATED, NOT_VALIDATED.
无论亚马逊是否验证了跟踪号。如果超过 24 小时状态仍未为“已验证”,请核实号码并在必要时更新。可能的值: VALIDATEDNOT_VALIDATED

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

SpdTrackingItemInput SpdTrackingItemInput 翻译文本:Spd 跟踪项目输入

Small Parcel Delivery (SPD) tracking items input information.
小包裹配送(SPD)跟踪项目输入信息。

Name 名称Description 描述Schema 架构
boxId 盒子 ID
required 必需的
The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.
亚马逊提供的用于识别特定箱子的 ID。此 ID 由外部运输 ID(在运输确认后生成)和箱子的索引组成。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
trackingId 跟踪 ID
required 必需的
The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information.
与每个非亚马逊合作的小包裹快递(SPD)运输中的包裹关联的跟踪 ID。卖家必须提供此信息。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

Stackability 可堆叠

Indicates whether pallets will be stacked when carrier arrives for pick-up.
指示承运人到达取货时是否堆叠托盘。

Type : enum 类型:枚举

Value 价值Description 描述
STACKABLEA pallet that can be stacked on top of another pallet.
一个可以堆叠在另一个托盘上的托盘。
NON_STACKABLEA pallet that cannot be stacked on top of another pallet.
一个不能堆叠在另一个托盘上的托盘。

TaxDetails 税费详情

Information used to determine the tax compliance.
用于确定税务合规的信息。

Name 名称Description 描述Schema 架构
declaredValue 申报价值
optional 可选
The type and amount of currency.
货币的类型和数量。
Currency 货币
hsnCode hsn 代码
optional 可选
Harmonized System of Nomenclature code.
协调制度编码。

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
taxRates 税率
optional 可选
List of tax rates. 税率列表< TaxRate > array < 税率 > 数组

TaxRate 税率

Contains the type and rate of tax.
包含税种和税率。

Name 名称Description 描述Schema 架构
cessRate 税率
optional 可选
Rate of cess tax. 税率。number 数字
gstRate 增值税税率
optional 可选
Rate of gst tax. 增值税税率number 数字
taxType 稅類
optional 可选
Type of tax. Possible values: CGST, SGST, IGST, TOTAL_TAX.
税种类型。可能值: CGSTSGSTIGSTTOTAL_TAX

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串

TrackingDetails 跟踪详情

Tracking information for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments.
物流跟踪信息,适用于不足整车货物(LTL)和小包裹配送(SPD)运输。

Name 名称Description 描述Schema 架构
ltlTrackingDetail ltlTrackingDetail 追踪详情
optional 可选
Contains information related to Less-Than-Truckload (LTL) shipment tracking.
包含有关不足整车(LTL)运输跟踪的信息。
LtlTrackingDetail LtlTrackingDetail 翻译文本:Ltl 跟踪详情
spdTrackingDetail spdTrackingDetail 追踪详情
optional 可选
Contains information related to Small Parcel Delivery (SPD) shipment tracking.
包含与小型包裹配送(SPD)运输跟踪相关的信息。
SpdTrackingDetail SpdTrackingDetail 追踪详情

TrackingDetailsInput 跟踪详情输入

Tracking information input for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments.
跟踪信息输入,用于不足整车货物(LTL)和小包裹配送(SPD)运输。

Name 名称Description 描述Schema 架构
ltlTrackingDetail ltlTrackingDetail 追踪详情
optional 可选
Contains input information to update Less-Than-Truckload (LTL) tracking information.
包含输入信息以更新不足卡车装载量(LTL)跟踪信息。
LtlTrackingDetailInput LtlTrackingDetailInput 翻译文本:Ltl 跟踪详情输入
spdTrackingDetail spdTrackingDetail 追踪详情
optional 可选
Contains input information to update Small Parcel Delivery (SPD) tracking information.
包含输入信息以更新小包裹配送(SPD)跟踪信息。
SpdTrackingDetailInput SpdTrackingDetailInput 翻译文本:Spd 跟踪详情输入

TransportationOption 运输选项

Contains information pertaining to a transportation option and the related carrier.
包含有关运输选项及其相关承运人的信息。

Name 名称Description 描述Schema 架构
carrier 承运商
required 必需的
The carrier for the inbound shipment.
承运入境货物的载体。
Carrier 搬运工
carrierAppointment 承运预约
optional 可选
Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up.
包含运输承运人预约的详细信息。此预约由亚马逊提供,是运输承运人接受提货货物的指示。
CarrierAppointment 承运预约
preconditions 前提条件
required 必需的
Identifies a list of preconditions for confirming the transportation option.
识别确认运输方式的前置条件列表。
< string > array 字符串数组
quote 引用
optional 可选
The estimated shipping cost associated with the transportation option.
与运输选项相关的预估运费。
Quote 报价
shipmentId 发货 ID
required 必需的
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
货物的标识符。一批货物包含正在进货的箱子和单位。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
shippingMode 运输方式
required 必需的
Mode of shipment transportation that this option will provide.
运输方式,本选项将提供的运输方式。


Possible values: GROUND_SMALL_PARCEL, FREIGHT_LTL, FREIGHT_FTL_PALLET, FREIGHT_FTL_NONPALLET, OCEAN_LCL, OCEAN_FCL, AIR_SMALL_PARCEL, AIR_SMALL_PARCEL_EXPRESS.
可能的值: GROUND_SMALL_PARCELFREIGHT_LTLFREIGHT_FTL_PALLETFREIGHT_FTL_NONPALLETOCEAN_LCLOCEAN_FCLAIR_SMALL_PARCELAIR_SMALL_PARCEL_EXPRESS

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
shippingSolution 物流解决方案
required 必需的
Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER, USE_YOUR_OWN_CARRIER.
物流方案选项。可能值: AMAZON_PARTNERED_CARRIERUSE_YOUR_OWN_CARRIER

minLength : 1 最小长度:1
maxLength : 1024 最大长度:1024
string 字符串
transportationOptionId 运输选项 ID
required 必需的
Identifier of a transportation option. A transportation option represent one option for how to send a shipment.
运输方式标识符。一种运输方式代表一种发送货物的选择。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

TransportationSelection 交通选择

The transportation option selected to confirm.
已选择的运输方式已确认。

Name 名称Description 描述Schema 架构
contactInformation 联系方式
optional 可选
The seller's contact information.
卖家联系方式。
ContactInformation 联系方式
shipmentId 发货 ID
required 必需的
Shipment ID that the transportation Option is for.
运输选项对应的运单号。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串
transportationOptionId 运输选项 ID
required 必需的
Transportation option being selected for the provided shipment.
运输选项正在为提供的运输选择。

minLength : 38 最小长度:38
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

UnitOfMeasurement 计量单位

Unit of linear measure.
长度单位。

Type : enum 类型:枚举

Value 价值Description 描述
INInches. 英寸
CMCentimeters. 厘米。

UnitOfWeight 重量单位

Unit of the weight being measured.
被测量的重量单位。

Type : enum 类型:枚举

Value 价值Description 描述
LBPounds. 
KGKilograms. 千克

UpdateInboundPlanNameRequest
更新入站计划名称请求

The updateInboundPlanName request.
请求《 updateInboundPlanName 》。

Name 名称Description 描述Schema 架构
name 名字
required 必需的
A human-readable name to update the inbound plan name to.
一个可读的人名,用于更新入境计划名称。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串

UpdateItemComplianceDetailsRequest
更新商品合规详情请求

The updateItemComplianceDetails request.
请求《 updateItemComplianceDetails 》。

Name 名称Description 描述Schema 架构
msku msku msku
required 必需的
The merchant SKU, a merchant-supplied identifier for a specific SKU.
商家 SKU,指商家提供的特定 SKU 的标识符。

minLength : 1 最小长度:1
maxLength : 40 最大长度:40
string 字符串
taxDetails 税费详情
required 必需的
Information used to determine the tax compliance.
用于确定税务合规的信息。
TaxDetails 税费详情

UpdateItemComplianceDetailsResponse
更新商品合规详情响应

The updateItemComplianceDetails response.
响应《 updateItemComplianceDetails 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

UpdateShipmentNameRequest
更新发货名称请求

The updateShipmentName request.
请求《 updateShipmentName 》。

Name 名称Description 描述Schema 架构
name 名字
required 必需的
A human-readable name to update the shipment name to.
一个可读的人名,用于更新运输名称。

minLength : 1 最小长度:1
maxLength : 100 最大长度:100
string 字符串

UpdateShipmentSourceAddressRequest
更新发货源地址请求

The UpdateShipmentSourceAddress request.
请求《 UpdateShipmentSourceAddress 》。

Name 名称Description 描述Schema 架构
address 地址
required 必需的
Specific details to identify a place.
具体细节以识别地点。
AddressInput 地址输入

UpdateShipmentSourceAddressResponse
更新发货源地址响应

The UpdateShipmentSourceAddress response.
响应《 UpdateShipmentSourceAddress 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

UpdateShipmentTrackingDetailsRequest
更新物流跟踪详情请求

The updateShipmentTrackingDetails request.
请求《 updateShipmentTrackingDetails 》。

Name 名称Description 描述Schema 架构
trackingDetails 跟踪详情
required 必需的
Tracking information input for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments.
跟踪信息输入,用于不足整车货物(LTL)和小包裹配送(SPD)运输。
TrackingDetailsInput 跟踪详情输入

UpdateShipmentTrackingDetailsResponse
更新物流跟踪详情响应

The updateShipmentTrackingDetails response.
响应《 updateShipmentTrackingDetails 》。

Name 名称Description 描述Schema 架构
operationId 操作 ID
required 必需的
UUID for the given operation.
给定的操作的 UUID。

minLength : 36 最小长度:36
maxLength : 38  最大长度:38
Pattern : "^[a-zA-Z0-9-]*$"
模式: "^[a-zA-Z0-9-]*$"
string 字符串

Weight 重量

The weight of a package.
包装重量

Name 名称Description 描述Schema 架构
unit 单元
required 必需的
Unit of the weight being measured.
被测量的重量单位。
UnitOfWeight 重量单位
value 价值
required 必需的
Value of a weight.
重量价值。

Minimum value : 0
最小值: 0

Maximum value : 100000
最大值: 100000
number 数字

Window 窗户

Contains a start and end DateTime representing a time range.
包含表示时间范围的起始和结束 DateTime。

Name 名称Description 描述Schema 架构
editableUntil 可编辑至
optional 可选
The timestamp at which this Window can no longer be edited.
此窗口无法再编辑的时间戳。
string (date-time) 字符串(日期时间)
end 结束
required 必需的
The end timestamp of the window.
窗口的结束时间戳。
string (date-time) 字符串(日期时间)
start 开始
required 必需的
The start timestamp of the window.
窗口的开始时间戳。
string (date-time) 字符串(日期时间)

WindowInput 窗口输入

Contains only a starting DateTime.
仅包含起始日期时间。

Name 名称Description 描述Schema 架构
start 开始
required 必需的
The start date of the window. In ISO 8601 datetime format with minute precision. Supports patterns yyyy-MM-ddTHH:mmZ, yyyy-MM-ddTHH:mm:ssZ, or yyyy-MM-ddTHH:mm:ss.sssZ. Note that non-zero second and millisecond components are removed.
窗口开始日期。采用 ISO 8601 日期时间格式,精确到分钟。支持 yyyy-MM-ddTHH:mmZyyyy-MM-ddTHH:mm:ssZyyyy-MM-ddTHH:mm:ss.sssZ 模式。请注意,非零秒和毫秒部分将被删除。
string (date-time) 字符串(日期时间)

Status 状态

The status of an inbound plan.
入境计划的状况。

Type : enum 类型:枚举

Value 价值Description 描述
ACTIVEAn inbound plan that is being worked on.
正在制定的入境计划。
VOIDEDAn inbound plan with all shipment cancelled and can no longer be modified.
一个所有运输已取消的入境计划,无法再进行修改。
SHIPPEDA completed inbound plan. Only minor modifications can be made at this time.
已完成入境计划。目前只能进行微小修改。

SortBy 排序

Sort by field. 按字段排序。

Type : enum 类型:枚举

Value 价值Description 描述
LAST_UPDATED_TIMELast updated time of the inbound plan.
最后更新时间计划。
CREATION_TIMEInbound plan creation time.
入站计划创建时间。

SortOrder 排序顺序

The sort order. 排序方式。

Type : enum 类型:枚举

Value 价值Description 描述
ASCAscending order. 升序。
DESCDescending order. 降序排列。

Did this page help you? 这个页面帮到您了吗?