updateScheduledPackages - Amazon SP API

Updates the time slot for handing over the package indicated by the specified scheduledPackageId. You can get the new slotId value for the time slot by calling the listHandoverSlots operation before making another patch call.

See the Update Package column in the Marketplace Support Table to see which marketplaces this operation is supported in.

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 `updateScheduledPackages` operation.

marketplaceId

string

required

A string of up to 255 characters.

>= 1 characters<= 255 characters

updatePackageDetailsList

array[object (UpdatePackageDetails) {2}]

required

A list of package update details.

>= 1 items<= 500 items

scheduledPackageId

object (ScheduledPackageId)

required

Identifies the scheduled package to be updated.

packageTimeSlot

object (TimeSlot)

required

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

Example

{
    "marketplaceId": "string",
    "updatePackageDetailsList": [
        {
            "scheduledPackageId": {
                "amazonOrderId": "string",
                "packageId": "string"
            },
            "packageTimeSlot": {
                "slotId": "string",
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "handoverMethod": "Pickup"
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

A list of packages.

packages

array[object (Package) {9}]

required

A list of packages.

>= 1 items<= 500 items

scheduledPackageId

object (ScheduledPackageId)

required

Identifies the scheduled package to be updated.

packageDimensions

object (Dimensions)

required

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

packageWeight

object (Weight)

required

The weight of the scheduled package

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.

invoice

object (InvoiceData)

optional

Invoice number and date.

packageStatus

enum<string>

optional

The status of the package.

Allowed values:

ReadyForPickupPickedUpAtOriginFCAtDestinationFCDeliveredRejectedUndeliverableReturnedToSellerLostInTransitLabelCanceledDamagedInTransitOutForDelivery

trackingDetails

object (TrackingDetails)

optional

Representation of tracking metadata.

Example

{
    "packages": [
        {
            "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