getInboundPlan

获取有关入站计划的顶级信息。

使用计划：

速率（每秒请求）	峰值
2	6

x-amzn-RateLimit-Limit 响应头返回适用于请求操作的使用计划速率限制（如果可用）。上表指示该操作的默认速率和峰值值。业务需求较高的销售合作伙伴可能会看到比这里显示的更高的速率和峰值值。如需更多信息，请参阅销售合作伙伴 API 中的使用计划和速率限制。

返回响应

🟢200成功

application/json

获取入境计划 200 响应

Headers

x-amzn-RequestId

string

可选

唯一请求参考标识符。

x-amzn-RateLimit-Limit

string

可选

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

Body

包含入境工作流程细节的入境计划。

createdAt

string <date-time>

必需

ISO 8601 日期时间格式为 yyyy-MM-ddTHH:mm:ss.sssZ。

inboundPlanId

string

入境计划的标识符。

必需

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

lastUpdatedAt

string <date-time>

必需

ISO 8601 日期时间格式为 yyyy-MM-ddTHH:mm:ss.sssZ。

marketplaceIds

array[string]

市场 ID。

必需

name

string

必需

入站计划的人类可读名称。

packingOptions

array[object (PackingOptionSummary) {2}]

可选

入库计划的包装选项。该属性将在通过相应操作生成后填充。如果选择了放置选项，则仅会返回该放置选项的包装选项。如果有已确认的货物运输，则仅会返回这些运输的包装选项。查询包装选项以获取更多信息。

packingOptionId

string

包装选项的标识符。

必需

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

status

string

必需

包装选项的状态。可以是“提供”、“接受”或“过期”。

>= 1 字符<= 1024 字符

placementOptions

array[object (PlacementOptionSummary) {2}]

可选

入境计划的投放选项。此属性将在通过相应操作生成后填充。如果选择了投放选项，则该选项将是唯一返回的选项。查询投放选项以获取更多详细信息。

placementOptionId

string

必需

一个投放选项的标识符。投放选项表示SKU的发货拆分和目的地。

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

status

string

必需

放置选项的状态。可以是：OFFERED 或 ACCEPTED。

>= 1 字符<= 1024 字符

shipments

array[object (ShipmentSummary) {2}]

可选

入库计划的发货 ID。当通过相应操作生成时，此属性将被填充。如果选择了放置选项，则仅返回该选项的发货。如果有确认的发货，则仅返回那些发货。查询发货以获取更多详细信息。

shipmentId

string

必需

货物的识别码。货物包含正在入库的箱子和单位。

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

status

string

必需

货物的状态。货物的状态通常从“进行中”开始，在完成必要操作后，转变为“准备发货”，然后才能被取走或发货。可以是：“已放弃”、“已取消”、“已签到”、“已关闭”、“已删除”、“已交付”、“运输中”、“混合”、“准备发货”、“接收中”、“已发货”、“进行中”。

>= 1 字符<= 1024 字符

sourceAddress

object (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"}

addressLine1

string

街道地址信息。

必需

>= 1 字符<= 180 字符

addressLine2

string

附加街道地址信息。

可选

>= 1 字符<= 60 字符

city

string

城市。

必需

>= 1 字符<= 30 字符

companyName

string

企业名称。

可选

>= 1 字符<= 50 字符

countryCode

string

必需

国家代码采用两位字符的ISO 3166-1 alpha-2格式。

>= 2 字符<= 2 字符

正则匹配:

^[A-Z]{2}$

string

电子邮箱地址。

可选

>= 1 字符<= 1024 字符

name

string

主要联系人姓名。

必需

>= 1 字符<= 50 字符

phoneNumber

string

电话号码。

可选

>= 1 字符<= 20 字符

postalCode

string

邮政编码。

必需

>= 1 字符<= 32 字符

stateOrProvinceCode

string

州或省代码。

可选

>= 1 字符<= 64 字符

status

string

必需

入境计划的当前状态。可以为：ACTIVE（激活）、VOIDED（作废）、SHIPPED（已发货）、ERRORED（出错）。

>= 1 字符<= 1024 字符

示例

{
    "contactInformation": {
        "email": "email@email.com",
        "name": "name",
        "phoneNumber": "1234567890"
    },
    "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"
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应