---
title: "List/Search Orders"
method: GET
path: "/v1/orders"
tags: ["Order"]
---

# List/Search Orders

`GET /v1/orders`

## Request

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

List orders with filters, sorting, and pagination. Returns a slim payload suitable for discovery; use GET /v1/order/<id> for full details.

## Query parameters

- `limit` integer
- `offset` integer
- `sortBy` string: Sort field: created_at, updated_at, value_cents, pickup_start_time, pickup_end_time, dropoff_start_time, dropoff_end_time
- `sortDirection` string: Sort direction: ASC or DESC
- `startDate` string, date-time, nullable: Lower bound for pickup/dropoff/created-at window. Defaults to 30 days ago.
- `endDate` string, date-time, nullable: Upper bound for pickup/dropoff/created-at window. Defaults to now.
- `status` string, nullable: Comma-separated list of order statuses (e.g. active,pending_confirmation)
- `ids` string, nullable: Comma-separated list of order ids. Bypasses date filter when set.
- `referenceId` string, nullable: Exact order reference id. May return multiple orders and bypasses the date filter when set.
- `tags` string, nullable: Comma-separated list of tags
- `search` string, nullable: Free-form search
- `hasRoute` string, nullable: Filter by route state: has_route, no_route, or all
- `pickupStoreLocationIds` string, nullable: Comma-separated store location ids
- `dropoffStoreLocationIds` string, nullable: Comma-separated store location ids
- `city` string, nullable: Comma-separated list of pickup or dropoff cities
- `state` string, nullable: Comma-separated list of pickup or dropoff states
- `country` string, nullable: Comma-separated list of pickup or dropoff countries
- `pickupBusinessName` string, nullable: Comma-separated list
- `dropoffBusinessName` string, nullable: Comma-separated list
- `creationSource` string, nullable: Comma-separated list
- `dispatchStrategyId` string, nullable: Comma-separated list

## Response `200`

OK

- OrdersListResponse
  - `results` OrderListItem[], required
    - `id` string, required
    - `externalId` string, nullable
    - `referenceId` string, nullable
    - `status` string, nullable
    - `tags` string[], nullable
    - `createdAt` string, date-time, nullable
    - `updatedAt` string, date-time, nullable
    - `valueCents` integer, nullable
    - `currency` string, nullable
    - `pickup` OrderLocationSummary
      - `businessName` string, nullable
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `address` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country` string, nullable
      - `startTime` string, date-time, nullable
      - `endTime` string, date-time, nullable
    - `dropoff` OrderLocationSummary
      - `businessName` string, nullable
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `address` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country` string, nullable
      - `startTime` string, date-time, nullable
      - `endTime` string, date-time, nullable
    - `routeId` string, nullable
    - `portalUrl` string, nullable
  - `totalCount` integer, required
  - `limit` integer, required
  - `offset` integer, required

## 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)
