UpdatePaymentStatusRequest
objectDetails of dispatch payment status.
The status of the payment of the dispatch. Values: UNPAID, PARTIALLY_PAID, FULLY_PAID. Set to null to remove status.
Example:PARTIALLY_PAID
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.5
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