NAnash
Order

List/Search Orders

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

get/v1/orders

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Query parameters

limitinteger
Example:25
offsetinteger
sortBystring

Sort field: created_at, updated_at, value_cents, pickup_start_time, pickup_end_time, dropoff_start_time, dropoff_end_time

Example:created_at
sortDirectionstring

Sort direction: ASC or DESC

Example:DESC
startDatestring date-time nullable

Lower bound for pickup/dropoff/created-at window. Defaults to 30 days ago.

endDatestring date-time nullable

Upper bound for pickup/dropoff/created-at window. Defaults to now.

statusstring nullable

Comma-separated list of order statuses (e.g. active,pending_confirmation)

Example:active,pending_confirmation
idsstring nullable

Comma-separated list of order ids. Bypasses date filter when set.

referenceIdstring nullable

Exact order reference id. May return multiple orders and bypasses the date filter when set.

Example:REF-123
tagsstring nullable

Comma-separated list of tags

searchstring nullable

Free-form search

hasRoutestring nullable

Filter by route state: has_route, no_route, or all

Example:all
pickupStoreLocationIdsstring nullable

Comma-separated store location ids

dropoffStoreLocationIdsstring nullable

Comma-separated store location ids

citystring nullable

Comma-separated list of pickup or dropoff cities

statestring nullable

Comma-separated list of pickup or dropoff states

countrystring nullable

Comma-separated list of pickup or dropoff countries

pickupBusinessNamestring nullable

Comma-separated list

dropoffBusinessNamestring nullable

Comma-separated list

creationSourcestring nullable

Comma-separated list

dispatchStrategyIdstring nullable

Comma-separated list

Response

OK

totalCountinteger required
limitinteger required
offsetinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.