Route

List/Search Routes

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

get/v1/routes

Request

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

Query parameters

limitinteger
Example:25
offsetinteger
sortDirectionstring

ASC or DESC, applied to created_at

startDatestring date-time nullable

Defaults to 30 days ago.

endDatestring date-time nullable

Defaults to now.

tagsstring nullable

Comma-separated order tags; matches routes with an order carrying any of them

searchstring nullable

Free-form search

isDispatchedboolean nullable

Filter by dispatched state

dispatchStrategyIdstring nullable

Comma-separated

pickupStoreLocationIdsstring nullable

Comma-separated

dropoffStoreLocationIdsstring nullable

Comma-separated

citystring nullable

Comma-separated pickup/dropoff cities

statestring nullable

Comma-separated pickup/dropoff states

countrystring nullable

Comma-separated pickup/dropoff countries

Response

OK

totalCountinteger required
limitinteger required
offsetinteger required

Changes

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