RateQuoteRequest

One shipment to be priced. mode, rateType, stops, equipment and augmentQuoteId are always sent. The rest is sent when Augment has it, so treat a missing field as unknown rather than as a default.

  • augmentQuoteId
    Type: string
    required

    Augment's id for this quote. Echo it back unchanged. Treat it as an opaque string.

  • equipment
    Type: object
    required

    Equipment needed to move the shipment

    • equipmentType
      Type: string · QuoteEquipmentTypeenum
      required

      A subset of the platform equipment enum, weighted toward specialized and oversize trailers.

      Closed set for this endpoint. The full platform enum runs to over a hundred values and carries aliases for the same trailer, so provider trailer codes should be mapped onto these values, with OTHER sent where nothing fits, rather than a synonym Augment may not map back.

      values
      • DRY_VAN
      • REEFER
      • FLATBED
      • FLATBED_WITH_TARPS
      • FLATBED_OVERDIMENSION
  • mode
    enum
    required

    Transportation mode. Same values as Load.mode.

    values
    • DRAYAGE
    • EXPEDITE
    • FTL
    • LTL
    • PARTIAL
  • rateType
    enum
    required

    The commercial basis of the rate being asked for. Same values as Load.rateType.

    values
    • CONTRACT
    • DEDICATED
    • PROJECT
    • SPOT
  • stops
    Type: array object[] · QuoteStop[] 2…
    required

    The route in sequence. One PICKUP and one DELIVERY is the floor and is enough to return a rate.

    This is an array rather than an origin and destination pair so a third or later stop is visible in the request. You cannot charge a stop-off fee against a lane that doesn't show the stop.

    One stop on the route. A rate request describes a geographic point rather than a facility, so no street address is sent.

    • address
      Type: object
      required

      A geographic point. The field names match LoadRouteStop.address, but only city, stateOrProvince and country are required. Quote requests routinely arrive with no ZIP, and street lines are never sent.

    • sequence
      Type: integer
      min:  
      1
      required

      Position of the stop in the route. Starts at 1 and goes up by 1 for each stop after it.

    • stopActivity
      enum
      required
      values
      • PICKUP
      • DELIVERY
  • accessorials
    Type: array string[] | null · AccessorialsEnum[]

    Accessorial codes Augment already knows the shipment needs, such as TARPS or TWIC. Advisory only. You return the priced accessorials on each rate and are not limited to what's listed here.

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

  • commodity
    Type: string | null

    Free-text description of the freight

  • customerName
    Type: string | null

    The shipper the quote is for, when a customer rate applies

  • dimensions
    Type: object | null

    Overall shipment dimensions in whole inches. Legal width runs to roughly 12 feet; wider than that generally needs escorts.

    • heightInches
      Type: integer

      Overall height in whole inches

    • lengthInches
      Type: integer

      Overall length in whole inches

    • widthInches
      Type: integer

      Overall width in whole inches

  • hazmatUnNumber
    Type: string | null

    UN number for the hazardous material, UN followed by four digits. Sent only when isHazmat is true and the source document carried the number.

  • isHazmat
    Type: boolean | null

    Whether the shipment carries hazardous materials. Missing means unknown, not false.

  • pickupDate
    Type: string | null Format: date

    Requested pickup day

  • tarpSize
    Type: string | null

    Tarp size requirement, when the freight needs tarping

  • totalMiles
    Type: number | null

    Augment's mileage estimate, when it has one. Advisory only: rating should use the provider's own mileage, which is then returned on the response.

  • weight
    Type: object | null

    Total shipment weight. An object rather than a bare number, matching the load contract, so the unit is never guessed.

    • unit
      Type: string enum

      Unit of measure for the weight

      values
      • LB
      • KG
    • value
      Type: number

      Weight amount