LoadShipment

  • loadShipmentRef
    Type: string
    required

    Unique identifier for the load shipment.

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

  • customer
    Type: object · Customer
    • name
      Type: string
      required
    • customerId
      Type: string
  • items
    Type: array object[] · LoadItem[]
    • quantity
      Type: integer
      required

      Required if item is provided

    • totalWeightLbs
      Type: number
      required

      Required if item is provided

    • deliverySequence
      Type: integer

      Integer numbers.

    • density
      Type: number
    • description
      Type: string

      Commodity description for this item. Augment's AI agent uses this value verbatim when speaking with carriers.

    • freightClass
      Type: stringenum
      values
      • 50
      • 55
      • 60
      • 65
      • 70
    • heightInches
      Type: integer

      Integer numbers.

    • lengthInches
      Type: integer

      Integer numbers.

    • nmfc
      Type: string
    • packageType
      enum
      values
      • BOX
      • BUNDLE
      • CARTON
      • CRATE
      • DRUM
    • pickupSequence
      Type: integer

      Integer numbers.

    • widthInches
      Type: integer

      Integer numbers.

  • loadShipmentInternalRef
    Type: string

    Optional internal load shipment ID in the TMS. Use loadShipmentRef as the main ID.

  • maxTemperatureF
    Type: number

    Maximum temperature requirement in Fahrenheit

  • minTemperatureF
    Type: number

    Minimum temperature requirement in Fahrenheit

  • notes
    Type: array object[]
    • author
      Type: string
      required

      Author of the note

    • text
      Type: string
      required

      Content of the note

    • timestamp
      Type: stringFormat: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • referenceNumbers
    Type: array object[]
    • name
      enum
      required
      values
      • BILLED_DATE
      • CONSIGNEE_NUMBER
      • DAT_POSTING_ID
      • PICKUP_NUMBER
      • PO_NUMBER
    • value
      Type: string
      required
  • route
    • address
      Type: object
      required
    • expectedArrivalWindowEnd
      Type: string · InputDateTimeUtcFormat: date-time
      required

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

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

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

    • loadSequence
      Type: integer
      required

      The sequence number of the stop in overall load route.

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

    • scheduleType
      enum
      deprecated

      DEPRECATED: This field is deprecated. Please use schedulingType and handlingType instead.

      Schedule type for the stop.

      • APPOINTMENT indicates the stop has a scheduled appointment time.
      • FIRST_COME_FIRST_SERVE indicates the stop accepts arrivals on a first-come-first-serve basis.
      • DROP_TRAILER indicates the location supports drop-trailer operations.
      • LIVE indicates live loading or unloading where the driver stays with the trailer.
      values
      • APPOINTMENT
      • FIRST_COME_FIRST_SERVE
      • DROP_TRAILER
      • LIVE
    • 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
  • service
    enum

    Service type for the load

    values
    • HOTSHOT
    • PARTIAL
    • STANDARD
    • TIME_CRITICAL
    • VOLUME
  • shipmentRef
    Type: string
  • status
    • Type: string · LoadStatusenum

      Status of the load shipment

      values
      • DRAFT
      • CUSTOMER_CONFIRMED
      • COVERED
      • DISPATCHED
      • AT_PICKUP