Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Delivery Windows

Get eligible delivery windows for order

Find delivery windows available for a specific order based on the order's store location and requirements. Requires either order_id or external_order_id. Optionally filter by time range and requested capacity.

get/v1/eligible_delivery_windows

Query parameters

orderIdstring nullable

The order for which to return eligible delivery windows.

Example:ord_1234567890

The order for which to return eligible delivery windows.

externalOrderIdstring nullable

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

Example:ext_1234567890

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

startTimestring date-time required

The range start for delivery windows.

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

The range start for delivery windows.

endTimestring date-time required

The range end for delivery windows.

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

The range end for delivery windows.

requestedCapacitynumber nullable

Optionally specify the requested capacity for the delivery windows.

Example:10

Optionally specify the requested capacity for the delivery windows.

Response

OK

Example response

{
  "eligibleDeliveryWindows": [
    {
      "name": "S21",
      "ineligibleReason": "Ineligible due to order tags",
      "storeLocationId": "stl_1234567890",
      "storeLocationExternalId": "1001",
      "zoneId": "zone_1234567890",
      "zoneExternalId": "1001",
      "cutoffTime": "2024-10-04T00:00:00.000000",
      "cutoffTimeLocal": "2024-10-04T00:00:00.000000",
      "startTime": "2024-10-06T00:00:00.000000",
      "startTimeLocal": "2024-10-06T00:00:00.000000",
      "endTime": "2024-10-07T00:00:00.000000",
      "endTimeLocal": "2024-10-07T00:00:00.000000",
      "remainingCapacity": 10,
      "maximumCapacity": 10,
      "minimumOrderValueCents": 1000,
      "timezoneId": "America/New_York",
      "priceCents": 1000,
      "score": 1,
      "windowMetadata": {
        "key": "value"
      }
    }
  ],
  "ineligibleDeliveryWindows": [
    {
      "name": "S21",
      "ineligibleReason": "Ineligible due to order tags",
      "storeLocationId": "stl_1234567890",
      "storeLocationExternalId": "1001",
      "zoneId": "zone_1234567890",
      "zoneExternalId": "1001",
      "cutoffTime": "2024-10-04T00:00:00.000000",
      "cutoffTimeLocal": "2024-10-04T00:00:00.000000",
      "startTime": "2024-10-06T00:00:00.000000",
      "startTimeLocal": "2024-10-06T00:00:00.000000",
      "endTime": "2024-10-07T00:00:00.000000",
      "endTimeLocal": "2024-10-07T00:00:00.000000",
      "remainingCapacity": 10,
      "maximumCapacity": 10,
      "minimumOrderValueCents": 1000,
      "timezoneId": "America/New_York",
      "priceCents": 1000,
      "score": 1,
      "windowMetadata": {
        "key": "value"
      }
    }
  ]
}