Update an existing dispatch (v2)

Purpose: Use this API to update an existing dispatch.

📘

NOTE

You must pass the below JSON object along with the body parameters. Below is the format of a request body.

Things to remember:

• To update an existing dispatch, you must send the entire dispatch again with the updated information.
• To add a dispatch stop, send the dispatch again with the stop information.
• To remove a dispatch stop, send the dispatch again without the stop information.
• To cancel a dispatch, _do not _change the status of the dispatch to cancelled, but just cancel the dispatch trip. If there are multiple trips, then all of them must be cancelled for the entire dispatch to be cancelled.

{
  "vendor_id":"VD-1",
  "dispatch_stops":[
    {
      "vendor_id":"VBS-2",
      "type":"delivery",
      "number":1,
      "form_ids":[
        "be4cd651-5aca-436b-8cf3-e7881c3d76b8",
        "e93b8563-53cc-4318-b957-369b5fda18d0"
      ],
      "dispatch_location_id":8387
    }
  ],
  "dispatch_trips":[
    {
      "vendor_id":"VT-2",
      "vehicle_id":2597,
      "driver_id":4806,
      "vendor_stop_ids":[
        "VSS-1",
        "VBS-2",
        "VDS-1"
      ],
      "status":"not_started"
    }
  ]
}

{
  "vendor_id":"VD-1",
  "dispatch_stops":[
    {
      "vendor_id":"VBS-2"
    }
  ],
  "dispatch_trips":[
    {
      "vendor_id":"VT-2",
      "status":"cancelled"
    }
  ]
}

Response Parameters

dispatches

• Type: Array of Objects
• Description: List of dispatches.

dispatch

• Type: Object
• Description: Information about a specific dispatch.

id

• Type: Integer
• Description: Unique identifier for the dispatch.

consignee_dispatch_location_id

• Type: Integer
• Description: Unique identifier for the consignee's dispatch location.

shipper_dispatch_location_id

• Type: Integer
• Description: Unique identifier for the shipper's dispatch location.

additional_drops

• Type: String
• Description: Number of additional drop-off locations (if available).

additional_pickups

• Type: String
• Description: Number of additional pickup locations (if available).

consignee_bill_of_lading

• Type: String
• Description: Bill of lading number provided by the consignee (if available).

consignee_comments

• Type: String
• Description: Comments provided by the consignee (if available).

consignee_driver_load

• Type: String
• Description: Indicates if the consignee will load the driver (if available).

consignee_form_ids

• Type: Array of Strings
• Description: List of form IDs associated with the consignee.

consignee_pallets

• Type: String
• Description: Number of pallets handled by the consignee (if available).

consignee_pieces

• Type: String
• Description: Number of pieces handled by the consignee (if available).

consignee_refno

• Type: String
• Description: Reference number provided by the consignee (if available).

consignee_status

• Type: String
• Description: Status of the consignee (e.g., "available").

consignee_type

• Type: String
• Description: Type of consignee (e.g., "dropoff").

consignee_volume

• Type: String
• Description: Volume of goods handled by the consignee (if available).

consignee_weight

• Type: String
• Description: Weight of goods handled by the consignee (if available).

delivery_early_date

• Type: DateTime
• Description: Earliest date for delivery (if available).

delivery_late_date

• Type: DateTime
• Description: Latest date for delivery (if available).

loaded_miles

• Type: String
• Description: Loaded miles for the dispatch (if available).

order_pieces

• Type: String
• Description: Number of pieces in the order (if available).

order_volume

• Type: String
• Description: Volume of the order (if available).

order_weight

• Type: String
• Description: Weight of the order (if available).

pickup_early_date

• Type: DateTime
• Description: Earliest date for pickup (if available).

pickup_late_date

• Type: DateTime
• Description: Latest date for pickup (if available).

pickup_number

• Type: Integer
• Description: Pickup number for the dispatch (if available).

product

• Type: String
• Description: Product being shipped (if available).

shipper_bill_of_lading

• Type: String
• Description: Bill of lading number provided by the shipper (if available).

shipper_comments

• Type: String
• Description: Comments provided by the shipper (if available).

shipper_driver_load

• Type: String
• Description: Indicates if the shipper will load the driver (if available).

shipper_form_ids

• Type: Array of Strings
• Description: List of form IDs associated with the shipper.

shipper_pallets

• Type: String
• Description: Number of pallets handled by the shipper (if available).

shipper_pieces

• Type: String
• Description: Number of pieces handled by the shipper (if available).

