Skip to main content
GET
Get eligible delivery windows for order

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

orderId
string | null

The order for which to return eligible delivery windows.

Example:

"ord_1234567890"

externalOrderId
string | null

The external order id for which to return eligible delivery windows.

Example:

"ext_1234567890"

startTime
string<date-time>
required

The range start for delivery windows.

Example:

"2024-10-06T00:00:00Z"

endTime
string<date-time>
required

The range end for delivery windows.

Example:

"2024-10-07T00:00:00Z"

requestedCapacity
number | null

Optionally specify the requested capacity for the delivery windows.

Example:

10

Response

OK

Response for the eligible delivery windows endpoint.

eligibleDeliveryWindows
EligibleDeliveryWindow · object[]
required
ineligibleDeliveryWindows
EligibleDeliveryWindow · object[]
required