createScheduledPackage

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

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
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.

Responses

Response body

object

scheduledPackageId

object

required

Identifies the scheduled package to be updated.

amazonOrderId

string

required

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

packageId

string

An Amazon-defined identifier for the scheduled package.

packageDimensions

object

required

The dimensions of the scheduled package.

length

float

≥ 0.01

The numerical value of the specified dimension.

width

float

≥ 0.01

The numerical value of the specified dimension.

height

float

≥ 0.01

The numerical value of the specified dimension.

unit

string

The unit of measurement used to measure the length.

Cm

Show Details

Cm	Centimeters

identifier

string

length between 1 and 255

A string of up to 255 characters.

packageWeight

object

required

The weight of the scheduled package

value

float

≥ 11

The weight of the package.

unit

string

The unit of measurement used to measure the weight.

Grams G

Show Details

Grams	Grams
G	Grams

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.

slotId

string

required

length between 1 and 255

A string of up to 255 characters.

startTime

date-time

A datetime value in ISO 8601 format.

endTime

date-time

A datetime value in ISO 8601 format.

handoverMethod

string

Identifies the method by which a seller will hand a package over to Amazon Logistics.

Pickup Dropoff

Show Details

Pickup	An Amazon Logistics carrier will pickup the package(s) from the seller's pickup address.
Dropoff	Seller will need to drop off the package(s) to a designated location.

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.

invoiceNumber

string

required

length between 1 and 255

A string of up to 255 characters.

invoiceDate

date-time

A datetime value in ISO 8601 format.

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.

trackingId

string

length between 1 and 255

A string of up to 255 characters.

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/package \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
40
}
1
{
2
  "scheduledPackageId": {
3
    "amazonOrderId": "string",
4
    "packageId": "string"
5
  },
6
  "packageDimensions": {
7
    "length": 0,
8
    "width": 0,
9
    "height": 0,
10
    "unit": "Cm",
11
    "identifier": "string"
12
  },
13
  "packageWeight": {
14
    "value": 0,
15
    "unit": "Grams"
16
  },
17
  "packageItems": [
18
    {
19
      "orderItemId": "string",
20
      "orderItemSerialNumbers": [
21
        "string"
22
      ]
23
    }
24
  ],
25
  "packageTimeSlot": {

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.