Sign in

v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List all the company dispatch records

get/v1/dispatches

Query parameters

ids[]integer[]

Specify the ID of the dispatches that you want to view.

vendor_idsstring[]

Specify one or more vendor IDs for filter the search.

driver_ids[]integer[]

Specify the driver ID for fetching the dispatch record for the particular driver.

vehicle_ids[]integer[]

Specify the ID of the vehicle for which you want to fetch the dispatch records.

statusesstring[]

Specify the status of the dispatch to fetch the records of that particular value. Allowed values are "planned", "active", "completed", "cancelled"

include_nativeboolean

Use this parameter to include the dispatches created on the Motive dashboard. Allowed values are <b>true</b>: Include all the dispatches created on the Motive Dashboard. <b>false</b>: Do not include the dispatches created on the Motive Dashboard.

min_updated_atstring date

Fetch the dispatch records that were updated after the specified date.

max_updated_atstring date

Fetch the dispatch records that were updated before the specified time.

per_pageinteger

Denote the number of records displayed per page.

page_nointeger

Denotes the current page number.

Response

200

OR

Example response

{
  "dispatches": [
    {
      "dispatch": {
        "id": 23,
        "vendor_id": "VD-1",
        "vendor_shipper_id": "VSS-1",
        "vendor_consignee_id": "VCS-1",
        "driver_id": 497583,
        "vehicle_id": 24613,
        "consignee_form_ids": [
          "972f7a4e-f616-4773-800a-f314f98e9693"
        ],
        "consignee_status": "departed",
        "consignee_type": "DROPOFF",
        "shipper_form_ids": [
          "0b90adf8-2321-4198-9315-5fb57e155c15"
        ],
        "shipper_status": "departed",
        "shipper_type": "PICKUP",
        "status": "completed",
        "shipper_dispatch_location_id": 22,
        "consignee_dispatch_location_id": 19,
        "vendor_shipper_dispatch_location_id": "VSDL-1",
        "vendor_consignee_dispatch_location_id": "VSDL-2",
        "dispatch_stops": [
          {
            "dispatch_stop": {
              "id": 42,
              "vendor_id": "VDS-1",
              "early_date": "2017-07-13T19:13:00+00:00",
              "form_ids": [
                "0b90adf8-2321-4198-9315-5fb57e155c15"
              ],
              "number": 2,
              "status": "available",
              "type": "PU",
              "dispatch_location_id": 1,
              "vendor_dispatch_location_id": "VDSL-1"
            }
          }
        ]
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 1
  }
}