LoadRouteStop

  • address
    Type: object
    required
    • city
      Type: string
      required
    • country
      Type: string
      required

      Must be 2-letter ISO country code as listed here: https://www.iban.com/country-codes

    • postalCode
      Type: string
      required
    • stateOrProvince
      Type: string
      required
    • street1
      Type: string
      required
    • company
      Type: string
    • locationName
      Type: string
    • street2
      Type: string
  • expectedArrivalWindowEnd
    required
    • Type: string · InputDateTimeUtcFormat: date-time

      Expected arrival window end time in UTC, or with a specified timezone offset

  • expectedArrivalWindowStart
    required
    • Type: string · InputDateTimeUtcFormat: date-time

      Expected arrival window start time in UTC, or with a specific timezone offset

  • 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.

  • 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