LoadV2Response

Enriched load data including tracking events, reference numbers, notes, customers, and shipment information.

accessorials
Type: array string[]
required

List of accessorials for the load
brokerageLoadId
Type: string
required

The load number (brokerage load ID) - this is your load identifier
createdAt
Type: stringFormat: date-time
required

Timestamp when the load was created
customers
Type: array object[] · LoadCustomer[]
required

Customers associated with the load
Customer associated with the load
- name
  Type: string
  required
  
  Customer name
- customerContact
  Type: string | null
  
  Customer contact information
- customerId
  Type: string | null
  
  Customer identifier
isPostedToDAT
Type: boolean
required

Indicates whether the load has been posted to DAT load board
loadShipments
Type: array object[] · LoadShipment[]
required

Shipments associated with the load
- loadShipmentRef
  Type: string
  required
  
  Unique identifier for the load shipment.
- accessorials
  Type: array string[] · AccessorialsEnum[]
- customer
  Type: object · Customer
- items
  Type: array object[] · LoadItem[]
- loadShipmentInternalRef
  Type: string
  
  Optional internal load shipment ID in the TMS. Use loadShipmentRef as the main ID.
- maxTemperatureF
  Type: number
  
  Maximum temperature requirement in Fahrenheit
- minTemperatureF
  Type: number
  
  Minimum temperature requirement in Fahrenheit
- notes
  Type: array object[]
- referenceNumbers
  Type: array object[]
- route
  address
  Type: object
  required
  expectedArrivalWindowEnd
  Type: string · InputDateTimeUtcFormat: date-time
  required
  
  Expected arrival window end time in UTC, or with a specified timezone offset
  
  expectedArrivalWindowStart
  Type: string · InputDateTimeUtcFormat: date-time
  required
  
  Expected arrival window start time in UTC, or with a specific timezone offset
  
  loadSequence
  Type: integer
  required
  
  The sequence number of the stop in overall load route.
  
  sequence
  Type: integer
  required
  
  The sequence number of the stop in the route. Number should start at 1 increase by 1 for the following stop.
  
  stopActivity
  enum
  required
  values
  PICKUP
  DELIVERY
  actualArrivalTime
  Type: string · InputDateTimeUtcFormat: date-time
  
  Actual arrival time in UTC, or with a specific timezone offset
  
  actualCompletionTime
  Type: string · InputDateTimeUtcFormat: date-time
  
  Actual completion time in UTC, or with a specific timezone offset
  
  expectedDropWindowEnd
  Type: string · InputDateTimeUtcFormat: date-time
  
  Expected window end time for drop trailers in UTC, or with a specific timezone offset
  
  expectedDropWindowStart
  Type: string · InputDateTimeUtcFormat: date-time
  
  Expected window start time for drop trailers in UTC, or with a specific timezone offset
  
  externalId
  Type: string
  
  Optional external ID for the stop. This is used to link the stop to an external system.
  
  handlingType
  enum
  
  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
  DT
  L
  isLocalTime
  Type: boolean
  
  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
  
  mustArriveByDate
  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
  
  notes
  Type: string
  
  Optional notes for the stop.
  
  scheduleType
  enum
  deprecated
  
  DEPRECATED: This field is deprecated. Please use schedulingType and handlingType instead.
  
  Schedule type for the stop.
  
  APPOINTMENT indicates the stop has a scheduled appointment time.
  
  FIRST_COME_FIRST_SERVE indicates the stop accepts arrivals on a first-come-first-serve basis.
  
  DROP_TRAILER indicates the location supports drop-trailer operations.
  
  LIVE indicates live loading or unloading where the driver stays with the trailer.
  
  values
  APPOINTMENT
  FIRST_COME_FIRST_SERVE
  DROP_TRAILER
  LIVE
  schedulingType
  enum
  
  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
  APPT
  FCFS
- service
  enum
  
  Service type for the load
  
  values
  HOTSHOT
  PARTIAL
  STANDARD
  TIME_CRITICAL
  VOLUME
- shipmentRef
  Type: string
- status
  Type: string · LoadStatusenum
  
  Status of the load shipment
  
  values
  DRAFT
  CUSTOMER_CONFIRMED
  COVERED
  DISPATCHED
  AT_PICKUP
notes
Type: array object[]
required

Operational notes about the load. Provides context for tracking and operations.
- author
  Type: string
  
  Author of the note
- text
  Type: string
  
  Content of the note
- timestamp
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
podCollectionStatus
Type: stringenum
required

POD collection workflow status
values
- NOT_STARTED
- PENDING
- IN_PROGRESS
- COMPLETED
- FAILED
referenceNumbers
Type: array object[]
required

Reference numbers associated with the load
- name
  enum
  required
  values
  BILLED_DATE
  CONSIGNEE_NUMBER
  DAT_POSTING_ID
  PICKUP_NUMBER
  PO_NUMBER
- value
  Type: string
  required
route
Type: array object[] · RouteStop[]
required

Route stops sorted by sequence number ascending
A stop in the load route
- activityType
  Type: stringenum
  required
  
  Type of activity at this stop
  
  values
  PICKUP
  DELIVERY
- address
  Type: object
  required
  
  Stop address
- sequenceNumber
  Type: integer
  required
  
  The sequence number of the stop in the route (1-indexed)
- actualArrivalTime
  Type: string | nullFormat: date-time
  
  Actual arrival time at the stop
- actualDepartureTime
  Type: string | nullFormat: date-time
  
  Actual departure time from the stop
- expectedDropWindowEnd
  Type: string | nullFormat: date-time
  
  Expected drop window end time (for drop trailers)
- expectedDropWindowStart
  Type: string | nullFormat: date-time
  
  Expected drop window start time (for drop trailers)
