StopUpdateCallbackResponse

  • brokerageLoadInternalId
    Type: string | null
    required

    Optional internal load ID in the TMS. Use loadNumber as the main ID. Will be null if not provided.

  • loadNumber
    Type: string
    required

    The unique identifier for the load

  • stopUpdate
    Type: object · StopUpdate
    required
    • arrivalTime
      required
      • 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.

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