--- title: "VehicleRequest" url: "https://stage-api-docs.centraldispatch.com/apis/stage-listing-api-2-0-0/versions/6459c118-c2b9-484e-816d-5657457559e4/schemas/VehicleRequest" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-listing-api-2-0-0/versions/6459c118-c2b9-484e-816d-5657457559e4.md # VehicleRequest Details of a vehicle. ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Listing API version: 2.0.0 servers: - url: https://marketplace-api.centraldispatch.com description: Production server components: schemas: Currency: enum: - USD type: string description: The currency of the monetary field. This list is not exhaustive and additional values may be added at any time. default: USD example: USD ShippingSpecsRequest: type: object properties: height: type: number description: The height of the vehicle. If the value is not sent it will be completed based on the vehicle information if available. format: double default: 0 nullable: true example: 58 width: type: number description: The width of the vehicle. format: double default: 0 nullable: true example: 62 length: type: number description: The length of the vehicle. format: double default: 0 nullable: true example: 143 weight: type: number description: The weight of the vehicle. format: double default: 0 nullable: true example: 2246 description: Details of the shipping specifications of a vehicle. nullable: true VehicleAttributeRequest: type: object properties: vehicleAttributeType: enum: - DAMAGE - FEATURE type: string description: The value of the vehicle attribute. This list is not exhaustive and additional values may be added at any time. default: FEATURE nullable: true example: DAMAGE vehicleAttributeName: enum: - CAB_AND_CHASSIS - CONVERTIBLE - CREW_CAB - DOES_NOT_ROLL - DOES_NOT_RUN - DOES_NOT_STEER - DUAL_REAR_WHEEL - EXTENDED_CAB - EXTENDED_LENGTH - FLAT_BED - FLAT_TIRE - FRAME_DAMAGE - IS_4X2 - IS_4X4 - LADDER_RACK - LEFT_KIT - LONG_BED - NO_KEYS - NO_TIRES - OTHER_INOP - OTHER_INOP_NOTES - OVERSIZE_TIRES - OVERSIZED_UNIT - RAISED_ROOF - REGULAR_CAB - SHORT_BED - SINGLE_REAR_WHEEL - STANDARD_LENGTH - TOOLBOX - UTILITY_BODY type: string description: The name of the vehicle attribute. This list is not exhaustive and additional values may be added at any time. default: OVERSIZED_UNIT nullable: true example: FLAT_BED value: maxLength: 200 type: string description: The value of the vehicle attribute. nullable: true example: "true" description: Details of a vehicle attribute. VehicleRequest: type: object properties: vehicleId: type: string description: "The system assigned UUID of the vehicle.\r \r - **POST (Create)**: Read-only. Do not include a client-supplied value — the system generates this on creation.\r - **PUT (Update)**: Required only if you are updating an existing vehicle — supply the `vehicleId` of the vehicle you intend to update. Omit it to add a new vehicle to the listing.\r \r ⚠️ Important: If `vehicleId` is omitted on a PUT request for a vehicle you intended to update, the system cannot match the request to an existing vehicle and will treat it as a new vehicle creation. This will count against your vehicle quota." format: uuid externalVehicleId: maxLength: 50 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 pickupStopNumber: type: integer description: The stop number where the vehicle will be picked up. format: int32 example: 1 dropoffStopNumber: type: integer description: The sequential stop number where the vehicle will be delivered. Must be greater than `pickupStopNumber`. format: int32 example: 2 vin: maxLength: 50 type: string description: The vehicle identification number (VIN). Required if `year`, `make` and `model` are null. nullable: true example: KL8CH6SA6NC001234 year: type: integer description: The 4 digit year of the vehicle. Required if `vin` is null. format: int32 example: 2022 make: maxLength: 50 type: string description: The manufacturer's make of the vehicle. Required if `vin` is null. nullable: true example: Chevrolet model: maxLength: 50 type: string description: The manufacturer's model of the vehicle. Required if `vin` is null. nullable: true example: Spark trim: maxLength: 100 type: string description: The manufacturer's trim of the vehicle. nullable: true example: LS vehicleType: enum: - ATV - BOAT - CAR - HEAVY_EQUIPMENT - LARGE_YACHT - MOTORCYCLE - OTHER - PICKUP - RV - SUV - TRAVEL_TRAILER - VAN 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. default: OTHER nullable: true example: CAR vehicleTypeOther: maxLength: 100 type: string description: The description of the vehicle type. Will default to `Other` when null and `vehicleType` is `OTHER`. nullable: true example: Golf Cart color: maxLength: 100 type: string description: The color of the vehicle. nullable: true example: Red licensePlate: maxLength: 20 type: string description: The license plate of the vehicle. nullable: true example: B314PIE licensePlateState: maxLength: 2 type: string description: The two-letter state abbreviation of the vehicle's license plate. nullable: true example: CA lotNumber: maxLength: 50 type: string description: The lot number of the vehicle. nullable: true example: LOT789 isInoperable: type: boolean description: Indicates whether the vehicle is inoperable. default: false example: false tariff: type: number description: The tariff on the vehicle. format: double example: 1030.5 tariffCurrency: $ref: "#/components/schemas/Currency" additionalInfo: maxLength: 500 type: string description: Additional information. nullable: true example: The vehicle is in the back of the lot behind the big tree. oversized: type: boolean description: Indicates whether the load is oversized. default: false example: false shippingSpecs: $ref: "#/components/schemas/ShippingSpecsRequest" vehicleAttributes: type: array items: $ref: "#/components/schemas/VehicleAttributeRequest" description: A collection of vehicle attributes. nullable: true noKeys: type: boolean description: Indicates whether the vehicle has no keys. default: false example: true noTires: type: boolean description: Indicates whether the vehicle has no tires. default: false example: false flatTire: type: boolean description: Indicates whether the vehicle has a flat tire. default: false example: true frameDamage: type: boolean description: Indicates whether the vehicle has frame damage. default: false example: false doesNotRun: type: boolean description: Indicates whether the vehicle does not run. default: false example: true doesNotSteer: type: boolean description: Indicates whether the vehicle does not steer. default: false example: false doesNotRoll: type: boolean description: Indicates whether the vehicle does not roll. default: false example: false inOpNotes: maxLength: 200 type: string description: Notes about the inoperable condition of the vehicle. nullable: true example: Vehicle does not start. description: Details of a vehicle. ```