Skip to main content
GET
/
shipper
/
quotes
List Shipper Quotes (GET)
curl --request GET \
  --url https://api-lg-k.arms.cedarai.com/shipper/quotes \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>'
{
  "quotes": [
    {
      "distance": {
        "source": "PC_MILER",
        "value": {
          "value": "<string>"
        }
      },
      "legs": [
        {
          "billing_carrier": "<string>",
          "charges": [
            {
              "amount": {
                "cents": 123,
                "currency": "<string>",
                "dollars": "<string>"
              },
              "billing_carrier": "<string>",
              "method_of_payment": "PREPAID",
              "per_car_amount": {
                "cents": 123,
                "currency": "<string>",
                "dollars": "<string>"
              },
              "rate": {
                "amount": {
                  "cents": 123,
                  "currency": "<string>",
                  "dollars": "<string>"
                },
                "car_type_conditions": [
                  {
                    "car_type": "ALL_CAR_TYPES",
                    "sign": "PLUS"
                  }
                ],
                "docket_column": 123,
                "docket_level": 123,
                "docket_line": 123,
                "docket_sub_level": 123,
                "equipment_ownership_conditions": [
                  "HIGHWAY_CARRIER"
                ],
                "pndr": {
                  "docket_identifier": "<string>",
                  "number": "<string>",
                  "producer": "<string>",
                  "revision": 123
                },
                "publication": {
                  "effective_date": "<string>",
                  "expiration_date": "<string>",
                  "issuer": "<string>",
                  "number": "<string>",
                  "suffix": "<string>",
                  "type": "CONTRACT"
                },
                "qualifier": "PER_BOARD_FOOT"
              },
              "rated_quantity": {
                "amount": {
                  "value": "<string>"
                },
                "units": "BOARD_FEET"
              },
              "route_deprecated": "<string>",
              "special_charge_description": "<string>",
              "special_charge_or_allowance_code": "<string>",
              "type": "FREIGHT"
            }
          ],
          "destination": {
            "carrier": "<string>",
            "city": "<string>",
            "fsac": "<string>",
            "junction_code": "<string>",
            "splc": "<string>",
            "state": "<string>"
          },
          "distance": {
            "source": "PC_MILER",
            "value": {
              "value": "<string>"
            }
          },
          "origin": {
            "carrier": "<string>",
            "city": "<string>",
            "fsac": "<string>",
            "junction_code": "<string>",
            "splc": "<string>",
            "state": "<string>"
          },
          "route": {
            "entries": [
              {
                "carrier": "<string>",
                "outbound_junction": "<string>",
                "sequence_code": "<string>"
              }
            ],
            "route_deprecated": "<string>",
            "val": "<string>"
          },
          "route_deprecated": "<string>",
          "total": {
            "cents": 123,
            "currency": "<string>",
            "dollars": "<string>"
          }
        }
      ],
      "name": "<string>",
      "number_of_cars": 123,
      "route": {
        "entries": [
          {
            "carrier": "<string>",
            "outbound_junction": "<string>",
            "sequence_code": "<string>"
          }
        ],
        "route_deprecated": "<string>",
        "val": "<string>"
      },
      "route_deprecated": "<string>",
      "total": {
        "cents": 123,
        "currency": "<string>",
        "dollars": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-arms-api-key
string
header
required
​
x-arms-assume-user
string
header
required

Query Parameters

​
origin.carrier_fsac.carrier
string

Reporting marks / railroad code (for example, BNSF, UP, CSXT).

​
origin.carrier_fsac.fsac
string

FSAC (Freight Station Accounting Code) for the location on the carrier.

​
origin.junction.junction_code
string

Industry junction code used when identifying a location by interchange.

​
origin.city_state.city
string

City name for the location.

​
origin.city_state.state_or_province
string

State or province code (for example, TX, ON).

​
origin.splc.splc
string

SPLC identifier for the location.

​
destination.carrier_fsac.carrier
string

Reporting marks / railroad code (for example, BNSF, UP, CSXT).

​
destination.carrier_fsac.fsac
string

FSAC (Freight Station Accounting Code) for the location on the carrier.

​
destination.junction.junction_code
string

Industry junction code used when identifying a location by interchange.

​
destination.city_state.city
string

City name for the location.

​
destination.city_state.state_or_province
string

State or province code (for example, TX, ON).

​
destination.splc.splc
string

SPLC identifier for the location.

​
contents.stcc_or_prefix
string

Singular stcc or stcc prefix. prefer plural

​
contents.stccs_or_prefixes
string[]

List of candidate STCCs / STCC prefixes for the shipment commodity.

​
contents.quantity.amount.value
string
​
contents.quantity.units
enum<string>

Unit associated with the quantity.

Available options:
BOARD_FEET,
CARLOAD,
CONTAINER,
CORD_VOLUME,
CUBIC_FEET,
GALLONS,
INTERMODAL_UNITS,
KILOGRAMS,
LITER,
MILES,
ONE_HUNDRED_BOARD_FEET,
POUNDS,
THOUSAND_BOARD_FEET,
TRAILER,
TRAIN,
UNITS,
VEHICLE,
VOLUMETRIC_UNIT
​
ship_date
string

Desired shipment date used for applicability/rating in ISO8601 format. Use YYYY-MM-DD (for example: "2026-03-03").

​
route.route_deprecated
string

Deprecated in favor of val. Legacy format example: "AA-DIANN-GTW-CHGO-BNSF"

​
route.val
string

Canonical route string representation (for example: "AA-DIANN-GTW-CHGO-BNSF").

​
contract_cifs
string[]

Contract CIF filters. If provided, matching contract quotes are included in addition to tariff results.

​
car_type
enum<string>

Optional car type override used for rating/equipment assumptions.

Available options:
ALL_CAR_TYPES,
BI_LEVEL,
BOX_CAR,
BULKHEAD,
CLOSED,
CLOSED_BI_LEVEL,
CLOSED_TRI_LEVEL,
COIL,
COVERED_COIL,
COVERED_GONDOLA,
CUSHIONED_BOX_CAR,
FLAT_PEDESTAL,
GONDOLA,
GRAVITY_FLOW,
INSULATED_BOX_CAR,
MECHANICAL_REFRIGERATOR,
OPEN,
OPEN_COIL_CARS,
OPEN_GONDOLA,
OPEN_HOPPER,
PLUG_DOORS,
TRI_LEVEL,
TRIPLE_CROSS_HOPPER
​
car_types
enum<string>[]

Optional car type overrides used for rating/equipment assumptions. Deprecated for new clients in favor of equipment_profiles, which also supports special quote-only types and additional measurement ranges. When provided, quote search matches rates for any selected car type.

Available options:
ALL_CAR_TYPES,
BI_LEVEL,
BOX_CAR,
BULKHEAD,
CLOSED,
CLOSED_BI_LEVEL,
CLOSED_TRI_LEVEL,
COIL,
COVERED_COIL,
COVERED_GONDOLA,
CUSHIONED_BOX_CAR,
FLAT_PEDESTAL,
GONDOLA,
GRAVITY_FLOW,
INSULATED_BOX_CAR,
MECHANICAL_REFRIGERATOR,
OPEN,
OPEN_COIL_CARS,
OPEN_GONDOLA,
OPEN_HOPPER,
PLUG_DOORS,
TRI_LEVEL,
TRIPLE_CROSS_HOPPER
​
number_of_cars
integer<int32>

Number of cars requested for the movement. Omitted/0 defaults to 1.

​
method_of_payment
enum<string>

Shipment method of payment. If omitted/unspecified, PREPAID is used.

Available options:
PREPAID,
COLLECT,
RULE_11
​
equipment_ownership_statuses
enum<string>[]

Optional equipment ownership status filters. When provided, quote search matches rates whose EQOS conditions include any of the selected statuses.

  • HIGHWAY_CARRIER: H - Highway carrier
  • SHIPPER_OWNED_OR_LEASED: S - Shipper owned or leased
  • STEAMSHIP_LINES: O - Steamship lines
  • RAILROAD_OWNED_OR_LEASED: R - Railroad owned or leased
Available options:
HIGHWAY_CARRIER,
SHIPPER_OWNED_OR_LEASED,
STEAMSHIP_LINES,
RAILROAD_OWNED_OR_LEASED
​
aar_car_type_pattern
string

Optional exact AAR/UMET car type pattern (for example "A-4" for plug doors) used for quote equipment assumptions and ARCT condition evaluation.

Response

A successful response.

​
quotes
object[]

Candidate quotes returned for the request.