API Reference
Log In

List company dispatch records (v3)

get
https://api.gomotive.com/v3/dispatches

Purpose: Use this API to fetch a list of all the dispatch records for your organisation.

Response Parameters

dispatch

  • Type: Object
  • Description: Details of a dispatch, including stops and trips associated with it.

id

  • Type: Integer
  • Description: The unique identifier for the dispatch.

additional_drops

  • Type: String
  • Description: Additional drop locations, if any.

additional_pickups

  • Type: String
  • Description: Additional pickup locations, if any.

loaded_miles

  • Type: Integer
  • Description: The loaded miles for the dispatch.

order_pieces

  • Type: Integer
  • Description: Number of order pieces.

order_volume

  • Type: Integer
  • Description: Volume of the order.

order_weight

  • Type: Integer
  • Description: Weight of the order.

product

  • Type: String
  • Description: Product details associated with the dispatch.

pickup_number

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

status

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

status_updated_at

  • Type: String
  • Description: The timestamp of the last status update.

temperature_max

  • Type: Float
  • Description: Maximum temperature for the dispatch, if applicable.

temperature_min

  • Type: Float
  • Description: Minimum temperature for the dispatch, if applicable.

trailer

  • Type: String
  • Description: Trailer information associated with the dispatch.

auto_complete_forms

  • Type: Boolean
  • Description: Indicates if forms are auto-completed.

consignee_refno

  • Type: String
  • Description: Reference number for the consignee.

custom_field1

  • Type: String
  • Description: Custom field for additional information.

vendor_id

  • Type: String
  • Description: The unique identifier for the vendor associated with the dispatch.

dispatch_stops

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

id

  • Type: Integer
  • Description: The unique identifier for the stop.

bill_of_lading

  • Type: String
  • Description: Bill of lading information.

comments

  • Type: String
  • Description: Additional comments for the stop.

dispatch_location_id

  • Type: Integer
  • Description: The unique identifier for the dispatch location.

driver_load

  • Type: String
  • Description: Driver load information.

early_date

  • Type: String
  • Description: The earliest date and time for the stop.

form_ids

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

late_date

  • Type: String
  • Description: The latest date and time for the stop.

number

  • Type: Integer
  • Description: The sequence number of the stop in the dispatch.

pallets_in

  • Type: Integer
  • Description: Number of pallets in.

pallets_out

  • Type: Integer
  • Description: Number of pallets out.

pieces

  • Type: Integer
  • Description: Number of pieces associated with the stop.

status

  • Type: String
  • Description: The current status of the stop (e.g., "available").

type

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

volume

  • Type: Float
  • Description: Volume of goods at the stop.

weight

  • Type: Float
  • Description: Weight of goods at the stop.

form_entry_ids

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

dispatch_trip_id

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

custom_field1

  • Type: String
  • Description: Custom field for additional information.

vendor_id

  • Type: String
  • Description: The unique identifier for the vendor associated with the stop.

vendor_dispatch_location_id

  • Type: String
  • Description: The unique identifier for the vendor dispatch location.

dispatch_trips

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

id

  • Type: Integer
  • Description: The unique identifier for the dispatch trip.

status

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

status_updated_at

  • Type: String (DateTime)
  • Description: The timestamp of the last status update for the dispatch trip.

loaded_miles

  • Type: Integer
  • Description: Loaded miles for the dispatch trip.

vendor_id

  • Type: String
  • Description: The unique identifier for the vendor associated with the dispatch trip.

driver_id

  • Type: Integer
  • Description: The unique identifier for the driver associated with the dispatch trip.

vehicle_id

  • Type: Integer
  • Description: The unique identifier for the vehicle associated with the dispatch trip.
Query Params
ids[]
array of int32s

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

ids[]
vendor_ids
array of strings

Specify one or more vendor IDs for filter the search.

vendor_ids
driver_ids[]
array of int32s

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

driver_ids[]
vehicle_ids[]
array of int32s

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

vehicle_ids[]
statuses
array of strings

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

statuses
boolean

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

date

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

date

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

int32
Defaults to 25

Denotes the number of records shown per page.

int32
Defaults to 1

Denotes the current page number.

Response

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago