LoadShipment
- loadType: string
Shipment Ref requiredUnique identifier for the load shipment.
- 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).
- customerType: object
- nameType: stringrequired
- customerType: string
Id
- itemsType: array object[] · LoadItem[]
- 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.
- loadType: string
Shipment Internal Ref Optional internal load shipment ID in the TMS. Use loadShipmentRef as the main ID.
- maxType: number
Temperature F Maximum temperature requirement in Fahrenheit
- minType: number
Temperature F Minimum temperature requirement in Fahrenheit
- notesType: array object[]
- authorType: stringrequired
Author of the note
- textType: stringrequired
Content of the note
- timestampType: stringFormat: date-timerequired
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- 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
- route
- addressType: objectrequired
- expected
Arrival Window End required - expected
Arrival Window Start required - loadType: integer
Sequence requiredThe sequence number of the stop in overall load route.
- 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 - actual
Completion Time - expected
Drop Window End - expected
Drop Window Start - 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 - 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
- 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
- shipmentType: string
Ref - status
- Type: string · LoadStatusenum
Status of the load shipment
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