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

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

Body

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