LoadV2Response
Enriched load data including tracking events, reference numbers, notes, customers, and shipment information.
- accessorialsType: array string[]required
List of accessorials for the load
- brokerageType: string
Load Id requiredThe load number (brokerage load ID) - this is your load identifier
- createdType: stringFormat: date-time
At requiredTimestamp when the load was created
- customersType: array object[] · LoadCustomer[]required
Customers associated with the load
Customer associated with the load
- nameType: stringrequired
Customer name
- customerType: string | null
Contact Customer contact information
- customerType: string | null
Id Customer identifier
- isType: boolean
Posted To D A T requiredIndicates whether the load has been posted to DAT load board
- loadType: array object[] · LoadShipment[]
Shipments requiredShipments associated with the load
- loadType: string
Shipment Ref requiredUnique identifier for the load shipment.
- accessorialsType: array string[] · AccessorialsEnum[]
- customerType: object
- itemsType: array object[] · LoadItem[]
- 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[]
- referenceType: array object[]
Numbers - 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
- notesType: array object[]required
Operational notes about the load. Provides context for tracking and operations.
- authorType: string
Author of the note
- textType: string
Content of the note
- timestampType: stringFormat: date-time
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- podType: stringenum
Collection Status requiredPOD collection workflow status
values- N
O T _ S T A R T E D - P
E N D I N G - I
N _ P R O G R E S S - C
O M P L E T E D - F
A I L E D
- referenceType: array object[]
Numbers requiredReference numbers associated with the load
- 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
- routeType: array object[] · RouteStop[]required
Route stops sorted by sequence number ascending
A stop in the load route
- activityType: stringenum
Type requiredType of activity at this stop
values- P
I C K U P - D
E L I V E R Y
- addressType: objectrequired
Stop address
- sequenceType: integer
Number requiredThe sequence number of the stop in the route (1-indexed)
- actualType: string | nullFormat: date-time
Arrival Time Actual arrival time at the stop
- actualType: string | nullFormat: date-time
Departure Time Actual departure time from the stop
- expectedType: string | nullFormat: date-time
Drop Window End Expected drop window end time (for drop trailers)
- expectedType: string | nullFormat: date-time
Drop Window Start Expected drop window start time (for drop trailers)
- expectedType: string | nullFormat: date-time
Stop Window End Expected stop window end time
- expectedType: string | nullFormat: date-time
Stop Window Start Expected stop window start time
- externalType: string | null
Id External ID for the stop (if provided)
- facilityType: string | null
Code Facility code
- mustType: string | nullFormat: date-time
Arrive By Date The date and time by which the carrier must arrive at this stop
- scheduleType: array string[]enum
Types Scheduling types 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
- stopType: string | null
Notes Notes for this stop
- timezoneType: string | null
IANA timezone for the stop location
- 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
- trackingType: array object[] · TrackingEvent[]
Events requiredTracking events for the load
- eventenum
Source requiredvalues- 4
K I T E S - C
A R R I E R _ A P I - H
I G H W A Y - M
A C R O P O I N T - P44
- eventenum
Type requiredvalues- D
E L A Y E D - I
N F O - P
I C K E D _ U P - P
I N G - C
O V E R E D - D
I S P A T C H E D
- event
Utc required- Type: string · InputDateTimeUtcFormat: date-time
Event time in UTC, or with a specific timezone offset
- cityType: string
- dispatcherType: object
Contact information for a person associated with a tracking event.
- driverType: object
Contact information for a person associated with a tracking event.
- latitudeType: number
- longitudeType: number
- next
Eta Utc - Type: string · InputDateTimeUtcFormat: date-time
Next estimated arrival time in UTC, or with a specific timezone offset
- nextType: integer
Sequence Integer numbers.
- notesType: string
- postalType: string
Code - stateType: string
Or Province - temperatureType: number
F
- updatedType: stringFormat: date-time
At requiredTimestamp when the load was last updated
- bidType: array object[]
Custom Values Custom bid values
- nameType: string
- valueType: string
- bidType: string | nullFormat: date-time
Expiration Bid expiration time
- brokerageType: string | null
Load Internal Id Optional internal load ID in the TMS
- commodityType: string | null
Commodity description
- commodityType: array object[] | null · CommodityItem[]
Items List of commodity items
A commodity item on the load
- deliveryType: integer | null
Sequence Sequence number of the delivery stop for this item
- densityType: number | null
- descriptionType: string | null
Description of the commodity
- freightType: string | null
Class - heightType: integer | null
Inches Integer numbers.
- lengthType: integer | null
Inches Integer numbers.
- nmfcType: string | null
- packageType: string | nullenum
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 | null
Sequence Sequence number of the pickup stop for this item
- quantityType: integer
Number of items
- totalType: number | null
Weight Lbs Total weight in pounds
- widthType: integer | null
Inches Integer numbers.
- customerType: string | null
Id Primary customer identifier
- customerType: string | null
Name Primary customer name
- dimensionsType: object | null
Load dimensions
- heightType: integer
Inches Integer numbers.
- lengthType: integer
Inches Integer numbers.
- widthType: integer
Inches Integer numbers.
- equipmentType: string | null
Equipment type
- equipmentType: string | null
Description Free-text equipment description
- external
Tracking Status External tracking status information
- 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
- highType: number | null
Value Amount High value amount in USD
- isType: boolean | null
Posted To Highway Indicates whether the load has been posted to Highway
- lastType: string | nullFormat: date-time
Location Update Timestamp of the last location update
- loadType: string | nullenum
Type Type of load rate
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 - null
- maximumType: object | null
Bulk Head Temperature Maximum bulkhead temperature requirement
- unitType: string
- valueType: number
- maximumType: object | null
Temperature Maximum temperature requirement
- unitType: stringenumvalues
- F
- C
- valueType: number
- maxType: number | null
Rate Maximum bid amount in USD
- minimumType: object | null
Bulk Head Temperature Minimum bulkhead temperature requirement
- unitType: string
- valueType: number
- minimumType: object | null
Temperature Minimum temperature requirement
- unitType: stringenumvalues
- F
- C
- valueType: number
- modeType: string | nullenum
Load transportation mode
values- D
R A Y A G E - F
T L - L
T L - null
- serviceType: string | nullenum
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 - null
- targetType: number | null
Rate Target rate in USD
- tarpType: string | null
Size Tarp size requirement
- totalType: number | null
Carrier Rate Total carrier rate in USD
- totalType: number | null
Miles Total estimated mileage for the entire route
- totalType: number | null
Rate Total rate for the load in USD
- weightType: object | null
Total weight information
- unitType: stringenumvalues
- L
B - K
G
- valueType: number