- expectedStopWindowEnd
  Type: string | nullFormat: date-time
  
  Expected stop window end time
- expectedStopWindowStart
  Type: string | nullFormat: date-time
  
  Expected stop window start time
- externalId
  Type: string | null
  
  External ID for the stop (if provided)
- facilityCode
  Type: string | null
  
  Facility code
- mustArriveByDate
  Type: string | nullFormat: date-time
  
  The date and time by which the carrier must arrive at this stop
- scheduleTypes
  Type: array string[]enum
  
  Scheduling types for the stop
  
  values
  APPOINTMENT
  FIRST_COME_FIRST_SERVE
- stopNotes
  Type: string | null
  
  Notes for this stop
- timezone
  Type: string | null
  
  IANA timezone for the stop location
status
enum
required
values
- DRAFT
- CUSTOMER_CONFIRMED
- COVERED
- DISPATCHED
- AT_PICKUP
trackingEvents
Type: array object[] · TrackingEvent[]
required

Tracking events for the load
- eventSource
  enum
  required
  values
  4KITES
  CARRIER_API
  HIGHWAY
  MACROPOINT
  P44
- eventType
  enum
  required
  values
  DELAYED
  INFO
  PICKED_UP
  PING
  COVERED
  DISPATCHED
- eventUtc
  required
  Type: string · InputDateTimeUtcFormat: date-time
  
  Event time in UTC, or with a specific timezone offset
- city
  Type: string
- latitude
  Type: number
- longitude
  Type: number
- nextEtaUtc
  Type: string · InputDateTimeUtcFormat: date-time
  
  Next estimated arrival time in UTC, or with a specific timezone offset
- nextSequence
  Type: integer
  
  Integer numbers.
- notes
  Type: string
- stateOrProvince
  Type: string
- temperatureF
  Type: number
updatedAt
Type: stringFormat: date-time
required

Timestamp when the load was last updated
bidCustomValues
Type: array object[]

Custom bid values
- name
  Type: string
- value
  Type: string
bidExpiration
Type: string | nullFormat: date-time

Bid expiration time
brokerageLoadInternalId
Type: string | null

Optional internal load ID in the TMS
commodity
Type: string | null

Commodity description
commodityItems
Type: array object[] | null · CommodityItem[]

List of commodity items
A commodity item on the load
- deliverySequence
  Type: integer | null
  
  Sequence number of the delivery stop for this item
- density
  Type: number | null
- description
  Type: string | null
  
  Description of the commodity
- freightClass
  Type: string | null
- heightInches
  Type: integer | null
  
  Integer numbers.
- lengthInches
  Type: integer | null
  
  Integer numbers.
- nmfc
  Type: string | null
- packageType
  Type: string | nullenum
  values
  BOX
  BUNDLE
  CARTON
  CRATE
  DRUM
- pickupSequence
  Type: integer | null
  
  Sequence number of the pickup stop for this item
- quantity
  Type: integer
  
  Number of items
- totalWeightLbs
  Type: number | null
  
  Total weight in pounds
- widthInches
  Type: integer | null
  
  Integer numbers.
customerId
Type: string | null

Primary customer identifier
customerName
Type: string | null

Primary customer name
dimensions
Type: object | null

Load dimensions
- heightInches
  Type: integer
  
  Integer numbers.
- lengthInches
  Type: integer
  
  Integer numbers.
- widthInches
  Type: integer
  
  Integer numbers.
equipment
Type: string | null

Equipment type
equipmentDescription
Type: string | null

Free-text equipment description
externalTrackingStatus
External tracking status information
- code
  enum
  required
  
  Status code indicating the current state of external tracking
  
  values
  READY
  WAITING
  FAILED
  COMPLETED
- message
  Type: string
  required
  
  Human-readable message describing the current tracking status
- source
  enum
  required
  
  The source system or service providing the tracking status
  
  values
  MACROPOINT
  P44
  OTHER
- updatedAt
  Type: string · InputDateTimeUtcFormat: date-time
  required
  
  The timestamp when the tracking status was last updated in UTC, or with a specific timezone offset
highValueAmount
Type: number | null

High value amount in USD
isPostedToHighway
Type: boolean | null

Indicates whether the load has been posted to Highway
lastLocationUpdate
Type: string | nullFormat: date-time

Timestamp of the last location update
loadType
Type: string | nullenum

Type of load rate
values
- CONTRACT
- DEDICATED
- PROJECT
- SPOT
- null
maximumBulkHeadTemperature
Type: object | null

Maximum bulkhead temperature requirement
- unit
  Type: string
- value
  Type: number
maximumTemperature
Type: object | null

Maximum temperature requirement
- unit
  Type: stringenum
  values
  F
  C
- value
  Type: number
maxRate
Type: number | null

Maximum bid amount in USD
minimumBulkHeadTemperature
Type: object | null

Minimum bulkhead temperature requirement
- unit
  Type: string
- value
  Type: number
minimumTemperature
Type: object | null

Minimum temperature requirement
- unit
  Type: stringenum
  values
  F
  C
- value
  Type: number
mode
Type: string | nullenum

Load transportation mode
values
- DRAYAGE
- FTL
- LTL
- null
service
Type: string | nullenum

Service type for the load
values
- HOTSHOT
- PARTIAL
- STANDARD
- TIME_CRITICAL
- VOLUME
- null
targetRate
Type: number | null

Target rate in USD
tarpSize
Type: string | null

Tarp size requirement
totalCarrierRate
Type: number | null

Total carrier rate in USD
totalMiles
Type: number | null

Total estimated mileage for the entire route
totalRate
Type: number | null

Total rate for the load in USD
weight
Type: object | null

Total weight information
- unit
  Type: stringenum
  values
  LB
  KG
- value
  Type: number