RouteStop

A stop in the load route

activityType
Type: "PICKUP" or "DELIVERY"enum
required

Type of activity at this stop
address
Type: object
required

Stop address

Properties: 8
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
customData
Type: nullable

Client-specific metadata for this stop, or null when none is stored.

Properties: 1
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 of "APPOINTMENT" or "FIRST_COME_FIRST_SERVE"enum

Scheduling types for the stop
stopNotes
Type: string | null

Notes for this stop
timezone
Type: string | null

IANA timezone for the stop location