v1

latestOpenAPI 3.0.02026-07-24189145350.1 KB
Consolidated Routes

Get all Routes with Waypoints, Orders and order items

Get all Routes with Waypoints, Orders and order items

get/consolidated-routes/search

Query parameters

limitinteger

Max number of rows that will be displayed per request

offsetinteger

Number of rows skipped from the beginning of the cursor

codestring

code

fromstring

Date from in format YYYY-MM-DD

tostring

Date to in format YYYY-MM-DD

statusstring

Route status

Response

Get all Completed Routes

Example response

{
  "data": [
    {
      "waypoints": [
        {
          "activities": {
            "orders": [
              {
                "date": "2022-12-31",
                "qtn": "ABC123",
                "timeWindow": [
                  {
                    "from": "08:00",
                    "to": "13:00"
                  }
                ],
                "merchants": [
                  {
                    "_id": 1
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  ]
}