Rate

One rate from one rating source.

linehaul, fuelSurcharge and allInTotal are all required every time. Augment does not add the parts up and does not subtract them out of the total. When they disagree it flags the rate for a person instead of picking a number to trust.

  • allInTotal
    Type: number
    required

    Total rate including linehaul, fuel and any accessorials already rolled in.

  • fuelSurcharge
    Type: number
    required

    Fuel surcharge in dollars, not a percent. Send 0 rather than leaving it out when a rate carries no fuel surcharge.

  • linehaul
    Type: number
    required

    Linehaul amount, before fuel and accessorials

  • source
    Type: string
    required

    The system or model that produced the rate.

    Not a closed set. New rating sources are added over time and Augment tolerates a value it has not seen, so the examples below are not exhaustive. Values should use UPPER_SNAKE_CASE, and a given source's value should remain stable between responses.

    The values are vendor-neutral on purpose: the same field carries a specialized in-house rate, a market rate, or a model added later, without either side reserving vendor-specific names.

  • accessorials
    Type: array object[] · RateAccessorial[]

    The accessorials that apply to this shipment on this rate, with amounts. Send an empty array when none do.

    Augment asks for these per rate instead of keeping its own table, because a table cannot represent a route-dependent charge such as metro tolls, bridge and island fees, or county and city permits, and goes stale silently whenever a charge changes on the provider side.

    One priced accessorial. basis is what lets a flat permit charge and a per-mile oversize charge share one shape.

    • amount
      Type: number
      required

      The amount, read according to basis. A PER_MILE amount is the rate per mile, not the extended total.

    • basis
      Type: string enum
      required

      How amount applies. FLAT is charged once for the shipment, PER_MILE is multiplied by the route mileage, and PER_STOP is charged for each stop beyond the first pickup and last delivery.

      values
      • FLAT
      • PER_MILE
      • PER_STOP
    • code
      Type: string · AccessorialsEnum
      required

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

    • label
      Type: string | null

      The charge as the provider words it, shown to the rep

  • costPerMile
    Type: number | null

    Cost per mile for this rate, where the provider calculates it

  • fuelSurchargePct
    Type: number | null

    The fuel surcharge as a whole percent, where the provider holds it in that form. Sent alongside fuelSurcharge, never instead of it.

  • marginPct
    Type: number | null

    Margin as a whole percent: 17, not 0.17.

    When a rate carries a margin, Augment seeds its margin selector with it and does not stack a second margin on top; a rep override is still tracked. Send null when the source has no margin of its own, as with a raw market rate.