createScheduledPackageBulk

This operation automatically schedules a time slot for all specified amazonOrderId values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the marketplace support table.

You can optionally assign a packageDetails object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don't specify a time slot, Amazon assigns the earliest available time slot.

You can choose PDF or ZPL for your shipping label's file format and Amazon creates the label accordingly.

This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can't be scheduled, Amazon adds the rejectedOrders list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure.

The following table contains the supported request and burst maximum rates:

Usage Plan:

Rate (requests per second)	Burst
1	5

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are 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 might 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.

Request

Body Params application/json

The request body for the POST /easyShip/2022-03-23/packages/bulk API.

marketplaceId

string

required

A string of up to 255 characters.

>= 1 characters<= 255 characters

orderScheduleDetailsList

array[object (OrderScheduleDetails) {2}]

required

An array allowing users to specify orders to be scheduled.

>= 1 items

amazonOrderId

string

required

An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.

packageDetails

object (PackageDetails)

optional

Package details. Includes packageItems, packageTimeSlot, and packageIdentifier.

labelFormat

enum<string>

required

The file format in which the shipping label will be created.

Allowed values:

PDFZPL

Example

{
    "marketplaceId": "string",
    "orderScheduleDetailsList": [
        {
            "amazonOrderId": "string",
            "packageDetails": {
                "packageItems": [
                    {
                        "sku": "string",
                        "summaries": [
                            {
                                "marketplaceId": "string",
                                "asin": "string",
                                "productType": "string",
                                "conditionType": "new_new",
                                "status": [
                                    "BUYABLE"
                                ],
                                "fnSku": "string",
                                "itemName": "string",
                                "createdDate": "2019-08-24T14:15:22Z",
                                "lastUpdatedDate": "2019-08-24T14:15:22Z",
                                "mainImage": {
                                    "link": "string",
                                    "height": 0,
                                    "width": 0
                                }
                            }
                        ],
                        "attributes": {},
                        "issues": [
                            {
                                "code": "string",
                                "message": "string",
                                "severity": "ERROR",
                                "attributeNames": [
                                    "string"
                                ],
                                "categories": [
                                    "INVALID_ATTRIBUTE"
                                ],
                                "enforcements": {
                                    "actions": [
                                        {
                                            "action": "LISTING_SUPPRESSED"
                                        }
                                    ],
                                    "exemption": {
                                        "status": "EXEMPT",
                                        "expiryDate": "2023-10-28T00:36:48.914Z"
                                    }
                                }
                            }
                        ],
                        "offers": [
                            {
                                "marketplaceId": "string",
                                "offerType": "B2C",
                                "price": {
                                    "currencyCode": "string",
                                    "amount": "string"
                                },
                                "points": {
                                    "pointsNumber": 0,
                                    "pointsMonetaryValue": {
                                        "currencyCode": "string",
                                        "amount": 0
                                    }
                                },
                                "audience": {
                                    "value": "ALL",
                                    "displayName": "string"
                                }
                            }
                        ],
                        "fulfillmentAvailability": [
                            {
                                "fulfillmentChannelCode": "string",
                                "quantity": 0
                            }
                        ],
                        "procurement": [
                            {
                                "costPrice": {
                                    "currencyCode": "string",
                                    "amount": "string"
                                }
                            }
                        ]
                    }
                ],
                "packageTimeSlot": {
                    "slotId": "string",
                    "startTime": "2019-08-24T14:15:22Z",
                    "endTime": "2019-08-24T14:15:22Z",
                    "handoverMethod": "Pickup"
                },
                "packageIdentifier": "string"
            }
        }
    ],
    "labelFormat": "PDF"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/packages/bulk' \
--header 'Content-Type: application/json' \
--data-raw '{
    "marketplaceId": "string",
    "orderScheduleDetailsList": [
        {
            "amazonOrderId": "string",
            "packageDetails": {
                "packageItems": [
                    {
                        "sku": "string",
                        "summaries": [
                            {
                                "marketplaceId": "string",
                                "asin": "string",
                                "productType": "string",
                                "conditionType": "new_new",
                                "status": [
                                    "BUYABLE"
                                ],
                                "fnSku": "string",
                                "itemName": "string",
                                "createdDate": "2019-08-24T14:15:22Z",
                                "lastUpdatedDate": "2019-08-24T14:15:22Z",
                                "mainImage": {
                                    "link": "string",
                                    "height": 0,
                                    "width": 0
                                }
                            }
                        ],
                        "attributes": {},
                        "issues": [
                            {
                                "code": "string",
                                "message": "string",
                                "severity": "ERROR",
                                "attributeNames": [
                                    "string"
                                ],
                                "categories": [
                                    "INVALID_ATTRIBUTE"
                                ],
                                "enforcements": {
                                    "actions": [
                                        {
                                            "action": "LISTING_SUPPRESSED"
                                        }
                                    ],
                                    "exemption": {
                                        "status": "EXEMPT",
                                        "expiryDate": "2023-10-28T00:36:48.914Z"
                                    }
                                }
                            }
                        ],
                        "offers": [
                            {
                                "marketplaceId": "string",
                                "offerType": "B2C",
                                "price": {
                                    "currencyCode": "string",
                                    "amount": "string"
                                },
                                "points": {
                                    "pointsNumber": 0,
                                    "pointsMonetaryValue": {
                                        "currencyCode": "string",
                                        "amount": 0
                                    }
                                },
                                "audience": {
                                    "value": "ALL",
                                    "displayName": "string"
                                }
                            }
                        ],
                        "fulfillmentAvailability": [
                            {
                                "fulfillmentChannelCode": "string",
                                "quantity": 0
                            }
                        ],
                        "procurement": [
                            {
                                "costPrice": {
                                    "currencyCode": "string",
                                    "amount": "string"
                                }
                            }
                        ]
                    }
                ],
                "packageTimeSlot": {
                    "slotId": "string",
                    "startTime": "2019-08-24T14:15:22Z",
                    "endTime": "2019-08-24T14:15:22Z",
                    "handoverMethod": "Pickup"
                },
                "packageIdentifier": "string"
            }
        }
    ],
    "labelFormat": "PDF"
}'

Responses

🟢200OK

application/json

Success

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the bulk scheduling API. It returns by the bulk scheduling API containing an array of the scheduled packtages, an optional list of orders we couldn't schedule with the reason, and a pre-signed URL for a ZIP file containing the associated shipping labels plus the documents enabled for your marketplace.

scheduledPackages

array[object (Package) {9}]

optional

A list of packages. Refer to the Package object.

<= 100 items

scheduledPackageId

object (ScheduledPackageId)

required

Identifies the scheduled package to be updated.

packageDimensions

object (Dimensions)

required

Dimensions of an Amazon catalog item or item in its packaging.

packageWeight

object (Weight)

required

The weight of the scheduled package

packageItems

array[object (Item) {7}]

optional

A list of items contained in the package.

<= 500 items

packageTimeSlot

object (TimeSlot)

required

A time window to hand over an Easy Ship package to Amazon Logistics.

packageIdentifier

string

optional

Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.

invoice

object (InvoiceData)

optional

Invoice number and date.

packageStatus

enum<string>

optional

The status of the package.

Allowed values:

ReadyForPickupPickedUpAtOriginFCAtDestinationFCDeliveredRejectedUndeliverableReturnedToSellerLostInTransitLabelCanceledDamagedInTransitOutForDelivery

trackingDetails

object (TrackingDetails)

optional

Representation of tracking metadata.

rejectedOrders

array[object (RejectedOrder) {2}]

optional

A list of orders we couldn't scheduled on your behalf. Each element contains the reason and details on the error.

amazonOrderId

string

required

An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.

error

object (Error)

optional

Error response returned when the request is unsuccessful.

printableDocumentsUrl

string

optional

A pre-signed URL for the zip document containing the shipping labels and the documents enabled for your marketplace.

Example

{
    "scheduledPackages": [
        {
            "scheduledPackageId": {
                "amazonOrderId": "string",
                "packageId": "string"
            },
            "packageDimensions": {
                "height": {
                    "unit": "string",
                    "value": 0
                },
                "length": {
                    "unit": "string",
                    "value": 0
                },
                "weight": {
                    "unit": "string",
                    "value": 0
                },
                "width": {
                    "unit": "string",
                    "value": 0
                }
            },
            "packageWeight": {
                "value": 11,
                "unit": "Grams"
            },
            "packageItems": [
                {
                    "sku": "string",
                    "summaries": [
                        {
                            "marketplaceId": "string",
                            "asin": "string",
                            "productType": "string",
                            "conditionType": "new_new",
                            "status": [
                                "BUYABLE"
                            ],
                            "fnSku": "string",
                            "itemName": "string",
                            "createdDate": "2019-08-24T14:15:22Z",
                            "lastUpdatedDate": "2019-08-24T14:15:22Z",
                            "mainImage": {
                                "link": "string",
                                "height": 0,
                                "width": 0
                            }
                        }
                    ],
                    "attributes": {},
                    "issues": [
                        {
                            "code": "string",
                            "message": "string",
                            "severity": "ERROR",
                            "attributeNames": [
                                "string"
                            ],
                            "categories": [
                                "INVALID_ATTRIBUTE"
                            ],
                            "enforcements": {
                                "actions": [
                                    {
                                        "action": "LISTING_SUPPRESSED"
                                    }
                                ],
                                "exemption": {
                                    "status": "EXEMPT",
                                    "expiryDate": "2023-10-28T00:36:48.914Z"
                                }
                            }
                        }
                    ],
                    "offers": [
                        {
                            "marketplaceId": "string",
                            "offerType": "B2C",
                            "price": {
                                "currencyCode": "string",
                                "amount": "string"
                            },
                            "points": {
                                "pointsNumber": 0,
                                "pointsMonetaryValue": {
                                    "currencyCode": "string",
                                    "amount": 0
                                }
                            },
                            "audience": {
                                "value": "ALL",
                                "displayName": "string"
                            }
                        }
                    ],
                    "fulfillmentAvailability": [
                        {
                            "fulfillmentChannelCode": "string",
                            "quantity": 0
                        }
                    ],
                    "procurement": [
                        {
                            "costPrice": {
                                "currencyCode": "string",
                                "amount": "string"
                            }
                        }
                    ]
                }
            ],
            "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"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable