LoadDraftPayload
Load draft payload containing all information needed to create a load in the TMS.
- customerType: object
Information Shipper and billing information.
- addressType: object
Customer billing address
- contactType: object
Customer contact information
- divisionType: string
Term Division or billing term associated with the customer
- internalType: string
Notes Internal operational notes
- nameType: string
Customer name
- notesType: string
Customer-facing notes
- shipperType: string
Id Shipper identifier
- documentType: array string[]
Dates ISO 8601 date strings associated with documents on the load (e.g. BOL date, delivery date)
- loadType: object
Details Commodity and cargo details.
- cargoType: object
Characteristics - commodityType: string
Commodity description (max 40 characters)
- descriptionType: string
Extended commodity description
- dimensionsType: object
Shipment dimensions
- handlingType: object
Unit Handling unit information (e.g. pallets)
- packagingType: object
Unit Packaging unit information (e.g. cartons inside pallets)
- valueType: object
Amount Declared value of the shipment
- weightType: object
Total shipment weight
- loadType: object
Requirements Equipment and service requirements.
- additionalType: array string[]
Required Services Additional services required for the load (e.g. liftgate, team driver)
- equipmentType: object
Equipment requirements
- loadType: stringenum
Type Rate type / load type
values- S
P O T - C
O N T R A C T - D
E D I C A T E D - P
R O J E C T
- modeType: stringenum
Transportation mode
values- F
T L - L
T L - D
R A Y A G E
- tarpType: string | null
Size Tarp size required, if applicable
- temperatureType: object | null
Requirement Temperature control requirements
- ratesType: object
Pricing information for the load.
- accessorialsType: array object[]
Accessorial charges
- baseType: string
Rate Base rate in dollars
- collectionType: stringenum
Method Payment collection method
values- Pre
Paid - Collect
- Third
Party - Collect
On Delivery
- lineType: string
Haul Line haul rate in dollars
- totalType: string
Rate Total rate in dollars
- referenceType: object
Numbers Customer reference numbers associated with the load.
- bolType: string
Number Bill of lading number
- customerType: string
Load Number Customer load number
- customerType: string
Reference Number Customer reference number
- driverType: string
Number Driver number
- othersType: array object[]
Additional reference numbers not covered by named fields
- poType: string
Number Purchase order number
- proType: string
Number PRO number
- releaseType: string
Number Release number
- shipmentType: string
Number Shipment number
- tractorType: string
Number Tractor number
- trailerType: string
Number Trailer number
- stopsType: array object[]
Ordered list of pickup and delivery stops on the load.
- appointmentType: object
Time Scheduled appointment window
- appointmentType: stringenum
Type Scheduling method for the stop
values- A
P P O I N T M E N T - F
I R S T _ C O M E _ F I R S T _ S E R V E
- driverType: string
Instructions Special instructions for the driver at this stop
- dropType: object
Time Drop time window for drop-trailer stops
- facilityType: object
Address Address of the facility
- facilityType: string
Code Facility code, if known
- facilityType: object
Contact Contact information for the facility
- facilityType: string
Name Name of the facility
- handlingType: stringenum
Type Load/unload handling type for the stop
values- L
I V E - D
R O P _ T R A I L E R
- internalType: string
Notes Internal operational notes for the stop
- notesType: string
Customer-facing notes for the stop
- operatingType: string
Hours General operating hours for the facility
- receivingType: string
Hours Receiving hours for the facility
- referenceType: string
Number Stop-level reference number
- shippingType: string
Hours Shipping hours for the facility
- stopType: integer
Number 1-based stop sequence number
- stopType: stringenum
Type Whether the stop is a pickup or delivery
values- P
I C K U P - D
E L I V E R Y
- timezoneType: string
IANA timezone identifier for the facility's local time