HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

listDeliveryWindowOptions

get https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans//shipments//deliveryWindowOptions

Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before becoming available.

Usage Plan:

Rate (requests per second)Burst
230

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Path Params
string
required
length between 38 and 38

Identifier of an inbound plan.

string
required
length between 38 and 38

The shipment to get delivery window options for.

Query Params
integer
1 to 100
Defaults to 10

The number of delivery window options to return in the response matching the given query.

string
length between 0 and 1024

A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

Responses

Response body
object
deliveryWindowOptions
array of objects
required

Delivery window options generated for the placement option.

deliveryWindowOptions*
object
string
required

Identifies type of Delivery Window Availability. Values: AVAILABLE, CONGESTED

string
required
length between 36 and 38

Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered.

date-time
required

The time at which this delivery window option ends. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ.

date-time
required

The time at which this delivery window option starts. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ.

date-time
required

The time at which this window delivery option is no longer valid. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ.

pagination
object

Contains tokens to fetch from a certain page.

string
length between 1 and 1024

When present, pass this string token in the next request to return the next response page.

Headers
object
string

Unique request reference identifier.

string

Your rate limit (requests per second) for this operation.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?