Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Easy Ship v2022-03-23

createScheduledPackage

Schedules an Easy Ship order and returns the scheduled package information.

This operation does the following:

  • Specifies the time slot and handover method for the order to be scheduled for delivery.

  • Updates the Easy Ship order status.

  • Generates a shipping label and an invoice. Calling createScheduledPackage also generates a warranty document if you specify a SerialNumber value. To get these documents, see How to get invoice, shipping label, and warranty documents.

  • Shows the status of Easy Ship orders when you call the getOrders operation of the Selling Partner API for Orders and examine the EasyShipShipmentStatus property in the response body.

See the Shipping Label, Invoice, and Warranty columns in the Marketplace Support Table to see which documents are supported in each marketplace.

Usage Plan:

Rate (requests per second)Burst
15

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.

post/easyShip/2022-03-23/package

Request body

amazonOrderIdstring required

An Amazon-defined order identifier, in 3-7-7 format.

marketplaceIdstring required

A string of up to 255 characters.

Response

Success.

packageTrackingNumberstring required

The tracking number on the label of shipment package, that you can fetch from the shippingLabels response. You can also scan the bar code on the shipping label to get the tracking number.