--- title: "VehicleRequest" url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/schemas/VehicleRequest" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md # VehicleRequest Details of a vehicle. ## 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: VehicleAttributeRequest: type: object properties: type: enum: - feature - damage type: string description: 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. example: damage name: 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. Casing must be as listed (camelCase). This list is not exhaustive and additional values may be added at any time. example: hasKeys value: type: boolean description: The value of the vehicle attribute. True or false. description: Details of a vehicle attribute. VehicleRequest: type: object properties: vehicleAttributes: type: array items: $ref: "#/components/schemas/VehicleAttributeRequest" description: A collection of vehicle attributes. nullable: true vehicleId: type: string description: The ID of the vehicle. A UUID will be assigned if not sent. format: uuid example: b331c130-e89b-12d3-a456-426614174000 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 vin: type: string description: The vehicle identification number (VIN). Required if `year`, `make`, `model` values are not supplied. nullable: true example: KL8CH6SA6NC001234 distance: type: number description: The total travel distance. format: double nullable: true example: 267 distanceUnits: type: string description: The units of `distance`. default: MILES nullable: true example: MILES pickUpLocationId: type: integer description: The stop number (the sequential number of the stop along the route) of the pick up location. format: int32 example: 1 dropOffLocationId: type: integer description: The stop number (the sequential number of the stop along the route) of the delivery location. format: int32 example: 2 carrierPrice: type: number description: The price to be paid to the carrier for completing the delivery of this vehicle (reference only). format: double example: 500 carrierPriceUnits: type: string description: The currency of `carrierPrice`. default: USD nullable: true example: USD type: enum: - ATV - BOAT - CAR - HEAVY_EQUIPMENT - LARGE_YACHT - MOTORCYCLE - PICKUP - RV - SUV - TRAVEL_TRAILER - VAN - OTHER type: string description: The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time. example: CAR size: enum: - SMALL - MEDIUM - LARGE - XLARGE - WIDELOAD - OVERSIZE - OTHER type: string description: The size of the vehicle. This list is not exhaustive and additional values may be added at any time. nullable: true example: MEDIUM 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-07-15T00:00:00.000Z shipperRequestedDropOffDate: 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-08-15T00:00:00.000Z color: type: string description: The color of the vehicle. nullable: true example: Red isInOperable: type: boolean description: Indicates whether the vehicle is inoperable. example: false isEnclosed: type: boolean description: Indicates whether the transport is enclosed. default: false example: true year: type: integer description: The 4 digit year of the vehicle. Required if `vin` is not supplied. format: int32 nullable: true example: 2022 make: type: string description: The manufacturer's make of the vehicle. Required if `vin` is not supplied. nullable: true example: Chevrolet model: type: string description: The manufacturer's model of the vehicle. Required if `vin` is not supplied. nullable: true example: Spark subModel: type: string description: The manufacturer's sub-model of the vehicle. nullable: true example: ACTIV weight: type: integer description: The weight of the vehicle. format: int32 example: 2246 weightUnits: type: string description: The units of `weight`. default: LBS nullable: true example: lbs inspectionType: enum: - STANDARD - ART type: string description: The type of inspection the vehicle requires. This list is not exhaustive and additional values may be added at any time. nullable: true example: ART isDriveAway: type: boolean description: Indicates whether the vehicle is a drive-away. default: false example: true 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 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. pickUpDateType: enum: - ESTIMATED - EXACTLY - NO_EARLIER_THAN - NO_LATER_THAN type: string description: The type of pick up date. This list is not exhaustive and additional values may be added at any time. default: ESTIMATED nullable: true example: NO_EARLIER_THAN dropOffDateType: enum: - ESTIMATED - EXACTLY - NO_EARLIER_THAN - NO_LATER_THAN type: string description: The type of delivery date. This list is not exhaustive and additional values may be added at any time. default: ESTIMATED nullable: true example: ESTIMATED tariff: type: number description: The tariff on the vehicle. format: double nullable: true example: 1030.5 trim: type: string description: The manufacturer's trim of the vehicle. nullable: true example: LS fuelType: type: string description: The type of fuel. nullable: true example: Gas height: type: integer description: The height of the vehicle. format: int32 nullable: true example: 58 width: type: integer description: The width of the vehicle. format: int32 nullable: true example: 62 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 widthUnits: type: string description: The units of `width`. default: inches nullable: true example: "62" heightUnits: type: string description: The units of `height`. default: inches nullable: true example: inches 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 nullable: true example: true inspectionAcknowledged: type: boolean description: Indicates whether the require inspection requirement was acknoowledged. default: false nullable: true example: true description: Details of a vehicle. ```