---
title: "Get eligible delivery windows for order"
method: GET
path: "/v1/eligible_delivery_windows"
tags: ["Delivery Windows"]
---

# Get eligible delivery windows for order

`GET /v1/eligible_delivery_windows`

## Request

- Base URL: `https://api.sandbox.usenash.com`
- URL: `https://api.sandbox.usenash.com/v1/eligible_delivery_windows`
- Auth: none declared

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.

## Query parameters

- `orderId` string, nullable: The order for which to return eligible delivery windows.
- `externalOrderId` string, nullable: The external order id for which to return eligible delivery windows.
- `startTime` string, date-time, required: The range start for delivery windows.
- `endTime` string, date-time, required: The range end for delivery windows.
- `requestedCapacity` number, nullable: Optionally specify the requested capacity for the delivery windows.

## Response `200`

OK

- EligibleDeliveryWindowsResponse: Response for the eligible delivery windows endpoint.
  - `eligibleDeliveryWindows` EligibleDeliveryWindow[], required
    - `id` string, required: The id of the delivery window
    - `name` string, nullable: The name of the delivery window
    - `ineligibleReason` string, nullable, required: The ineligibility failure reason
    - `allowedTags` string[], nullable, required: The list of allowed tags
    - `storeLocationId` string, nullable: The id of the store location object
    - `storeLocationExternalId` string, nullable: The external id of the store location object, if applicable
    - `zoneId` string, nullable: The id of the zone object
    - `zoneExternalId` string, nullable: The external id of the zone object, if applicable
    - `cutoffTime` string, nullable: The cutoff time of the delivery window in UTC
    - `cutoffTimeLocal` string, nullable: The cutoff time of the delivery window in local timezone
    - `startTime` string, nullable, required: The start time of the delivery window in UTC
    - `startTimeLocal` string, nullable, required: The start time of the delivery window in local timezone
    - `endTime` string, nullable, required: The end time of the delivery window in UTC
    - `endTimeLocal` string, nullable, required: The end time of the delivery window in local timezone
    - `remainingCapacity` number, nullable: The remaining capacity for the delivery window
    - `maximumCapacity` number, nullable: The maximum capacity for the delivery window
    - `minimumOrderValueCents` integer, nullable: The minimum order value for the delivery window in cents
    - `timezoneId` string, nullable: The timezone id of the return timestamps, following the TZ database format
    - `priceCents` integer, nullable: The price for the delivery window in cents
    - `score` number, nullable: The score for the delivery window
    - `windowMetadata` object, nullable: Key-value window metadata.
  - `ineligibleDeliveryWindows` EligibleDeliveryWindow[], required
    - `id` string, required: The id of the delivery window
    - `name` string, nullable: The name of the delivery window
    - `ineligibleReason` string, nullable, required: The ineligibility failure reason
    - `allowedTags` string[], nullable, required: The list of allowed tags
    - `storeLocationId` string, nullable: The id of the store location object
    - `storeLocationExternalId` string, nullable: The external id of the store location object, if applicable
    - `zoneId` string, nullable: The id of the zone object
    - `zoneExternalId` string, nullable: The external id of the zone object, if applicable
    - `cutoffTime` string, nullable: The cutoff time of the delivery window in UTC
    - `cutoffTimeLocal` string, nullable: The cutoff time of the delivery window in local timezone
    - `startTime` string, nullable, required: The start time of the delivery window in UTC
    - `startTimeLocal` string, nullable, required: The start time of the delivery window in local timezone
    - `endTime` string, nullable, required: The end time of the delivery window in UTC
    - `endTimeLocal` string, nullable, required: The end time of the delivery window in local timezone
    - `remainingCapacity` number, nullable: The remaining capacity for the delivery window
    - `maximumCapacity` number, nullable: The maximum capacity for the delivery window
    - `minimumOrderValueCents` integer, nullable: The minimum order value for the delivery window in cents
    - `timezoneId` string, nullable: The timezone id of the return timestamps, following the TZ database format
    - `priceCents` integer, nullable: The price for the delivery window in cents
    - `score` number, nullable: The score for the delivery window
    - `windowMetadata` object, nullable: Key-value window metadata.

## Other responses

- `422`: Unprocessable Content

---

[API](https://skmtc.dev/nash/apis/nash-api.md) - [All operations](https://skmtc.dev/nash/apis/nash-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nash/apis/nash-api/revisions/e3713837c5c9?raw)
