--- title: "VehicleResponse" url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/schemas/VehicleResponse" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md # VehicleResponse Dispatch vehicle details. ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Fulfillment API version: 1.0.0 servers: - url: https://fulfillment-api.centraldispatch.com description: Production server components: schemas: VehicleDetailResponse: type: object properties: vehicleAttributes: type: array items: $ref: "#/components/schemas/VehicleAttributeResponse" description: A collection of vehicle attributes. nullable: true shipmentDescriptionVehicleId: type: string description: The ID of the shipment description. format: uuid nullable: true example: 519e0000-e89b-12d3-a456-426614174000 shipmentDescriptionVehicleDetailsId: type: string description: The ID of the shipment description vehicle details. format: uuid nullable: true example: 2539f4b4-d3d6-45db-8df3-7ba768caba9b vin: type: string description: The vehicle identification number (VIN). nullable: true example: KL8CH6SA6NC001234 year: type: integer description: The 4 digit year of the vehicle. format: int32 nullable: true example: 2022 make: type: string description: The manufacturer's make of the vehicle. nullable: true example: Chevrolet model: type: string description: The manufacturer's model of the vehicle. nullable: true example: Spark subModel: type: string description: The manufacturer's sub-model of the vehicle. nullable: true example: ACTIV trim: type: string description: The manufacturer's trim of the vehicle. nullable: true example: LS vehicleType: type: string description: The type of vehicle e.g. CAR, PICKUP, SUV. nullable: true example: CAR vehicleTypeDescription: type: string description: The description of the vehicle type. nullable: true example: CAR color: type: string description: The color of the vehicle. nullable: true example: Red weight: type: integer description: The weight of the vehicle. format: int32 nullable: true example: 2246 weightUnits: type: string description: The units of `weight` and `decodedWeight`. nullable: true example: lbs decodedWeight: type: integer description: The decoded weight of the vehicle. format: int32 nullable: true example: 2246 size: type: string description: The size of the vehicle. nullable: true example: MEDIUM length: type: integer description: The length of the vehicle. format: int32 nullable: true example: 143 lengthUnits: type: string description: The units of `length`. default: inches nullable: true example: inches decodedLength: type: integer description: The decoded length of the vehicle in inches. format: int32 nullable: true example: 143 width: type: integer description: The width of the vehicle. format: int32 nullable: true example: 62 widthUnits: type: string description: The units of `width`. default: inches nullable: true example: "62" decodedWidth: type: integer description: The decoded width of the vehicle in inches. format: int32 nullable: true example: 62 height: type: integer description: The height of the vehicle. format: int32 nullable: true example: 58 heightUnits: type: string description: The units of `height`. default: inches nullable: true example: inches decodedHeight: type: integer description: The decoded height of the vehicle in inches. format: int32 nullable: true example: 58 licensePlate: type: string description: The license plate of the vehicle. nullable: true example: B314PIE licensePlateState: type: string description: The two-letter state abbreviation of the vehicle's license plate. nullable: true example: CA tariff: type: number description: The tariff on the vehicle. format: double nullable: true example: 1030.5 lotNumber: type: string description: The lot number of the vehicle. nullable: true example: LOT789 additionalInformation: type: string description: Additional information. nullable: true example: The vehicle is in the back of the lot behind the big tree. isInOperable: type: boolean description: Indicates whether the vehicle is inoperable. example: false reportedBy: type: string description: The person who reported the vehicle details. nullable: true example: d71b5750-e89b-12d3-a456-426614174000 decodedVehicleType: type: string description: The decoded type of the vehicle. nullable: true example: CAR fuelType: type: string description: The type of fuel. nullable: true example: Gas description: Details of a vehicle. VehicleDateChangeResponse: type: object properties: dateType: enum: - ESTIMATED_PICKUP - ACTUAL_PICKUP - ESTIMATED_DROPOFF - ACTUAL_DROPOFF - SHIPPER_REQUESTED_PICKUP - SHIPPER_REQUESTED_DROPOFF - CARRIER_ESTIMATED_PICKUP - CARRIER_ESTIMATED_DROPOFF type: string description: The type of date. This list is not exhaustive and additional values may be added at any time. nullable: true example: ESTIMATED_PICKUP priorDate: type: string description: The date before the change, in UTC/ISO 8601 format. format: date-time nullable: true example: 2025-08-15T00:00:00.000Z newDate: type: string description: The date after the change, in UTC/ISO 8601 format. format: date-time nullable: true example: 2025-09-30T00:00:00.000Z dateChangeReasonId: type: string description: The ID of the date change reason. nullable: true example: da1e0000-e89b-12d3-a456-426614174000 notes: type: string description: Additional notes regarding the date change. nullable: true example: Weather delay. dateChangedUtc: type: string description: The date and time the change was made, in UTC/ISO 8601 format. format: date-time example: 2024-09-10T00:00:00Z description: Details of a vehicle date change. VehicleStatusChangeResponse: type: object properties: dateUtc: type: string description: The date and time of the status change, in UTC/ISO 8601 format. format: date-time example: 2024-10-31T00:00:00Z status: type: string description: The status of the vehicle. nullable: true example: PENDING_PICKUP description: Details of a vehicle status change. VehicleAttributeResponse: type: object properties: shipmentDescriptionVehicleAttributeId: type: string description: The ID of the shipment description vehicle attribute. format: uuid nullable: true example: 157a16f0-503d-4256-ba60-a4876e8eb9bb shipmentDescriptionVehicleDetailsId: type: string description: The ID of the shipment description vehicle details. format: uuid nullable: true example: 2539f4b4-d3d6-45db-8df3-7ba768caba9b vehicleAttributeType: enum: - feature - damage type: string description: The type of the vehicle attribute. This list is not exhaustive and additional values may be added at any time. nullable: true example: damage attributeName: enum: - oversizedUnit - convertible - flatBed - regularCab - crewCab - extendedCab - toolBox - ladderRack - leftKit - shortBed - longBed - is4x4 - is4x2 - singleRearWheel - dualRearWheel - raisedRoof - extendedLength - utilityBody - cabAndChassis - standardLength - oversizeTires - hasKeys - noTires - flatTire - frameDamage - doesNotRun - doesNotSteer - doesNotRoll - otherInop - otherInopNotes - isTWIC type: string description: The name of the vehicle attribute. This list is not exhaustive and additional values may be added at any time. nullable: true example: hasKeys value: type: string description: The value of the vehicle attribute. nullable: true example: "true" description: Details of a vehicle attribute. VehicleResponse: type: object properties: vehicleDetails: type: array items: $ref: "#/components/schemas/VehicleDetailResponse" description: A collection of vehicle details. nullable: true dispatchVehicleDateChanges: type: array items: $ref: "#/components/schemas/VehicleDateChangeResponse" description: A collection of dispatch vehicle date changes. nullable: true dispatchVehicleStatusChanges: type: array items: $ref: "#/components/schemas/VehicleStatusChangeResponse" description: A collection of dispatch vehicle status changes. nullable: true shipmentDescriptionVehicleId: type: string description: The ID of the shipment description. format: uuid example: b331c130-e89b-12d3-a456-426614174000 pickupStopId: type: string description: The system assigned UUID of the stop. format: uuid example: 4e2efc84-6add-435c-9f12-8b19e3e5ba21 dropoffStopId: type: string description: The stop number (the sequential number of the stop along the route) of the delivery location. format: uuid example: fa110000-e89b-12d3-a456-426614174000 isEnclosed: type: boolean description: Indicates whether the transport is enclosed. example: true createdDateUtc: type: string description: The date and time the dispatch was created, in UTC/ISO 8601 format. format: date-time nullable: true example: 2024-10-31T00:00:00Z lastUpdatedDateUtc: type: string description: The date and time the dispatch was last updated, in UTC/ISO 8601 format. format: date-time nullable: true example: 2024-10-15T00:00:00Z lastUpdatedBy: type: string description: The Central Dispatch user ID of the user who last updated the dispatch. format: uuid nullable: true example: d71b5750-e89b-12d3-a456-426614174000 dispatchVehicleId: type: string description: The ID of the vehicle. format: uuid example: b331c130-e89b-12d3-a456-426614174000 dispatchId: type: string description: The ID of the dispatch. format: uuid example: d159acc0-e89b-12d3-a456-426614174000 externalId: type: string description: An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website. nullable: true example: RND10 CHEV vehicleId: type: string description: The ID of the vehicle. format: uuid example: b331c130-e89b-12d3-a456-426614174000 vin: type: string description: The vehicle identification number (VIN). nullable: true example: KL8CH6SA6NC001234 estimatedPickupDate: type: string description: The estimated pick up date, in UTC/ISO 8601 format. format: date-time example: 2025-11-05T00:00:00.000Z estimatedDropOffDate: type: string description: The estimated delivery date, in UTC/ISO 8601 format. format: date-time example: 2025-07-15T00:00:00.000Z actualPickupDate: type: string description: The actual pick up date and time, in UTC/ISO 8601 format. format: date-time nullable: true example: 2025-11-05T00:00:00.000Z actualDropOffDate: type: string description: The actual delivery date and time, in UTC/ISO 8601 format. format: date-time nullable: true example: 2025-08-15T00:00:00.000Z carrierEstimatedPickupDate: type: string description: The date the carrier estimates the vehicle will be picked up, in UTC/ISO 8601 format. format: date-time example: 2025-11-05T00:00:00.000Z carrierEstimatedDropOffDate: type: string description: The date the carrier estimates the vehicle will be dropped off, in UTC/ISO 8601 format. format: date-time example: 2025-07-15T00:00:00.000Z shipperRequestedPickupDate: type: string description: The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format. format: date-time example: 2025-11-05T00:00:00.000Z shipperRequestedDropOffDate: type: string description: The date the shipper would like the vehicle to be dropped off, in UTC/ISO 8601 format. format: date-time example: 2025-07-15T00:00:00.000Z status: type: string description: The status of the vehicle. nullable: true example: PENDING_PICKUP carrierPrice: type: number description: The price to be paid to the carrier for completing the delivery of this vehicle (reference only). format: double carrierPriceCurrency: type: string description: The currency of `carrierPrice`. nullable: true example: USD distance: type: number description: The total travel distance. format: double nullable: true example: 267 distanceUnits: type: string description: The units of `distance`. nullable: true example: MILES externalVehicleId: type: string description: A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record. nullable: true example: EXT123456 needAction: type: boolean description: Indicates whether action is needed. default: false example: false inspectionType: type: string description: The type of inspection the vehicle requires. nullable: true example: ART isDriveAway: type: boolean description: Indicates whether the vehicle is a drive-away. default: false example: true isOversize: type: boolean description: Indicates whether the load is oversized. default: false example: false isWideload: type: boolean description: Indicates whether the load is a wide load. default: false example: false pickUpDateType: type: string description: The type of pick up date. nullable: true example: NO_EARLIER_THAN dropOffDateType: type: string description: The type of delivery date. nullable: true example: ESTIMATED requiresInspection: type: boolean description: Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load. default: false example: true inspectionAcknowledged: type: boolean description: Indicates whether the require inspection requirement was acknoowledged. default: false example: true description: Dispatch vehicle details. ```