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

    Properties: 1
  • mode
    enum
    required

    Transportation mode. Same values as Load.mode.

    values
    DRAYAGEEXPEDITEFTLLTLPARTIAL
  • rateType
    enum
    required

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

    values
    CONTRACTDEDICATEDPROJECTSPOT
  • stops
    Type: 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.

    Properties: 3
  • accessorials
    Type:

    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.

  • commodity
    Type: string | null

    Free-text description of the freight

  • contacts
    Type:

    People on the quote. Exactly one QUOTE_OWNER is always sent: the rep whose mailbox received the request. QUOTE_REQUESTER is the customer contact who asked, when known.

    Properties: 3
  • customData
    Type: object | null

    Additional fields Augment can reliably parse from the email, agreed with each provider during setup, such as a customer-specific code. Keys and values are defined per provider. Ignore any key you do not use.

    Properties: 1
  • 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.

    Properties: 3
  • email
    Type:

    The email that triggered this quote. When one thread carries several quote requests, this is the message that produced this quote, not the first message in the thread.

    Properties: 9
  • 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.

  • numberTruckloads
    Type: integer | null
    min:  
    1

    Number of truckloads on this lane. Missing means 1. One request covers one lane; several truckloads on the same lane are counted here rather than sent as separate requests.

  • pickupDate
    Type: string | nullFormat: date

    Requested pickup day

  • referenceNumbers
    Type: array of object | null

    Reference numbers the customer put on the request, such as a tender or spot-bid number. Use them to recognize a follow-up on the same request.

    Properties: 2
  • 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.

    Properties: 2
  • wellspaceInches
    Type: integer | null

    Well space needed, in whole inches, for drop-deck freight. A separate field rather than part of dimensions, because it describes the trailer requirement, not the freight.

Previous
Request a rate quote
Next
QuoteStop