Load
- loadType: string
Number required - modeenumrequiredvalues
- D
R A Y A G E - F
T L - L
T L
- routeType: array object[] · LoadRouteStop[]required
- addressType: objectrequired
- expected
Arrival Window End required- Type: string · InputDateTimeUtcFormat: date-time
Expected arrival window end time in UTC, or with a specified timezone offset
- expected
Arrival Window Start required- Type: string · InputDateTimeUtcFormat: date-time
Expected arrival window start time in UTC, or with a specific timezone offset
- sequenceType: integerrequired
The sequence number of the stop in the route. Number should start at 1 increase by 1 for the following stop.
- stopenum
Activity requiredvalues- P
I C K U P - D
E L I V E R Y
- actual
Arrival Time - Type: string · InputDateTimeUtcFormat: date-time
Actual arrival time in UTC, or with a specific timezone offset
- actual
Completion Time - Type: string · InputDateTimeUtcFormat: date-time
Actual completion time in UTC, or with a specific timezone offset
- expected
Drop Window End - Type: string · InputDateTimeUtcFormat: date-time
Expected window end time for drop trailers in UTC, or with a specific timezone offset
- expected
Drop Window Start - Type: string · InputDateTimeUtcFormat: date-time
Expected window start time for drop trailers in UTC, or with a specific timezone offset
- externalType: string
Id Optional external ID for the stop. This is used to link the stop to an external system.
- handlingenum
Type Handling type for the stop.
- DT (Drop Trailer) indicates the location supports drop-trailer operations.
- L (Live) indicates live loading or unloading where the driver stays with the trailer.
values- D
T - L
- isType: boolean
Local Time When true, route times are in local time instead of UTC. When this is true, omit the Z suffix or timezone offset from all route time strings. Example: 2017-07-21T17:32:28
- must
Arrive By Date - Type: string · InputDateTimeUtcFormat: date-time
The date and time by which the carrier must arrive at this stop, in UTC or with a specific timezone offset
- notesType: string
Optional notes for the stop.
- schedulingenum
Type Scheduling type for the stop.
- APPT (Appointment) indicates the stop operates on an appointment basis.
- FCFS (First Come First Serve) indicates the stop accepts arrivals on a first-come-first-serve basis.
values- A
P P T - F
C F S
- statusenumrequiredvalues
- 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
- accessorialsType: array string[] · AccessorialsEnum[]
- Type: string · AccessorialsEnum
Accessorial code representing an additional service or requirement for a load. This is not a closed set — new accessorial codes may be added at any time. Values are normalized to UPPER_SNAKE_CASE (e.g.,
inside delivery→INSIDE_DELIVERY).
- bid
Expiration - Type: string · InputDateTimeUtcFormat: 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.
- dimensionsType: object
Optional dimensions object. If provided, all dimension fields are required. All dimensions are in inches.
- heightType: integer
Inches requiredRequired if dimensions object is provided
- lengthType: integer
Inches requiredRequired if dimensions object is provided
- widthType: integer
Inches requiredRequired if dimensions object is provided
- equipmentType: object
Optional equipment details. If provided, equipmentType is required
- equipmentenum
Type requiredRequired if equipment object is provided
values- A
U T O _ C A R R I E R - A
U T O _ T R A N S P O R T - B
_ T R A I N - B
O X _ T R U C K - C
H A S S I S
- descriptionType: string
A field suitable for mapping the exact string value that the source system stores for equipment type
- externalType: object
Tracking Status External 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
- codeenumrequired
Status code indicating the current state of external tracking
values- R
E A D Y - W
A I T I N G - F
A I L E D - C
O M P L E T E D
- messageType: stringrequired
Human-readable message describing the current tracking status
- sourceenumrequired
The source system or service providing the tracking status
values- M
A C R O P O I N T - P44
- O
T H E R
- updated
At required- Type: string · InputDateTimeUtcFormat: date-time
The timestamp when the tracking status was last updated in UTC, or with a specific timezone offset
- 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
- itemsType: array object[] · LoadItem[]
Optional array of items. If provided, each item must include quantity and totalWeightLbs.
- quantityType: integerrequired
Required if item is provided
- totalType: number
Weight Lbs requiredRequired if item is provided
- deliveryType: integer
Sequence Integer numbers.
- densityType: number
- descriptionType: string
Commodity description for this item. Augment's AI agent uses this value verbatim when speaking with carriers.
- freightType: stringenum
Class values- 50
- 55
- 60
- 65
- 70
- heightType: integer
Inches Integer numbers.
- lengthType: integer
Inches Integer numbers.
- nmfcType: string
- packageenum
Type values- B
O X - B
U N D L E - C
A R T O N - C
R A T E - D
R U M
- pickupType: integer
Sequence Integer numbers.
- widthType: integer
Inches Integer numbers.
- 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: array object[] · LoadNote[]
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.
- authorType: stringrequired
Who created the note (e.g. email address or system name)
- textType: stringrequired
Note content
- timestampType: stringFormat: date-timerequired
When the note was created
- rateenum
Type values- C
O N T R A C T - D
E D I C A T E D - P
R O J E C T - S
P O T
- referenceType: array object[]
Numbers - nameenumrequiredvalues
- B
I L L E D _ D A T E - B
O L _ N U M B E R - C
O N S I G N E E _ N U M B E R - D
A T _ P O S T I N G _ I D - P
I C K U P _ N U M B E R
- valueType: stringrequired
- serviceenum
Service type for the load
values- H
O T S H O T - P
A R T I A L - S
T A N D A R D - T
I M E _ C R I T I C A L - V
O L U M E
- 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)