shipper_status

• Type: String
• Description: Status of the shipper (e.g., "available").

shipper_type

• Type: String
• Description: Type of shipper (e.g., "pickup").

shipper_volume

• Type: String
• Description: Volume of goods handled by the shipper (if available).

shipper_weight

• Type: String
• Description: Weight of goods handled by the shipper (if available).

status

• Type: String
• Description: Overall status of the dispatch (e.g., "planned").

status_updated_at

• Type: DateTime
• Description: Date and time when the status was last updated.

temperature_max

• Type: String
• Description: Maximum temperature for the dispatch (if available).

temperature_min

• Type: String
• Description: Minimum temperature for the dispatch (if available).

trailer

• Type: String
• Description: Trailer information (if available).

consignee_form_entry_ids

• Type: Object
• Description: Entries for consignee forms.

shipper_form_entry_ids

• Type: Object
• Description: Entries for shipper forms.

auto_complete_forms

• Type: Boolean
• Description: Indicates if the forms should be auto-completed.

shipper_dispatch_trip_id

• Type: Integer
• Description: Unique identifier for the shipper's dispatch trip.

consignee_dispatch_trip_id

• Type: Integer
• Description: Unique identifier for the consignee's dispatch trip.

vendor_id

• Type: String
• Description: Vendor identifier associated with the dispatch.

vendor_shipper_id

• Type: String
• Description: Vendor shipper identifier.

vendor_consignee_id

• Type: String
• Description: Vendor consignee identifier.

dispatch_stops

• Type: Array of Objects
• Description: List of stops associated with the dispatch.

dispatch_stop

• Type: Object
• Description: Information about a specific stop within a dispatch.

id (dispatch_stop)

• Type: Integer
• Description: Unique identifier for the dispatch stop.

bill_of_lading

• Type: String
• Description: Bill of lading number for the dispatch stop (if available).

comments

• Type: String
• Description: Comments for the dispatch stop (if available).

dispatch_location_id

• Type: Integer
• Description: Unique identifier for the dispatch location associated with the stop.

driver_load

• Type: String
• Description: Indicates if the driver will load at this stop (if available).

early_date

• Type: DateTime
• Description: Earliest date for the stop (if available).

form_ids

• Type: Array of Strings
• Description: List of form IDs associated with the stop.

late_date

• Type: DateTime
• Description: Latest date for the stop (if available).

number

• Type: Integer
• Description: Stop number in the sequence.

pallets_in

• Type: String
• Description: Number of pallets received at this stop (if available).

pallets_out

• Type: String
• Description: Number of pallets delivered at this stop (if available).

pieces

• Type: String
• Description: Number of pieces handled at this stop (if available).

status (dispatch_stop)

• Type: String
• Description: Status of the dispatch stop (e.g., "available").

type

• Type: String
• Description: Type of stop (e.g., "delivery").

volume

• Type: String
• Description: Volume of goods handled at this stop (if available).

weight

• Type: String
• Description: Weight of goods handled at this stop (if available).

form_entry_ids

• Type: Object
• Description: Entries for the forms associated with the stop.

dispatch_trip_id

• Type: Integer
• Description: Unique identifier for the dispatch trip associated with the stop.

vendor_id (dispatch_stop)

• Type: String
• Description: Vendor identifier associated with the dispatch stop.

vendor_dispatch_location_id

• Type: String
• Description: Vendor's dispatch location identifier for the stop.

dispatch_trips

• Type: Array of Objects
• Description: List of trips associated with the dispatch.

dispatch_trip

• Type: Object
• Description: Information about a specific trip within a dispatch.

id (dispatch_trip)

• Type: Integer
• Description: Unique identifier for the dispatch trip.

status (dispatch_trip)

• Type: String
• Description: Status of the dispatch trip (e.g., "not_started").

status_updated_at (dispatch_trip)

• Type: DateTime
• Description: Date and time when the status of the trip was last updated (if available).

vendor_id (dispatch_trip)

• Type: String
• Description: Vendor identifier associated with the dispatch trip.

driver_id

• Type: Integer
• Description: Unique identifier for the driver associated with the trip.

vehicle_id

• Type: Integer
• Description: Unique identifier for the vehicle associated with the trip.

vendor_shipper_dispatch_location_id

• Type: String
• Description: Vendor's dispatch location identifier for the shipper.

vendor_consignee_dispatch_location_id

• Type: String
• Description: Vendor's dispatch location identifier for the consignee.