createScheduledPackageBulk

post https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/packages/bulk

This operation automatically schedules a time slot for all the amazonOrderIds given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the marketplace document support table).

Developers calling this operation may optionally assign a packageDetails object, allowing them to input a preferred time slot for each order in their request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, i.e., if the time slot is not provided, Amazon will then pick the earliest time slot possible.

Regarding the shipping label's file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly.

This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn't be scheduled, then Amazon adds the rejectedOrders list into the response, which contains an entry for each order we couldn't process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action.

The table below displays 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 were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

200

Success

Response body

object

scheduledPackages

array of objects

length ≤ 100

A list of packages. Refer to the Package object.

scheduledPackages

object

scheduledPackageId

object

required

Identifies the scheduled package to be updated.

packageDimensions

object

required

The dimensions of the scheduled package.

packageWeight

object

required

The weight of the scheduled package

packageItems

array of objects

length ≤ 500

A list of items contained in the package.

packageItems

object

orderItemId

string

length ≤ 255

The Amazon-defined order item identifier.

orderItemSerialNumbers

array of strings

length ≤ 100

A list of serial numbers for the items associated with the OrderItemId value.

orderItemSerialNumbers

packageTimeSlot

object

required

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

packageIdentifier

string

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

invoice

object

Invoice number and date.

packageStatus

string

The status of the package.

ReadyForPickup PickedUp AtOriginFC AtDestinationFC Delivered Rejected Undeliverable ReturnedToSeller LostInTransit LabelCanceled DamagedInTransit OutForDelivery

Show Details

ReadyForPickup	The package is ready for pickup.
PickedUp	The package has been picked up.
AtOriginFC	The package is at its origin fulfillment center.
AtDestinationFC	The package is at its destination fulfillment center.
Delivered	The package has been delivered.
Rejected	The package has been rejected.
Undeliverable	The package is not deliverable.
ReturnedToSeller	The package has been returned to the seller.
LostInTransit	The package has been lost in transit.
LabelCanceled	The package's label has been canceled.
DamagedInTransit	The package has been damaged in transit.
OutForDelivery	The package is out for delivery.

trackingDetails

object

Representation of tracking metadata.

rejectedOrders

array of objects

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

rejectedOrders

object

amazonOrderId

string

required

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

error

object

Error response returned when the request is unsuccessful.

printableDocumentsUrl

string

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

400

Request has missing or invalid parameters and cannot be parsed.

401

The request's Authorization header is not formatted correctly or does not contain a valid token.

403

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404

The resource specified does not exist.

413

The request size exceeded the maximum accepted size.

415

The request payload is in an unsupported format.

429

The frequency of requests was greater than allowed.

500

An unexpected condition occurred that prevented the server from fulfilling the request.

503

Temporary overloading or maintenance of the server.

xxxxxxxxxx
curl --request POST \
     --url https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/packages/bulk \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "orderScheduleDetailsList": [
    {
      "packageDetails": {
        "packageTimeSlot": {
          "handoverMethod": "Pickup"
        }
      }
    }
  ],
  "labelFormat": "PDF"
}
'

xxxxxxxxxx
}
{
  "scheduledPackages": [
    {
      "scheduledPackageId": {
        "amazonOrderId": "string",
        "packageId": "string"
      },
      "packageDimensions": {
        "length": 0,
        "width": 0,
        "height": 0,
        "unit": "Cm",
        "identifier": "string"
      },
      "packageWeight": {
        "value": 0,
        "unit": "Grams"
      },
      "packageItems": [
        {
          "orderItemId": "string",
          "orderItemSerialNumbers": [
            "string"
          ]
        }

200Success

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.