LoadDraftPayload

Load draft payload containing all information needed to create a load in the TMS.

loadDraftId
Type: string
required

Stable identifier for this load draft, assigned by Augment. Present on every load draft delivery and used to correlate the draft with subsequent updates.
customerInformation
Type: object

Shipper and billing information.

Properties: 7
documentDates
Type: array of string

ISO 8601 date strings associated with documents on the load (e.g. BOL date, delivery date)
loadDetails
Type: object

Commodity and cargo details. The fields on this object describe the load as a whole. When the source supplies per-line detail, cargoItems carries it and these top-level fields act as the summary for the load. Augment passes both through exactly as supplied and does not derive or reconcile them, so do not assume the summary equals the sum of cargoItems.

Properties: 11
loadRequirements
Type: object

Equipment and service requirements.

Properties: 6
rates
Type: object

Pricing information for the load.

Properties: 5
referenceNumbers
Type: object

Customer reference numbers associated with the load.

Properties: 11
stops
Type: array of object

Ordered list of pickup and delivery stops on the load.

Properties: 18