createScheduledPackage - Amazon SP API

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.

Request

Body Params application/json

The request schema for the `createScheduledPackage` operation.

amazonOrderId

string

required

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

marketplaceId

string

required

A string of up to 255 characters.

>= 1 characters<= 255 characters

packageDetails

object (PackageDetails)

required

Package details. Includes packageItems, packageTimeSlot, and packageIdentifier.

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.

Example

{
    "amazonOrderId": "string",
    "marketplaceId": "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"
    }
}

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/package' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amazonOrderId": "string",
    "marketplaceId": "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"
    }
}'

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

This object contains all the details of the scheduled Easy Ship package.

scheduledPackageId

object (ScheduledPackageId)

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

optional

An Amazon-defined identifier for the scheduled package.

packageDimensions

object (Dimensions)

required

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

height

object (Dimension)

optional

Individual dimension value of an Amazon catalog item or item package.

length

object (Dimension)

optional

Individual dimension value of an Amazon catalog item or item package.

weight

object (Dimension)

optional

Individual dimension value of an Amazon catalog item or item package.

width

object (Dimension)

optional

Individual dimension value of an Amazon catalog item or item package.

packageWeight

object (Weight)

required

The weight of the scheduled package

value

number <float>

optional

The weight of the package.

>= 11

unit

enum<string>

optional

The unit of measurement used to measure the weight.

Allowed values:

GramsG

packageItems

array[object (Item) {7}]

optional

A list of items contained in the package.

<= 500 items

sku

string

required

A selling partner provided identifier for an Amazon listing.

summaries

array[object (ItemSummaryByMarketplace) {10}]

optional

Summary details of a listings item.

attributes

object (ItemAttributes)

optional

A JSON object containing structured listings item attribute data keyed by attribute name.

issues

array[object (Issue) {6}]

optional

The issues associated with the listings item.

offers

array[object (ItemOfferByMarketplace) {5}]

optional

Offer details for the listings item.

fulfillmentAvailability

array[object (FulfillmentAvailability) {2}]

optional

The fulfillment availability for the listings item.

procurement

array[object (ItemProcurement) {1}]

optional

The vendor procurement information for the listings item.

packageTimeSlot

object (TimeSlot)

required

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

slotId

string

required

A string of up to 255 characters.

>= 1 characters<= 255 characters

startTime

string <date-time>

optional

A datetime value in ISO 8601 format.

endTime

string <date-time>

optional

A datetime value in ISO 8601 format.

handoverMethod

enum<string>

optional

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

Allowed values:

PickupDropoff

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.

invoiceNumber

string

required

A string of up to 255 characters.

>= 1 characters<= 255 characters

invoiceDate

string <date-time>

optional

A datetime value in ISO 8601 format.

packageStatus

enum<string>

optional

The status of the package.

Allowed values:

ReadyForPickupPickedUpAtOriginFCAtDestinationFCDeliveredRejectedUndeliverableReturnedToSellerLostInTransitLabelCanceledDamagedInTransitOutForDelivery

trackingDetails

object (TrackingDetails)

optional

Representation of tracking metadata.

trackingId

string

optional

A string of up to 255 characters.

>= 1 characters<= 255 characters

Example

{
    "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"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable