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

此操作自动为所有输入的 amazonOrderId 预定时间段，生成相关的运输标签以及其他符合市场要求的文档（参考市场文档支持表）。

调用此操作的开发者可以选择性地分配 packageDetails 对象，使他们能够为请求中的每个订单输入首选的时间段。在这种情况下，亚马逊将尝试使用其可选设置安排相应的包裹。另一方面，即，如果未提供时间段，则亚马逊将选择尽可能早的时间段。

关于运输标签的文件格式，外部开发者可以选择 PDF 或 ZPL，亚马逊将相应地创建标签。

此操作返回一个数组，由已安排的包裹组成，并且包含一个短期有效的 URL，指向一个 zip 文件，其中包含生成的运输标签和其他为您的市场启用的文档。如果至少有一个订单无法安排，则亚马逊将在响应中添加 rejectedOrders 列表，其中包含我们无法处理的每个订单的条目。每个条目由一个错误消息组成，描述失败的原因，以便卖家能够采取相应的措施。

下表显示了支持的请求和突发最大速率：

使用计划：

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

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

请求参数

Body 参数application/json

POST /easyShip/2022-03-23/packages/bulk API 的请求体。

marketplaceId

string

必需

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

>= 1 字符<= 255 字符

orderScheduleDetailsList

array[object (OrderScheduleDetails) {2}]

必需

一个允许用户指定要调度的订单的数组。

>= 1 items

amazonOrderId

string

必需

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

packageDetails

object (PackageDetails)

可选

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

labelFormat

enum<string>

必需

运单标签将要创建的文件格式。

枚举值:

PDFZPL

示例

{
    "marketplaceId": "string",
    "orderScheduleDetailsList": [
        {
            "amazonOrderId": "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"
            }
        }
    ],
    "labelFormat": "PDF"
}

示例代码

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/packages/bulk' \
--header 'Content-Type: application/json' \
--data-raw '{
    "marketplaceId": "string",
    "orderScheduleDetailsList": [
        {
            "amazonOrderId": "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"
            }
        }
    ],
    "labelFormat": "PDF"
}'

返回响应

🟢200成功

application/json

成功

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

批量调度 API 的响应模式。它返回一个调度包裹的数组，包含一个附加的未能调度的订单列表及其原因，以及一个预签名的 URL，指向一个包含相关运输标签和为您的市场启用的文档的 ZIP 文件。

scheduledPackages

array[object (Package) {9}]

可选

包列表。请参见Package对象。

<= 100 items

scheduledPackageId

object (ScheduledPackageId)

必需

识别要更新的计划包裹。

packageDimensions

object (Dimensions)

预定包裹的尺寸。

必需

packageWeight

object (Weight)

已安排包裹的重量

必需

packageItems

array[object (Item) {5}]

可选

包裹中包含的物品清单。

packageTimeSlot

object (TimeSlot)

必需

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

packageIdentifier

string

可选

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

invoice

object (InvoiceData)

发票号码和日期。

可选

packageStatus

enum<string>

包裹的状态。

可选

枚举值:

ReadyForPickupPickedUpAtOriginFCAtDestinationFCDeliveredRejectedUndeliverableReturnedToSellerLostInTransitLabelCanceledDamagedInTransitOutForDelivery

trackingDetails

object (TrackingDetails)

跟踪元数据的表示。

可选

rejectedOrders

array[object (RejectedOrder) {2}]

可选

无法为您安排的订单列表。每个元素包含错误的原因和详细信息。

amazonOrderId

string

必需

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

error

object (Error)

可选

请求失败时返回错误响应。

printableDocumentsUrl

string

可选

一个预签名的 URL，用于包含运输标签和为您的市场启用的文件的压缩文档。

示例

{
    "scheduledPackages": [
        {
            "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"
            }
        }
    ],
    "rejectedOrders": [
        {
            "amazonOrderId": "string",
            "error": {
                "code": "string",
                "message": "string",
                "details": "string"
            }
        }
    ],
    "printableDocumentsUrl": "string"
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障