createScheduledPackage - Amazon Selling Partner API (SP-API)-中文

安排一次易船（Easy Ship）订单并返回计划的包裹信息。

此操作执行以下操作：

指定要安排送货的订单的时间段和交接方式。

更新易船订单状态。

生成运送标签和发票。如果您指定了 SerialNumber 值，调用 createScheduledPackage 还会生成保修文件。要获取这些文件，请参阅如何获取发票、运送标签和保修文件。

在您调用销售合作伙伴 API 的 getOrders 操作并检查响应正文中的 EasyShipShipmentStatus 属性时，显示易船订单的状态。

请参见市场支持表中的 运送标签、发票和保修列，以查看每个市场支持哪些文件。

使用计划：

速率（每秒请求数）	突发
1	5

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

请求参数

Body 参数application/json

`createScheduledPackage` 操作的请求模式。

amazonOrderId

string

必需

一个亚马逊定义的订单标识符。识别卖家希望通过亚马逊Easy Ship交付的订单。

marketplaceId

string

必需

最长为255个字符的字符串。

>= 1 字符<= 255 字符

packageDetails

object (PackageDetails)

必需

包裹详情。包含 packageItems、packageTimeSlot 和 packageIdentifier。

packageItems

array[object (Item) {5}]

可选

包裹中包含的物品清单。

packageTimeSlot

object (TimeSlot)

必需

将Easy Ship包裹交给亚马逊物流的时间窗口。

packageIdentifier

string

可选

可选的卖家创建的标识符，印刷在运输标签上，以帮助卖家识别包裹。

示例

