UpdateDispatchRequest
objectDetails of a dispatch.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
The identifier of the order that created the dispatch in the shipper system managed by the user.
Example:ORD-2023-0001
An identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a record (e.g. order, shipment, dispatch) in their local TMS.
Example:RND10 CHEV
Details of the dispatch price.
Show Child Parameters
Details of a stop.
Show Child Parameters
Details of a vehicle.
Show Child Parameters
Details of additional information.
Show Child Parameters
The balance amount that will be due after the COD/COP payment is applied.
>= 0
Example:300
The currency of balanceAmount.
Default:USD
Example:USD
The payment method with which the balance due payment will be paid. Required if balanceAmount is greater than 0.
Allowed values:CASHCERTIFIED_FUNDSCOMPANY_CHECKCOMCHEKTCH
Example:CASH
The terms for beginning balance payment. Required if balanceAmount is greater than 0.
Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL
Example:PICKUP
The time frame when the balance payment is due. Required if balanceAmount is greater than 0.
Allowed values:IMMEDIATELYTWO_BUSINESS_DAYS_QUICK_PAYFIVE_BUSINESS_DAYSTEN_BUSINESS_DAYSFIFTEEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYS
Example:IMMEDIATELY
The cash on delivery (COD) or cash on pick up (COP) amount due.
>= 0
Example:200
The currency of codAmount.
Default:USD
Example:USD
The location that COD/COP payment is due. Required if codAmount is greater than 0.
Allowed values:PICKUPDELIVERY
Example:PICKUP
The method for the COD/COP payment. Required if codAmount is greater than 0.
Allowed values:CHECKCASH_CERTIFIED_FUNDS
Example:CASH_CERTIFIED_FUNDS
Displayed in Central Dispatch website/app as “Load-Specific Terms”, these are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.
Real Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
Rules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.
Note: The original instructions value must be sent in any update request. If a different value is provided, the update will be rejected with status code 422 Unprocessable Entity.
Example:Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.
Rules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.
Note: The original preDispatchNotes value must be sent in any update request. If a different value is provided, the update will be rejected with status code 422 Unprocessable Entity.
Example:In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you.
Displayed in Central Dispatch website/app as “Transport Special Instructions”, these are specific guidelines or details for the safe and efficient pick up, delivery, or transportation of a load. This may contain sensitive data and is not available prior to acceptance of terms by a carrier.
Rules: This information is visible only to the assigned carrier after the load is dispatched and remains editable at any time.
Example:You will need special clearance to get in the lot. Call Jean at 303-999-1212.
Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver’s identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).
Default:false
Example:true
VehicleAttributeRequest
objectDetails of a vehicle attribute.
The type of the vehicle attribute. Casing must be as listed (lowercase).
Allowed values:featuredamage
Example:damage
The name of the vehicle attribute. Casing must be as listed (camelCase).
Allowed values:oversizedUnitconvertibleflatBedregularCabcrewCabextendedCabtoolBoxladderRackleftKitshortBedlongBedis4x4is4x2singleRearWheeldualRearWheelraisedRoofextendedLengthutilityBodycabAndChassisstandardLengthoversizeTireshasKeysnoTiresflatTireframeDamagedoesNotRundoesNotSteerdoesNotRollotherInopotherInopNotesisTWIC
Example:hasKeys
The value of the vehicle attribute. True or false.
VehicleAttributeResponse
objectDetails of a vehicle attribute.
The ID of the shipment description vehicle attribute.
Example:157a16f0-503d-4256-ba60-a4876e8eb9bb
The ID of the shipment description vehicle details.
Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b
The type of the vehicle attribute.
Allowed values:featuredamage
Example:damage
The name of the vehicle attribute.
Allowed values:oversizedUnitconvertibleflatBedregularCabcrewCabextendedCabtoolBoxladderRackleftKitshortBedlongBedis4x4is4x2singleRearWheeldualRearWheelraisedRoofextendedLengthutilityBodycabAndChassisstandardLengthoversizeTireshasKeysnoTiresflatTireframeDamagedoesNotRundoesNotSteerdoesNotRollotherInopotherInopNotesisTWIC
Example:hasKeys
The value of the vehicle attribute.
Example:true
VehicleDateChangeResponse
objectDetails of a vehicle date change.
The type of date.
Allowed values:ESTIMATED_PICKUPACTUAL_PICKUPESTIMATED_DROPOFFACTUAL_DROPOFFSHIPPER_REQUESTED_PICKUPSHIPPER_REQUESTED_DROPOFFCARRIER_ESTIMATED_PICKUPCARRIER_ESTIMATED_DROPOFF
Example:ESTIMATED_PICKUP
The date before the change, in UTC/ISO 8601 format.
Example:2025-08-15T00:00:00.000Z
The date after the change, in UTC/ISO 8601 format.
Example:2025-09-30T00:00:00.000Z
The ID of the date change reason.
Example:da1e0000-e89b-12d3-a456-426614174000
Additional notes regarding the date change.
Example:Weather delay.
The date and time the change was made, in UTC/ISO 8601 format.
Example:2024-09-10T00:00:00Z
VehicleDetailResponse
objectDetails of a vehicle.
Details of a vehicle attribute.
Show Child Parameters
The ID of the shipment description.
Example:519e0000-e89b-12d3-a456-426614174000
The ID of the shipment description vehicle details.
Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b
The vehicle identification number (VIN).
Example:KL8CH6SA6NC001234
The 4 digit year of the vehicle.
Example:2022
The manufacturer’s make of the vehicle.
Example:Chevrolet
The manufacturer’s model of the vehicle.
Example:Spark
The manufacturer’s sub-model of the vehicle.
Example:ACTIV
The manufacturer’s trim of the vehicle.
Example:LS
The type of vehicle e.g. CAR, TRUCK.
Example:CAR
The description of the vehicle type.
Example:CAR
The color of the vehicle.
Example:Red
The weight of the vehicle.
Example:2246
The units of weight and decodedWeight.
Example:lbs
The decoded weight of the vehicle.
Example:2246
The size of the vehicle.
Example:MEDIUM
The length of the vehicle.
Example:143
The units of length.
Default:inches
Example:inches
The decoded length of the vehicle in inches.
Example:143
The width of the vehicle.
Example:62
The units of width.
Default:inches
Example:62
The decoded width of the vehicle in inches.
Example:62
The height of the vehicle.
Example:58
The units of height.
Default:inches
Example:inches
The decoded height of the vehicle in inches.
Example:58
The license plate of the vehicle.
Example:B314PIE
The two-letter state abbreviation of the vehicle’s license plate.
Example:CA
The tariff on the vehicle.
Example:1030.50
The lot number of the vehicle.
Example:LOT789
Additional information.
Example:The vehicle is in the back of the lot behind the big tree.
Indicates whether the vehicle is inoperable.
The person who reported the vehicle details.
Example:d71b5750-e89b-12d3-a456-426614174000
The decoded type of the vehicle.
Example:CAR
The type of fuel.
Example:Gas