/dispatches

Update an existing dispatch

This API only accepts a JSON object in the body of the request and is used to update an existing dispatch. The JSON object should take the following general form.

{
  // All dispatch level information here. Refer to table above to see complete list of attributes.
  "vendor_id":1,
  // information to update
  "status":"active",
  "shipper_type":"station"
  // Array of dispatch stops. Can be empty or can have any number of additional stops
  "dispatch_stops":[
    {
      // All dispatch stop information here. Refer to table above to see complete list of attributes.
      "vendor_id":"ghi-1",
      // information to update
      "type":"pickup",
      "number":1,
      "driver_load":true,
    },
  ]
}

To update an existing dispatch just send the entire dispatch again with updated information to this API. To remove a dispatch stop (additional stop) just send the entire dispatch again without the information for the dispatch stop created before.

Language
Credentials
Header
Click Try It! to start a request and see the response here!