Fulfillment API

VehicleAttributeRequest

object

Details of a vehicle attribute.

typestring

The type of the vehicle attribute. Casing must be as listed (lowercase). This list is not exhaustive and additional values may be added at any time.

Allowed values:featuredamage

Example:damage

namestring

The name of the vehicle attribute. Casing must be as listed (camelCase). This list is not exhaustive and additional values may be added at any time.

Allowed values:oversizedUnitconvertibleflatBedregularCabcrewCabextendedCabtoolBoxladderRackleftKitshortBedlongBedis4x4is4x2singleRearWheeldualRearWheelraisedRoofextendedLengthutilityBodycabAndChassisstandardLengthoversizeTireshasKeysnoTiresflatTireframeDamagedoesNotRundoesNotSteerdoesNotRollotherInopotherInopNotesisTWIC

Example:hasKeys

valueboolean

The value of the vehicle attribute. True or false.

Example

VehicleAttributeResponse

object

Details of a vehicle attribute.

shipmentDescriptionVehicleAttributeIdstring(uuid)

The ID of the shipment description vehicle attribute.

Example:157a16f0-503d-4256-ba60-a4876e8eb9bb

shipmentDescriptionVehicleDetailsIdstring(uuid)

The ID of the shipment description vehicle details.

Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b

vehicleAttributeTypestring

The type of the vehicle attribute. This list is not exhaustive and additional values may be added at any time.

Allowed values:featuredamage

Example:damage

attributeNamestring

The name of the vehicle attribute. This list is not exhaustive and additional values may be added at any time.

Allowed values:oversizedUnitconvertibleflatBedregularCabcrewCabextendedCabtoolBoxladderRackleftKitshortBedlongBedis4x4is4x2singleRearWheeldualRearWheelraisedRoofextendedLengthutilityBodycabAndChassisstandardLengthoversizeTireshasKeysnoTiresflatTireframeDamagedoesNotRundoesNotSteerdoesNotRollotherInopotherInopNotesisTWIC

Example:hasKeys

valuestring

The value of the vehicle attribute.

Example:true

Example

VehicleDateChangeResponse

object

Details of a vehicle date change.

dateTypestring

The type of date. This list is not exhaustive and additional values may be added at any time.

Allowed values:ESTIMATED_PICKUPACTUAL_PICKUPESTIMATED_DROPOFFACTUAL_DROPOFFSHIPPER_REQUESTED_PICKUPSHIPPER_REQUESTED_DROPOFFCARRIER_ESTIMATED_PICKUPCARRIER_ESTIMATED_DROPOFF

Example:ESTIMATED_PICKUP

priorDatestring(date-time)

The date before the change, in UTC/ISO 8601 format.

Example:2025-08-15T00:00:00.000Z

newDatestring(date-time)

The date after the change, in UTC/ISO 8601 format.

Example:2025-09-30T00:00:00.000Z

dateChangeReasonIdstring

The ID of the date change reason.

Example:da1e0000-e89b-12d3-a456-426614174000

notesstring

Additional notes regarding the date change.

Example:Weather delay.

dateChangedUtcstring(date-time)

The date and time the change was made, in UTC/ISO 8601 format.

Example:2024-09-10T00:00:00Z

Example

VehicleDetailResponse

object

Details of a vehicle.

vehicleAttributesarray[object]

Details of a vehicle attribute.

Show Child Parameters
shipmentDescriptionVehicleIdstring(uuid)

The ID of the shipment description.

Example:519e0000-e89b-12d3-a456-426614174000

shipmentDescriptionVehicleDetailsIdstring(uuid)

The ID of the shipment description vehicle details.

Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b

vinstring

The vehicle identification number (VIN).

Example:KL8CH6SA6NC001234

yearinteger(int32)

The 4 digit year of the vehicle.

Example:2022

makestring

The manufacturer’s make of the vehicle.

Example:Chevrolet

modelstring

The manufacturer’s model of the vehicle.

Example:Spark

subModelstring

The manufacturer’s sub-model of the vehicle.

Example:ACTIV

trimstring

The manufacturer’s trim of the vehicle.

Example:LS

vehicleTypestring

The type of vehicle e.g. CAR, PICKUP, SUV.

Example:CAR

vehicleTypeDescriptionstring

The description of the vehicle type.

Example:CAR

colorstring

The color of the vehicle.

Example:Red

weightinteger(int32)

The weight of the vehicle.

Example:2246

weightUnitsstring

The units of weight and decodedWeight.

Example:lbs

decodedWeightinteger(int32)

The decoded weight of the vehicle.

Example:2246

sizestring

The size of the vehicle.

Example:MEDIUM

lengthinteger(int32)

The length of the vehicle.

Example:143

lengthUnitsstring

The units of length.

Default:inches

Example:inches

decodedLengthinteger(int32)

The decoded length of the vehicle in inches.

Example:143

widthinteger(int32)

The width of the vehicle.

Example:62

widthUnitsstring

The units of width.

Default:inches

Example:62

decodedWidthinteger(int32)

The decoded width of the vehicle in inches.

Example:62

heightinteger(int32)

The height of the vehicle.

Example:58

heightUnitsstring

The units of height.

Default:inches

Example:inches

decodedHeightinteger(int32)

The decoded height of the vehicle in inches.

Example:58

licensePlatestring

The license plate of the vehicle.

Example:B314PIE

licensePlateStatestring

The two-letter state abbreviation of the vehicle’s license plate.

Example:CA

tariffnumber(double)

The tariff on the vehicle.

Example:1030.5

lotNumberstring

The lot number of the vehicle.

Example:LOT789

additionalInformationstring

Additional information.

Example:The vehicle is in the back of the lot behind the big tree.

isInOperableboolean

Indicates whether the vehicle is inoperable.

reportedBystring

The person who reported the vehicle details.

Example:d71b5750-e89b-12d3-a456-426614174000

decodedVehicleTypestring

The decoded type of the vehicle.

Example:CAR

fuelTypestring

The type of fuel.

Example:Gas

Example

VehicleLocationResponse

object

Details of a vehicle’s location.

hrefstring

The fully qualified URL of the dispatch.

Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000

vehicleIdstring(uuid)

The ID of the vehicle.

Example:b331c130-e89b-12d3-a456-426614174000

dispatchIdstring(uuid)

The ID of the dispatch.

Example:d159acc0-e89b-12d3-a456-426614174000

userIdstring(uuid)

The Central Dispatch user ID.

Example:d71b5750-e89b-12d3-a456-426614174000

vehicleTrackingDeviceIdstring

The vehicle tracking device ID.

Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b

eventType

The event type. This list is not exhaustive and additional values may be added at any time.

Allowed values:PICKED_UPIN_TRANSITDELIVERED

Example:IN_TRANSIT

lastVehicleLocationIdstring(uuid)

The location ID of the vehicle’s last location.

Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9

latitudenumber(double)

The latitude of the location.

Example:33.81228788622535

longitudenumber(double)

The longitude of the location.

Example:-117.91836265987132

locationDateUtcstring(date-time)

The date and time of the vehicle’s last location, in UTC/ISO 8601 format.

Example:2024-10-15T00:00:00Z

Example