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 与 Send-to-Amazon 用户界面具有互操作性。
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
联系 URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information 许可证信息
License : Apache License 2.0
许可证 : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
许可证 URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme 统一资源标识符方案
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
Operation: listInboundPlans
操作:listInboundPlans
Description 说明
Provides a list of inbound plans with minimal information.
提供包含最少信息的入境计划列表。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 6 |
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 maxLength : 1024 | string 字符串 | - |
Query 查询 | status 地位 optional 可选的 | The status of an inbound plan. 入站计划的状态。 | enum (Status) 枚举 ( 状态) | - |
Query 查询 | sortBy 排序方式 optional 可选的 | Sort by field. 按字段排序。 | enum (SortBy) 枚举 ( SortBy) | - |
Query 查询 | sortOrder 排序顺序 optional 可选的 | The sort order. 排序顺序。 | enum (SortOrder) 枚举 ( 排序) | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListInboundPlans 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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 模式 |
---|---|---|
202 | CreateInboundPlan 202 response 创建入站计划 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | GetInboundPlan 200 response GetInboundPlan 200 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
Operation: listInboundPlanBoxes
操作:listInboundPlanBoxes
Description 说明
Provides a paginated list of box packages in an inbound plan.
提供入站计划中箱包的分页列表。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListInboundPlanBoxes 200 response ListInboundPlanBoxes 200 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
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 小时,零担 (LTL) 承运商货运 1 小时。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | CancelInboundPlan 202 response 取消入站计划 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
Operation: listInboundPlanItems
操作:listInboundPlanItems
Description 说明
Provides a paginated list of item packages in an inbound plan.
提供入站计划中项目包的分页列表。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListInboundPlanItems 200 response ListInboundPlanItems 200 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Body 身体 | body 机构 required 所需 | The body of the request to updateInboundPlanName .向 updateInboundPlanName 提出的请求正文。 | UpdateInboundPlanNameRequest 更新入站计划名称请求 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
204 | UpdateInboundPlanName 204 response UpdateInboundPlanName 204 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 | - |
Path 路径 | packingGroupId 包装组 ID required 所需 | Identifier of a packing group. 包装组的标识符。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListPackingGroupBoxes 200 response ListPackingGroupBoxes 200 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 | - |
Path 路径 | packingGroupId 包装组 ID required 所需 | Identifier of a packing group. 包装组的标识符。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListPackingGroupItems 200 response ListPackingGroupItems 200 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Body 身体 | body 机构 required 所需 | The body of the request to setPackingInformation .向 setPackingInformation 提出的请求正文。 | SetPackingInformationRequest 设置包装信息请求 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | SetPackingInformation 202 response SetPackingInformation 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
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 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListPackingOptions 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | GeneratePackingOptions 202 response 生成包装选项 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | packingOptionId 包装选项 ID required 所需 | Identifier of a packing option. 包装选项的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | ConfirmPackingOption 202 response ConfirmPackingOption 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
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 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListInboundPlanPallets 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
Operation: listPlacementOptions
操作: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 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListPlacementOptions 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Body 身体 | body 机构 required 所需 | The body of the request to generatePlacementOptions .向 generatePlacementOptions 提出的请求正文。 | GeneratePlacementOptionsRequest 生成布局选项请求 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | GeneratePlacementOptions 202 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 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 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | ConfirmPlacementOption 202 response ConfirmPlacementOption 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 操作: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 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | shipmentId 货件编号 required 所需 | Identifier of a shipment. A shipment contains the boxes and units being inbounded. 货物的标识符。装运货物包含装入的箱子和单位。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | GetShipment 200 response GetShipment 200 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
Operation: listShipmentBoxes
操作:listShipmentBoxes
Description 说明
Provides a paginated list of box packages in a shipment.
提供货物中包装箱的分页列表。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 | - |
Path 路径 | shipmentId 货件编号 required 所需 | Identifier of a shipment. A shipment contains the boxes and units being inbounded. 货物的标识符。装运货物包含装入的箱子和单位。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListShipmentBoxes 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
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.
检索给定货件的货件内容更新预览分页列表。货件内容更新预览是所请求的货件内容更改以及更改对运输成本影响的摘要,只能在指定的到期日之前确认。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 | - |
Path 路径 | shipmentId 货件编号 required 所需 | Identifier of a shipment. A shipment contains the boxes and units being inbounded. 货物的标识符。装运货物包含装入的箱子和单位。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListShipmentContentUpdatePreviews 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | shipmentId 货件编号 required 所需 | Identifier of a shipment. A shipment contains the boxes and units being inbounded. 货物的标识符。装运货物包含装入的箱子和单位。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Body 身体 | body 机构 required 所需 | The body of the request to generateShipmentContentUpdatePreviews .向 generateShipmentContentUpdatePreviews 提出的请求正文。 | GenerateShipmentContentUpdatePreviewsRequest 生成装运内容更新预览请求 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | GenerateShipmentContentUpdatePreviews 202 response 生成装运内容更新预览 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | shipmentId 货件编号 required 所需 | Identifier of a shipment. A shipment contains the boxes and units being inbounded. 货物的标识符。装运货物包含装入的箱子和单位。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | contentUpdatePreviewId required 所需 | Identifier of a content update preview. 内容更新预览的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | GetShipmentContentUpdatePreview 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | shipmentId 货件编号 required 所需 | Identifier of a shipment. A shipment contains the boxes and units being inbounded. 货物的标识符。装运货物包含装入的箱子和单位。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | contentUpdatePreviewId required 所需 | Identifier of a content update preview. 内容更新预览的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | ConfirmShipmentContentUpdatePreview 202 response 确认装运内容更新预览 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
Operation: getDeliveryChallanDocument
操作:getDeliveryChallanDocument
Description 说明
Provide delivery challan document for PCP transportation in IN marketplace.
为五氯苯酚在 IN 市场的运输提供交货证明文件。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 6 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | shipmentId 货件编号 required 所需 | Identifier of a shipment. A shipment contains the boxes and units being inbounded. 货物的标识符。装运货物包含装入的箱子和单位。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | GetDeliveryChallanDocument 200 response GetDeliveryChallanDocument 200 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
操作: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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 | - |
Path 路径 | shipmentId 货件编号 required 所需 | The shipment to get delivery window options for. 要获取交付窗口选项的货物。 minLength : 38 最小长度:38 maxLength : 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 maxLength : 1024 | string 字符串 | - |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
200 | ListDeliveryWindowOptions 200 response Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | shipmentId 货件编号 required 所需 | The shipment to generate delivery window options for. 要为其生成交货窗口选项的货物。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | GenerateDeliveryWindowOptions 202 response 生成交付窗口选项 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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 爆发 |
---|---|
2 | 30 |
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 入站计划标识 required 所需 | Identifier of an inbound plan. 入境计划的标识符。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | shipmentId 货件编号 required 所需 | The shipment to confirm the delivery window option for. 确认发货窗口选项。 minLength : 38 最小长度:38 maxLength : 38 | string 字符串 |
Path 路径 | deliveryWindowOptionId 交付窗口选项 ID required 所需 | The id of the delivery window option to be confirmed. 待确认的交付窗口选项 ID。 minLength : 36 最小长度:36 maxLength : 38 | string 字符串 |
Responses 答复
HTTP Code HTTP 代码 | Description 说明 | Schema 模式 |
---|---|---|
202 | ConfirmDeliveryWindowOptions 202 response ConfirmDeliveryWindowOptions 202 响应 Headers : 页眉 : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RequestId (字符串) :唯一的请求参考标识符。x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.x-amzn-RateLimit-Limit (字符串) :此操作的速率限制(每秒请求次数)。 | 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
Operation: listShipmentItems
操作:listShipmentItems
Description 说明
Provides a paginated list of item packages in a shipment.
提供货件中物品包装的分页列表。
Usage Plan: 使用计划:
Rate (requests per second) 速率(每秒请求次数) | Burst 爆发 |
---|---|
2 | 30 |
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 |
---|