DraftSlaRequest
objectDetails of the service level agreement of a draft listing.
How many days the customer has to pick up/deliver. The format is ISO 8601 duration format P{duration in days}D where the number of days comes from when the listing becomes available. For example, P2D means 2 days. This sets the deadline for completing the transport.
Example:P2D
Which time zone to use for SLA calculations. For example, -5.00 represents Eastern Time and +0.00 represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.
Default:00:00:00
Example:-7:00
The time of day the “business day” ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by includeCurrentDayAfterRollOver.
Match pattern:^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$
Default:00:00:00
Example:19:00:00
Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.
Example with 5:30 PM rollover:
When true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.
When false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.
Example:true
DraftSlaResponse
objectDetails of the service level agreement of a draft listing.
How many days the customer has to pick up/deliver. The format is ISO 8601 duration format P{duration in days}D where the number of days comes from when the listing becomes available. For example, P2D means 2 days. This sets the deadline for completing the transport.
Example:P2D
Which time zone to use for SLA calculations. For example, -5.00 represents Eastern Time and +0.00 represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.
Example:-7:00
The time of day the “business day” ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by includeCurrentDayAfterRollOver.
Match pattern:^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$
Example:19:00:00
Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.
Example with 5:30 PM rollover:
When true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.
When false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.
Example:true
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.