listHandoverSlots - Amazon SP API

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

The request schema for the `listHandoverSlots` operation.

marketplaceId

string

required

A string of up to 255 characters.

>= 1 characters<= 255 characters

amazonOrderId

string

required

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

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

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

The response schema for the `listHandoverSlots` operation.

amazonOrderId

string

required

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

timeSlots

array[object (TimeSlot) {4}]

required

A list of time slots.

>= 1 items<= 500 items

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

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