listHandoverSlots

POST

/easyShip/2022-03-23/timeSlot

Last modified:2024-12-05 09:09:30

Maintainer:Not configured

Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies.

This operation is available for scheduled and unscheduled orders based on marketplace support. See Get Time Slots in the Marketplace Support Table.

This operation can return time slots that have either pickup or drop-off handover methods - see Supported Handover Methods in the Marketplace Support Table.

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

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

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

Responses

🟢200OK

application/json

Success.

Headers

Body

Example

{
    "amazonOrderId": "string",
    "timeSlots": [
        {
            "slotId": "string",
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "handoverMethod": "Pickup"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Modified at 2024-12-05 09:09:30

getDefinitionsProductType

getScheduledPackage