Get Orders Page
List the orders in your depot, most recently updated first. Each order is a summary with these fields:
- id, order_number, type and current status
- customer (id and account)
- created and updated
- the stops it is planned on, with route, delivery outcome and proof of delivery
- line_items, as ids only
Fetch an order with GET /orders/{id} for its full details.
Filters can be combined, and each one narrows the results:
- status: the order's current status, case-insensitive. An unrecognised status returns 400 INVALID_INPUT.
- date: orders scheduled for that day, as YYYY-MM-DD. Any other format returns 400 INVALID_INPUT.
- updated_at_min: orders updated at or after this time. Use it to poll for changes.
- customer_id and order_number: exact match.
Results are paged. limit sets the page size, up to 100 (the default). The Link header holds the URL of the next page. Request that URL as it is, because it already carries your filters. When the Link header has no rel=next URL, you have reached the last page. See Paging.
Request
- Base URL: https://api.smartroutes.io/v2
- URL: https://api.smartroutes.io/v2/orders
- Auth: none declared
Query parameters
Information about the page for pagination. Generated by the OpenAPI
Status of the orders to filter.
SmartRoutes customer id.
Filter orders by the customer they belong to.
Order number of the order to filter
Filter orders by a specific order number
Minimum updated date and time for filtering.
Date the order is scheduled for.
Return only orders scheduled for this date — when the order is due, not when it was created or updated. Use updated_at_min for those.
Maximum number of orders to retrieve per page.
Response
Successful response
Example response
{
"orders": [
{
"status": "ROUTED"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.