LoadRequest

  • brokerage
    Type: object
    required
    • contacts
      Type: array object[]
  • load
    Type: object
    required
    • loadNumber
      Type: string
      required
    • mode
      enum
      required
      values
      • DRAYAGE
      • FTL
      • LTL
    • route
      Type: array object[] · LoadRouteStop[]
      required
    • status
      enum
      required
      values
      • DRAFT
      • CUSTOMER_CONFIRMED
      • COVERED
      • DISPATCHED
      • AT_PICKUP
    • accessorials
      Type: array string[] · AccessorialsEnum[]
    • 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.

    • equipment
      Type: object

      Optional equipment details. If provided, equipmentType is required

    • externalTrackingStatus
      Type: object

      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

    • highValueAmount
      Type: number

      High value amount in USD

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

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

    • rateType
      enum
      values
      • CONTRACT
      • DEDICATED
      • PROJECT
      • SPOT
    • referenceNumbers
      Type: array object[]
    • 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)

  • carrier
    Type: object
    • dotNumber
      Type: integer
      required

      Integer numbers.

    • name
      Type: string
      required
    • address
      Type: object

      Carrier address on a load. Optional on the parent object; when present, include every required field below.

    • carrierId
      Type: string
    • contacts
      Type: array object[] · CarrierContact[]

      Optional contact object. If provided, role is required.

    • drivers
      Type: array object[]
    • mcNumber
      Type: integer

      Integer numbers.

    • scac
      Type: string
  • customer
    Type: object
    • name
      Type: string
      required
    • customerId
      Type: string
  • trackingEvents
    Type: array object[] · TrackingEvent[]

    A non-empty array will overwrite all existing tracking events for the Load. Omitting this field or providing an empty array preserves the current tracking events. To append events instead of replacing them, use the POST /v2/loads/tracking endpoint.

    • eventSource
      enum
      required
      values
      • 4KITES
      • CARRIER_API
      • HIGHWAY
      • MACROPOINT
      • P44
    • eventType
      enum
      required
      values
      • DELAYED
      • INFO
      • PICKED_UP
      • PING
      • COVERED
      • DISPATCHED
    • eventUtc
      required
      • Type: string · InputDateTimeUtcFormat: date-time

        Event time in UTC, or with a specific timezone offset

    • city
      Type: string
    • dispatcher
      Type: object

      Contact information for a person associated with a tracking event.

    • driver
      Type: object

      Contact information for a person associated with a tracking event.

    • latitude
      Type: number
    • longitude
      Type: number
    • nextEtaUtc
      • Type: string · InputDateTimeUtcFormat: date-time

        Next estimated arrival time in UTC, or with a specific timezone offset

    • nextSequence
      Type: integer

      Integer numbers.

    • notes
      Type: string
    • postalCode
      Type: string
    • stateOrProvince
      Type: string
    • temperatureF
      Type: number