Fetch the team dispatch data (v3)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Purpose: This endpoint returns the complete dispatch object, which includes the co_driver_ids, to support multi-driver assignment.

Response Parameters

dispatches

  • Type: Array of Objects
  • Description: Returns the complete dispatch object, now featuring the co_driver_ids array.

id

  • Type: Integer
  • Description: Unique ID of the dispatch.

order_number

  • Type: String
  • Description: Order number associated with the dispatch.

status

  • Type: String
  • Description: Current status of the dispatch.

dispatch_team_driving_enabled_v3

  • Type: Boolean
  • Description: Indicates whether team driving is enabled for v3 consumers for the dispatch.

dispatch_trips

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

id

  • Type: Integer
  • Description: Unique ID of the dispatch trip.

driver_id

  • Type: Integer
  • Description: ID of the active driver assigned to the trip.

co_drivers

  • Type: Array of Integers
  • Description: List of authorized co-driver IDs assigned to the trip.

vehicle_id

  • Type: Integer
  • Description: ID of the vehicle assigned to the trip.

dispatch_stops

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json