v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Fulfillment Inbound v2024-03-20

listDeliveryWindowOptions

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

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

Path parameters

inboundPlanIdstring required

Identifier of an inbound plan.

shipmentIdstring required

The shipment to get delivery window options for.

Query parameters

pageSizeinteger

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

paginationTokenstring

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.

Response

ListDeliveryWindowOptions 200 response

Example response

{
  "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"
    }
  ]
}