Load
- loadType: string
Number required - modeenumrequiredvaluesDRAYAGEEXPEDITEFTLLTLPARTIAL
- Properties: 17routeType:required
- statusenumrequired
The load's lifecycle status. The status determines which fields are required: stop appointment windows are optional at
DRAFTand required on every route stop atCUSTOMER_CONFIRMEDand later. A load with no status set is treated asDRAFT. See Load Status Validation.values- D
R A F T - C
U S T O M E R _ C O N F I R M E D - C
O V E R E D - D
I S P A T C H E D - A
T _ P I C K U P - I
N _ T R A N S I T - A
T _ D E L I V E R Y - D
E L I V E R E D
- D
- accessorialsType:
- bid
Expiration - Type: Format: date-time
Bid expiration time in UTC, or with a specific timezone offset
- bookedType: number
Rate Booked rate in USD
- brokerageType: string
Load Internal Id Optional internal load ID in the TMS. Use loadNumber as the main ID.
- customType: nullable
Data Properties: 1Optional client-specific metadata for the load. Use string keys; each value may be a string, number, boolean, array of JSON-safe values, or a nested object with the same rules. The serialized JSON must not exceed 10,000 characters.
If you want Augie to use values from customData in automated workflows, coordinate the expected keys and meanings with Augment. Your SOPs or workflow instructions may need to be updated so Augie knows when and how to reference those values.
On update, sending this field replaces the stored value. Omitting it preserves the existing value, while sending
nullclears it. - dimensionsType: objectProperties: 3
Optional dimensions object. If provided, all dimension fields are required. All dimensions are in inches.
- equipmentType: objectProperties: 3
Optional equipment details. If provided, equipmentType is required
- externalType:
Tracking Status Properties: 4External tracking status information. When updating a load: - If omitted, the existing externalTrackingStatus value is preserved unchanged - If explicitly set to null, the externalTrackingStatus is cleared - If provided with a value, the externalTrackingStatus is updated to that value
- groupType: string | null
External Id The external identifier used to associate this load with a group. Used during create/update to resolve the internal groupKey.
- highType: number
Value Amount High value amount in USD
- isType: boolean
Posted To D A T Indicates whether the load has been posted to DAT load board. This is required for Augie to search for loads using lane information (pick up and drop off city and state).
- itemsType:Properties: 13
Optional array of items. If provided, each item must include quantity and totalWeightLbs. Use packagingUnit to describe how the item is packaged and handlingUnit to describe how the freight is handled or moved.
- maximumType: number
Bulk Head Temperature Maximum bulkhead temperature requirement in Fahrenheit
- maximumType: number
Temperature Maximum temperature requirement in Fahrenheit
- maxType: number
Rate Maximum bid amount in USD
- minimumType: number
Bulk Head Temperature Minimum bulkhead temperature requirement in Fahrenheit
- minimumType: number
Temperature Minimum temperature requirement in Fahrenheit
- notesType:Properties: 3
Operational notes about the load. Use this field to send context about actions taken on the load (e.g. broker instructions, status updates). On update, the provided notes are merged with existing notes.
- rateenum
Type valuesCONTRACTDEDICATEDPROJECTSPOT - Properties: 2referenceType: array of object
Numbers - serviceenum
Service type for the load
valuesHOTSHOTPARTIALSTANDARDTIME_CRITICALVOLUME - shipperType: number
Rate Shipper rate in USD
- targetType: number
Rate Target rate in USD
- tarpType: string
Size Tarp size requirement
- totalType: number
Miles Total estimated mileage for the entire route of a load
- weightType: number
Total weight in pounds (lbs)