Load

  • loadNumber
    Type: string
    required
  • mode
    enum
    required
    values
    • DRAYAGE
    • FTL
    • LTL
  • route
    Type: array object[] · LoadRouteStop[]
    required
    • address
      Type: object
      required
    • 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.

    • 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
  • status
    enum
    required
    values
    • DRAFT
    • CUSTOMER_CONFIRMED
    • COVERED
    • DISPATCHED
    • AT_PICKUP
  • 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).

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

      Bid expiration time in UTC, or with a specific timezone offset

  • bookedRate
    Type: number

    Booked rate in USD

  • brokerageLoadInternalId
    Type: string

    Optional internal load ID in the TMS. Use loadNumber as the main ID.

  • dimensions
    Type: object

    Optional dimensions object. If provided, all dimension fields are required. All dimensions are in inches.

    • heightInches
      Type: integer
      required

      Required if dimensions object is provided

    • lengthInches
      Type: integer
      required

      Required if dimensions object is provided

    • widthInches
      Type: integer
      required

      Required if dimensions object is provided

  • equipment
    Type: object

    Optional equipment details. If provided, equipmentType is required

    • equipmentType
      enum
      required

      Required if equipment object is provided

      values
      • AUTO_CARRIER
      • B_TRAIN
      • CONTAINER
      • CONTAINER_INSULATED
      • CONTAINER_REFRIGERATED
    • description
      Type: string

      A field suitable for mapping the exact string value that the source system stores for equipment type

    • maxTemperatureF
      Type: number
    • minTemperatureF
      Type: number
  • externalTrackingStatus
    Type: object · ExternalTrackingStatus

    External tracking status information. When updating a load: - If omitted, the existing externalTrackingStatus value is preserved unchanged - If explicitly set to null, the externalTrackingStatus is cleared - If provided with a value, the externalTrackingStatus is updated to that value

    • code
      enum
      required

      Status code indicating the current state of external tracking

      values
      • READY
      • WAITING
      • FAILED
      • COMPLETED
    • message
      Type: string
      required

      Human-readable message describing the current tracking status

    • source
      enum
      required

      The source system or service providing the tracking status

      values
      • MACROPOINT
      • P44
      • OTHER
    • updatedAt
      required
      • Type: string · InputDateTimeUtcFormat: date-time

        The timestamp when the tracking status was last updated in UTC, or with a specific timezone offset

  • isPostedToDAT
    Type: boolean

    Indicates whether the load has been posted to DAT load board

  • items
    Type: array object[] · LoadItem[]

    Optional array of items. If provided, each item must include quantity and totalWeightLbs.

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

  • maximumBulkHeadTemperature
    Type: number

    Maximum bulkhead temperature requirement in Fahrenheit

  • maximumTemperature
    Type: number

    Maximum temperature requirement in Fahrenheit

  • maxRate
    Type: number

    Maximum bid amount in USD

  • minimumBulkHeadTemperature
    Type: number

    Minimum bulkhead temperature requirement in Fahrenheit

  • minimumTemperature
    Type: number

    Minimum temperature requirement in Fahrenheit

  • notes
    Type: array object[] · LoadNote[]

    Operational notes about the load. Use this field to send context about actions taken on the load (e.g. broker instructions, status updates). On update, the provided notes are merged with existing notes.

    • author
      Type: string
      required

      Who created the note (e.g. email address or system name)

    • text
      Type: string
      required

      Note content

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

      When the note was created

  • rateType
    enum
    values
    • CONTRACT
    • DEDICATED
    • PROJECT
    • SPOT
  • referenceNumbers
    Type: array object[]
    • name
      enum
      required
      values
      • BILLED_DATE
      • CONSIGNEE_NUMBER
      • DAT_POSTING_ID
      • PICKUP_NUMBER
      • PO_NUMBER
    • value
      Type: string
      required
  • service
    enum

    Service type for the load

    values
    • HOTSHOT
    • PARTIAL
    • STANDARD
    • TIME_CRITICAL
    • VOLUME
  • shipperRate
    Type: number

    Shipper rate in USD

  • targetRate
    Type: number

    Target rate in USD

  • tarpSize
    Type: string

    Tarp size requirement

  • totalMiles
    Type: number

    Total estimated mileage for the entire route of a load

  • weight
    Type: number

    Total weight in pounds (lbs)