Orders

Get Order by ID

Fetch one order from your depot with all of its details. The response wraps the order in order. It includes:

  • addresses, contacts, dates and time windows
  • line items, each with its own status, quantities, capacities and custom fields
  • order-level capacities, custom fields, skills, tags, emails and attachments
  • order value fields, if order values are enabled for your depot
  • stops: every stop the order is planned on, with its route, delivery outcome and proof of delivery (photos, signatures, questionnaire submissions)

id is the SmartRoutes order ID returned by POST /orders and GET /orders. It is not your order number. To find an order by its order number, use GET /orders?order_number=.... If the order isn't in your depot or has been deleted, you get 404 RESOURCE_NOT_FOUND.

get/orders/{id}

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/orders/{id}
  • Auth: none declared

Path parameters

idstring required

ID of the order to retrieve.

Response

Successful response

Example response

{
  "order": {
    "status": "ROUTED"
  }
}

Changes

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