v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Update a dispatch (v2)

put/v2/dispatches

Request body

idinteger required

Specify the ID of the dispatch that you want to update. NOTE: You must provide either the dispatch ID or the vendor_id in order to update the dispatch.

vendor_idinteger required

Specify the ID of the vendor for which you want to update the dispatch info. NOTE: You must provide either the dispatch ID or the vendor ID in order to update the dispatch.

statusstring required

Specify the status of the dispatch that you want to update. Allowed values are: active, completed, cancelled.

Response

200

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
  }
}