{
    "amazonOrderId": "string",
    "marketplaceId": "string",
    "packageDetails": {
        "packageItems": [
            {
                "description": "string",
                "relatedIdentifiers": [
                    {
                        "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID",
                        "itemRelatedIdentifierValue": "OAI-123456789"
                    }
                ],
                "totalAmount": {
                    "currencyCode": "string",
                    "currencyAmount": 0
                },
                "breakdowns": [
                    {
                        "breakdownType": "string",
                        "breakdownAmount": {
                            "currencyCode": "string",
                            "currencyAmount": 0
                        },
                        "breakdowns": {}
                    }
                ],
                "contexts": [
                    {
                        "contextType": "string",
                        "storeName": "Store 1",
                        "orderType": "Order Type",
                        "channel": "MFN",
                        "asin": "B07FGXZQZ1",
                        "sku": "sku-12",
                        "quantityShipped": 1,
                        "fulfillmentNetwork": "MFN",
                        "paymentType": "Debit Card",
                        "paymentMethod": "BANK",
                        "paymentReference": "XXXXX123",
                        "paymentDate": "2020-07-14T03:35:13.214Z",
                        "deferralReason": "B2B",
                        "maturityDate": "2024-07-14T00:00:00Z",
                        "deferralStatus": "HOLD",
                        "startTime": "2020-07-14T03:35:13.214Z",
                        "endTime": "2020-07-14T03:35:13.214Z"
                    }
                ]
            }
        ],
        "packageTimeSlot": {
            "slotId": "string",
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "handoverMethod": "Pickup"
        },
        "packageIdentifier": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/package' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amazonOrderId": "string",
    "marketplaceId": "string",
    "packageDetails": {
        "packageItems": [
            {
                "description": "string",
                "relatedIdentifiers": [
                    {
                        "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID",
                        "itemRelatedIdentifierValue": "OAI-123456789"
                    }
                ],
                "totalAmount": {
                    "currencyCode": "string",
                    "currencyAmount": 0
                },
                "breakdowns": [
                    {
                        "breakdownType": "string",
                        "breakdownAmount": {
                            "currencyCode": "string",
                            "currencyAmount": 0
                        },
                        "breakdowns": {}
                    }
                ],
                "contexts": [
                    {
                        "contextType": "string",
                        "storeName": "Store 1",
                        "orderType": "Order Type",
                        "channel": "MFN",
                        "asin": "B07FGXZQZ1",
                        "sku": "sku-12",
                        "quantityShipped": 1,
                        "fulfillmentNetwork": "MFN",
                        "paymentType": "Debit Card",
                        "paymentMethod": "BANK",
                        "paymentReference": "XXXXX123",
                        "paymentDate": "2020-07-14T03:35:13.214Z",
                        "deferralReason": "B2B",
                        "maturityDate": "2024-07-14T00:00:00Z",
                        "deferralStatus": "HOLD",
                        "startTime": "2020-07-14T03:35:13.214Z",
                        "endTime": "2020-07-14T03:35:13.214Z"
                    }
                ]
            }
        ],
        "packageTimeSlot": {
            "slotId": "string",
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "handoverMethod": "Pickup"
        },
        "packageIdentifier": "string"
    }
}'

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

此对象包含已安排的Easy Ship包裹的所有详细信息。

scheduledPackageId

object (ScheduledPackageId)

必需

识别要更新的计划包裹。

amazonOrderId

string

必需

一个亚马逊定义的订单标识符。识别卖家希望通过亚马逊Easy Ship交付的订单。

packageId

string

可选

亚马逊定义的计划包裹的标识符。

packageDimensions

object (Dimensions)

预定包裹的尺寸。

必需

length

number <float>

指定维度的数值。

可选

>= 0.01

width

number <float>

指定维度的数值。

可选

>= 0.01

height

number <float>

指定维度的数值。

可选

>= 0.01

unit

enum<string>

可选

用于测量长度的单位。

枚举值:

identifier

string

可选

最长为255个字符的字符串。

>= 1 字符<= 255 字符

packageWeight

object (Weight)

已安排包裹的重量

必需

value

number <float>

包裹的重量。

可选

>= 11

unit

enum<string>

可选

用于测量重量的单位。

枚举值:

GramsG

packageItems

array[object (Item) {5}]

可选

包裹中包含的物品清单。

description

string

交易中项目的描述

可选

relatedIdentifiers

array[object (ItemRelatedIdentifier) {2}]

可选

与交易中项目相关的商业标识符。

totalAmount

object (Currency)

可选

一种货币类型和金额。

breakdowns

array[object (Breakdown) {3}]

可选

财务交易中总金额计算细节的明细清单。

contexts

array[object (Context) {17}]

可选

有关该项目的附加信息清单。

packageTimeSlot

object (TimeSlot)

必需

将Easy Ship包裹交给亚马逊物流的时间窗口。

slotId

string

必需

最长为255个字符的字符串。

>= 1 字符<= 255 字符

startTime

string <date-time>

可选

以ISO 8601格式的日期时间值。

endTime

string <date-time>

可选

以ISO 8601格式的日期时间值。

handoverMethod

enum<string>

可选

确定卖家将通过何种方式将包裹交给亚马逊物流。

枚举值:

PickupDropoff

packageIdentifier

string

可选

可选的卖家创建的标识符，印刷在运输标签上，以帮助卖家识别包裹。

invoice

object (InvoiceData)

发票号码和日期。

可选

invoiceNumber

string

必需

最长为255个字符的字符串。

>= 1 字符<= 255 字符

invoiceDate

string <date-time>

可选

以ISO 8601格式的日期时间值。

packageStatus

enum<string>

包裹的状态。

可选

枚举值:

ReadyForPickupPickedUpAtOriginFCAtDestinationFCDeliveredRejectedUndeliverableReturnedToSellerLostInTransitLabelCanceledDamagedInTransitOutForDelivery

trackingDetails

object (TrackingDetails)

跟踪元数据的表示。

可选

trackingId

string

可选

最长为255个字符的字符串。

>= 1 字符<= 255 字符

示例

{
    "scheduledPackageId": {
        "amazonOrderId": "string",
        "packageId": "string"
    },
    "packageDimensions": {
        "length": 0.01,
        "width": 0.01,
        "height": 0.01,
        "unit": "Cm",
        "identifier": "string"
    },
    "packageWeight": {
        "value": 11,
        "unit": "Grams"
    },
    "packageItems": [
        {
            "description": "string",
            "relatedIdentifiers": [
                {
                    "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID",
                    "itemRelatedIdentifierValue": "OAI-123456789"
                }
            ],
            "totalAmount": {
                "currencyCode": "string",
                "currencyAmount": 0
            },
            "breakdowns": [
                {
                    "breakdownType": "string",
                    "breakdownAmount": {
                        "currencyCode": "string",
                        "currencyAmount": 0
                    },
                    "breakdowns": {}
                }
            ],
            "contexts": [
                {
                    "contextType": "string",
                    "storeName": "Store 1",
                    "orderType": "Order Type",
                    "channel": "MFN",
                    "asin": "B07FGXZQZ1",
                    "sku": "sku-12",
                    "quantityShipped": 1,
                    "fulfillmentNetwork": "MFN",
                    "paymentType": "Debit Card",
                    "paymentMethod": "BANK",
                    "paymentReference": "XXXXX123",
                    "paymentDate": "2020-07-14T03:35:13.214Z",
                    "deferralReason": "B2B",
                    "maturityDate": "2024-07-14T00:00:00Z",
                    "deferralStatus": "HOLD",
                    "startTime": "2020-07-14T03:35:13.214Z",
                    "endTime": "2020-07-14T03:35:13.214Z"
                }
            ]
        }
    ],
    "packageTimeSlot": {
        "slotId": "string",
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "handoverMethod": "Pickup"
    },
    "packageIdentifier": "string",
    "invoice": {
        "invoiceNumber": "string",
        "invoiceDate": "2019-08-24T14:15:22Z"
    },
    "packageStatus": "ReadyForPickup",
    "trackingDetails": {
        "trackingId": "string"
    }
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障