listDeliveryWindowOptions

GET

/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions

Fulfillment Inbound

Last modified:2024-12-05 08:51:44

Maintainer:Not configured

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

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.

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

shipmentId

string

required

The shipment to get delivery window options for.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Query Params

pageSize

integer

optional

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

>= 1<= 100

Default:

paginationToken

string

optional

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.

>= 0 characters<= 1024 characters

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans//shipments//deliveryWindowOptions'

Responses

🟢200OK

application/json

ListDeliveryWindowOptions 200 response

Headers

x-amzn-RequestId

string

optional

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

optional

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

Body

The `listDeliveryWindowOptions` response.

deliveryWindowOptions

array[object (DeliveryWindowOption) {5}]

required

Delivery window options generated for the placement option.

availabilityType

string

required

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

deliveryWindowOptionId

string

required

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

>= 36 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

endDate

string <date-time>

required

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

startDate

string <date-time>

required

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

validUntil

string <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 (Pagination)

optional

The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.

nextToken

string

optional

A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.

Example

{
    "deliveryWindowOptions": [
        {
            "availabilityType": "AVAILABLE",
            "deliveryWindowOptionId": "dw1234abcd-1234-abcd-5678-1234abcd5678",
            "endDate": "2024-01-05T20:00:00.000Z",
            "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
            "placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
            "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
            "startDate": "2024-01-05T14:00:00.000Z",
            "validUntil": "2024-01-05T20:00:00.000Z"
        }
    ],
    "pagination": {
        "nextToken": "string"
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

getDeliveryChallanDocument

generateDeliveryWindowOptions