DraftStopRequest
objectDetails of a stop on a draft listing.
The system assigned UUID of the stop. Read-only on create (POST). Required on update (PUT).
The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.
Example:1
The name of the stop.
<= 200 characters
Example:ABC Cars lot
The street address.
<= 100 characters
Example:345 W Elm St.
Additional street address line.
<= 100 characters
Example:2nd Floor
The city.
<= 50 characters
Example:Anaheim
The state.
Example:CA
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
<= 20 characters
Example:92802
The country code. US or CA.
<= 2 characters
Example:US
The primary phone number of the contact.
<= 50 characters
Example:949-555-1323
An additional phone number of the contact.
<= 50 characters
Example:949-555-2434
An additional phone number of the contact.
<= 50 characters
Example:949-555-3545
The ID of the site.
Example:ABC
The name of the contact.
<= 100 characters
Example:Mickey Smith
The primary phone number of the contact.
<= 50 characters
Example:949-555-1323
The cell phone number of the contact.
<= 50 characters
Example:949-555-1212
The buyer reference number.
<= 70 characters
Example:12345
The metro area of the stop.
<= 150 characters
Example:Orange County
Indicates whether the stop requires driver to have a Transportation Worker Identification Credential (TWIC). A TWIC is a credential required by the Maritime Transportation Security Act for carriers to access some locations. If you are not sure if a TWIC is needed, please contact the location.
Default:false
Example:true
Details of the geographic coordinates of a stop on a draft listing.
Show Child Parameters
The facility type of the stop. This list is not exhaustive and additional values may be added at any time.
Allowed values:UnspecifiedAirportRentalCenterAuctionAuctionSatelliteLotCommercialBusinessCorporateOfficePlantCrossDockSatelliteStagingLotDealershipImpoundMarshallingYardMilitaryBaseMobileAuctionPortRailYardReconFacilityRentalCarRetailSiteRepoResidenceServiceCenterConsumerMovesTerminalOtherMechanicShopWarehouseParkingLot
Default:Unspecified
Example:Dealership
The email address of the contact. Must be a valid email address format.
Example:mickey@snoogle.com
DraftStopResponse
objectDetails of a stop on a draft listing.
The system assigned UUID of the stop.
Example:4e2efc84-6add-435c-9f12-8b19e3e5ba21
The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.
Example:1
The name of the stop.
Example:ABC Cars lot
The street address.
Example:345 W Elm St.
Additional street address line.
Example:2nd Floor
The city.
Example:Anaheim
The state.
Example:CA
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
The country code. US or CA.
Example:US
The distance to the next stop in miles.
Example:267
The primary phone number of the contact.
Example:949-555-1323
An additional phone number of the contact.
Example:949-555-2434
An additional phone number of the contact.
Example:949-555-3545
The ID of the site.
Example:ABC
The name of the contact.
Example:Mickey Smith
The primary phone number of the contact.
Example:949-555-1323
The cell phone number of the contact.
Example:949-555-1212
The email address of the contact. Must be a valid email address format.
Example:mickey@snoogle.com
The metro area of the stop.
Example:Orange County
The facility type of the stop. This list is not exhaustive and additional values may be added at any time.
Allowed values:UnspecifiedAirportRentalCenterAuctionAuctionSatelliteLotCommercialBusinessCorporateOfficePlantCrossDockSatelliteStagingLotDealershipImpoundMarshallingYardMilitaryBaseMobileAuctionPortRailYardReconFacilityRentalCarRetailSiteRepoResidenceServiceCenterConsumerMovesTerminalOtherMechanicShopWarehouseParkingLot
Example:Dealership
Details of the geographic coordinates of a stop on a draft listing.
Show Child Parameters
Indicates whether the stop requires driver to have a Transportation Worker Identification Credential (TWIC). A TWIC is a credential required by the Maritime Transportation Security Act for carriers to access some locations. If you are not sure if a TWIC is needed, please contact the location.
Example:true
The buyer reference number.
Example:12345
DraftVehicleRequest
objectDetails of a vehicle on a draft listing.
The system assigned UUID of the vehicle.
- POST (Create): Read-only. Do not include a client-supplied value — the system generates this on creation.
- PUT (Update): Required only if you are updating an existing vehicle — supply the
vehicleIdof the vehicle you intend to update. Omit it to add a new vehicle to the listing.
⚠️ 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.
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.
<= 50 characters
Example:EXT123456
The stop number where the vehicle will be picked up.
Example:1
The sequential stop number where the vehicle will be delivered. Must be greater than pickupStopNumber.
Example:2
The vehicle identification number (VIN). Required if year, make and model are null.
<= 50 characters
Example:KL8CH6SA6NC001234
The 4 digit year of the vehicle. Required if vin is null.
Example:2022
The manufacturer’s make of the vehicle. Required if vin is null.
<= 50 characters
Example:Chevrolet
The manufacturer’s model of the vehicle. Required if vin is null.
<= 50 characters
Example:Spark
The manufacturer’s trim of the vehicle.
<= 100 characters
Example:LS
The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time.
Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEOTHERPICKUPRVSUVTRAVEL_TRAILERVAN
Default:OTHER
Example:CAR
The description of the vehicle type. Will default to Other when null and vehicleType is OTHER.
<= 100 characters
Example:Golf Cart
The color of the vehicle.
<= 100 characters
Example:Red
The license plate of the vehicle.
<= 20 characters
Example:B314PIE
The two-letter state abbreviation of the vehicle’s license plate.
<= 2 characters
Example:CA
The lot number of the vehicle.
<= 50 characters
Example:LOT789
Indicates whether the vehicle is inoperable.
Default:false
The tariff on the vehicle.
Example:1030.5
The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.
Allowed values:USD
Default:USD
Example:USD
Additional information.
<= 500 characters
Example:The vehicle is in the back of the lot behind the big tree.
Indicates whether the load is oversized.
Default:false
Details of the shipping specifications of a vehicle.
Show Child Parameters
Details of a vehicle attribute.
Show Child Parameters
Indicates whether the vehicle has no keys.
Default:false
Example:true
Indicates whether the vehicle has no tires.
Default:false
Indicates whether the vehicle has a flat tire.
Default:false
Example:true
Indicates whether the vehicle has frame damage.
Default:false
Indicates whether the vehicle does not run.
Default:false
Example:true
Indicates whether the vehicle does not steer.
Default:false
Indicates whether the vehicle does not roll.
Default:false
Notes about the inoperable condition of the vehicle.
<= 200 characters
Example:Vehicle does not start.
DraftVehicleResponse
objectDetails of a vehicle on a draft listing.
The ID of the vehicle.
Example:b331c130-e89b-12d3-a456-426614174000
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.
Example:EXT123456
The stop number where the vehicle will be picked up.
Example:1
The sequential stop number where the vehicle will be delivered.
Example:2
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 trim of the vehicle.
Example:LS
The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time.
Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEOTHERPICKUPRVSUVTRAVEL_TRAILERVAN
The description of the vehicle type.
Example:CAR
The color of the vehicle.
Example:Red
The license plate of the vehicle.
Example:B314PIE
The two-letter state abbreviation of the vehicle’s license plate.
Example:CA
The lot number of the vehicle.
Example:LOT789
Indicates whether the vehicle is inoperable.
The tariff on the vehicle.
Example:1030.5
The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.
Allowed values:USD
Default:USD
Example:USD
Additional information.
Example:The vehicle is in the back of the lot behind the big tree.
Indicates whether the load is oversized.
Details of the shipping specifications of a vehicle.
Show Child Parameters
Details of a vehicle attribute.
Show Child Parameters
Indicates whether the vehicle has no keys.
Example:true
Indicates whether the vehicle has no tires.
Indicates whether the vehicle has a flat tire.
Example:true
Indicates whether the vehicle has frame damage.
Indicates whether the vehicle does not run.
Example:true
Indicates whether the vehicle does not steer.
Indicates whether the vehicle does not roll.
Notes about the inoperable condition of the vehicle.
Example:Vehicle does not start.
Error
objectDetails of an error or issue.
The code used for the issue.
Example:resource.issue_type
A detailed message.
Example:The issue happened because something is wrong.
The property to which the issue is associated.
Example:person
Additional properties related to the issue.
Example:{"firstName":"D0nn@","lastName":"Sm!th"}