Skip to main content

Square yard rate quotes

This guide explains how to call Generate Rate Quote so line items are priced on a square yard basis. It applies only to fields that control square yard vs hundredweight rating for each line item.

Endpoint: POST /ltl/rate/quote
Operation ID: Generate Rate Quote


When a line is square yard vs hundredweight

Request fieldValue for square yard pricing
unitOfMeasureSQUARE_YARDS
quantityTotal square yards for that line (0–99999.99 per schema)

If unitOfMeasure is HUNDRED_WEIGHT, the line is priced on a hundredweight (CWT) basis, not square yards.


Product class (classCode)

LtlRateQuoteRequestItem.classCode must be one of the enum values in the OpenAPI spec. For carpet / carpet tile priced by the yard, use:

classCodeProduct
1Carpet Roll
3Carpet tile

All other allowed values (50, 55, … 500) are freight classes used for weight-based rating. They do not select square yard carpet tariffs.


Quantity and unit of measure

  • unitOfMeasure: SQUARE_YARDS (enum).
  • quantity: Must match the unit — i.e. square yards for that line item.

Weight (weight)

weight is required on each line item and is expressed in pounds (LBS) (integer, 0–99999 per schema). Provide a total weight for the line even when the rate basis is square yards.


Pieces (pieces)

pieces is required (integer 0–9999). Use the count of handling units (for example rolls) for that line.


Item type (type)

type is optional on the request item. Allowed values: ROLL, PALLET, RUG, TURF_ROLL. Use ROLL (or another value your shipment matches) when it applies; omit the property when not needed.


Shipment envelope (minimal context)

The quote request body requires:

  • originZipcode — 5-character US ZIP (prefix with 0 if needed)
  • destinationZipcode — 5-character US ZIP (prefix with 0 if needed)
  • tenderDate — ISO 8601 date YYYY-MM-DD
  • items — non-empty array of Items

For square yard behavior, the critical line-level fields are classCode, unitOfMeasure, quantity, plus required pieces and weight.


Example: rolled carpet, square yards

{
"originZipcode": "30165",
"destinationZipcode": "90210",
"tenderDate": "2019-08-24",
"items": [
{
"classCode": "1",
"pieces": 4,
"unitOfMeasure": "SQUARE_YARDS",
"quantity": 450.5,
"weight": 1200,
"type": "ROLL"
}
]
}

Carpet tile: use "classCode": "3", "unitOfMeasure": "SQUARE_YARDS", and set quantity to square yards; set type only if required for your shipment.


Checklist

  • Line unitOfMeasure is SQUARE_YARDS.
  • Line quantity is expressed in square yards.
  • Line classCode is 1 (carpet) or 3 (carpet tile) for carpet square-yard tariffs.
  • Line weight (lbs) and pieces satisfy schema and business rules.
  • Request includes required origin, destination, tender date, and at least one item.

Further reference

Interactive API documentation: Generate Rate Quote