LoadRouteStop

A stop on the load's route. expectedArrivalWindowStart and expectedArrivalWindowEnd are the only fields whose requirement depends on the load's status: they are optional while the load is a DRAFT, and required on every stop once the load reaches CUSTOMER_CONFIRMED or a later lifecycle status. See Load Status Validation.

address
Type: object
required
Properties: 8
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
actualArrivalTime
- Type: Format: date-time
  
  Actual arrival time in UTC, or with a specific timezone offset
actualCompletionTime
- Type: Format: date-time
  
  Actual completion time in UTC, or with a specific timezone offset
customData
Type: nullable

Optional client-specific metadata for this stop. 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 2,000 characters.

Use this field to attach stop-specific references such as pickup numbers, BOL numbers, or PO numbers to individual stops rather than flattening them into load-level customData.

On update, sending this field replaces the stored value for that stop. Because routes are replaced wholesale on every write, omitting customData from a stop clears it to null. Send null explicitly to clear a previously stored value.

Properties: 1
expectedArrivalWindowEnd
- Type: Format: date-time
  
  Expected arrival window end time in UTC, or with a specified timezone offset. Optional at DRAFT; required once the load reaches CUSTOMER_CONFIRMED or later.
expectedArrivalWindowStart
- Type: Format: date-time
  
  Expected arrival window start time in UTC, or with a specific timezone offset. Optional at DRAFT; required once the load reaches CUSTOMER_CONFIRMED or later. Must be at or before expectedArrivalWindowEnd whenever both are present.
expectedDropWindowEnd
- Type: Format: date-time
  
  Expected window end time for drop trailers in UTC, or with a specific timezone offset
expectedDropWindowStart
- Type: Format: 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.
facilityCode
Type: string | null

Identifier of the facility where the stop takes place, matching the facility's external ID in your TMS. Stored as provided and not checked against a known facility, so an unrecognized code is accepted rather than rejected.
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.
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: Format: 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.
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.

LoadReferenceNumberName

StopCustomData