StopUpdate

  • status
    enum
    required

    Status code indicating the current state of the load at the stop

    values
    • AT_PICKUP
    • AT_DELIVERY
    • IN_TRANSIT
    • DELIVERED
  • stopSequenceNumber
    Type: integer
    required

    The sequence number of the stop being updated

  • timezone
    Type: string
    required

    IANA timezone (e.g., America/Chicago) of the stop location.

  • accessorials
    Type: array string[] · AccessorialsEnum[]
    • Type: string · AccessorialsEnum

      Accessorial code representing an additional service or requirement for a load. This is not a closed set — new accessorial codes may be added at any time. Values are normalized to UPPER_SNAKE_CASE (e.g., inside delivery → INSIDE_DELIVERY).

  • arrivalTime
    • Type: string · InputDateTimeUtcFormat: date-time

      Arrival time at the stop. May be in UTC with offset, or local time without offset when paired with the timezone field.

  • departureTime
    • Type: string · InputDateTimeUtcFormat: date-time

      Departure time from the stop. In UTC, or with a specific timezone offset.

  • dockDoor
    Type: string
  • notes
    Type: string
  • stopId
    Type: string

    Optional external or system ID of the stop

  • unloadEta
    • Type: string · InputDateTimeUtcFormat: date-time

      Estimated unload completion time. In UTC, or with a specific timezone offset.

  • unloadStartTime
    • Type: string · InputDateTimeUtcFormat: date-time

      Unload start time. May be in UTC with offset, or local time without offset when paired with the timezone field.