Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Delivery Windows

Get a delivery window

Retrieve a single delivery window by ID, including its time slot, capacity, and status.

get/v1/delivery-window/{id}

Path parameters

idstring required

The id of the delivery window

Example:dlw_abc|10:00|12:00|2025-10-22

The id of the delivery window

Response

OK

idstring required

The ID of the delivery window.

namestring required

The name of the delivery window.

startTimestring required

The start time of the delivery window.

startTimeLocalstring required

The start time of the delivery window in local timezone.

endTimestring required

The end time of the delivery window.

endTimeLocalstring required

The end time of the delivery window in local timezone.

timezoneIdstring required

The timezone id of the delivery window.

cutoffTimestring required

The cutoff time of the delivery window.

cutoffTimeLocalstring required

The cutoff time of the delivery window in local timezone.

rrulestring required

The rrule of the delivery window.

exceptionDatesstring[] required

The exception dates of the delivery window.

allowedTagsstring[] required

The allowed tags of the delivery window.

leadTimeMinutesinteger required

The lead time of the delivery window.

priceCentsinteger required

The price of the delivery window.

minimumOrderValueCentsinteger required

The minimum order value of the delivery window.

maximumCapacityinteger required

The maximum capacity of the delivery window.

storeLocationIdstring required

The store location id of the delivery window.

zoneIdstring required

The zone id of the delivery window.

zoneExternalIdstring required

The external zone id of the delivery window.

windowMetadataobject required

The metadata of the delivery window.

isActiveboolean required

Whether the delivery window is active.

isDeletedboolean required

Whether the delivery window is deleted.

Example response

{
  "id": "dw_01234567890123456789",
  "name": "Monday Delivery Window",
  "startTime": "2024-01-01T10:00:00Z",
  "startTimeLocal": "2024-01-01T10:00:00",
  "endTime": "2024-01-01T12:00:00Z",
  "endTimeLocal": "2024-01-01T12:00:00",
  "timezoneId": "America/New_York",
  "cutoffTime": "2024-01-01T10:00:00Z",
  "cutoffTimeLocal": "2024-01-01T10:00:00",
  "rrule": "RRULE:FREQ=WEEKLY;BYDAY=MO",
  "exceptionDates": [
    "2024-01-01",
    "2024-01-02"
  ],
  "allowedTags": [
    "service:rapid",
    "service:express",
    "franchise_location"
  ],
  "leadTimeMinutes": 60,
  "priceCents": 1000,
  "minimumOrderValueCents": 1000,
  "maximumCapacity": 1000,
  "storeLocationId": "stl_01234567890123456789",
  "zoneId": "zone_01234567890123456789",
  "zoneExternalId": "ext_01234567890123456789",
  "windowMetadata": {
    "key": "value"
  },
  "isActive": true
}