RouteStop

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

    • city
      Type: string

      City name

    • company
      Type: string | null

      Company name

    • country
      Type: string

      Country code (2-letter ISO)

    • name
      Type: string | null

      Location name

    • postalCode
      Type: string | null

      Postal or ZIP code

    • stateOrProvince
      Type: string

      State or province code

    • street1
      Type: string | null

      Street address line 1

    • street2
      Type: string | null

      Street address line 2

  • 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