Skip to main content
POST
/
shipper
/
quotes
List Shipper Quotes (POST)
curl --request POST \
  --url https://api-lg-k.arms.cedarai.com/shipper/quotes \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "aar_car_type_pattern": "<string>",
  "car_type": "ALL_CAR_TYPES",
  "car_types": [
    "ALL_CAR_TYPES"
  ],
  "contents": {
    "quantity": {
      "amount": {
        "value": "<string>"
      },
      "units": "BOARD_FEET"
    },
    "stcc_or_prefix": "<string>",
    "stccs_or_prefixes": [
      "<string>"
    ]
  },
  "contract_cifs": [
    "<string>"
  ],
  "destination": {
    "carrier_fsac": {
      "carrier": "<string>",
      "fsac": "<string>"
    },
    "city_state": {
      "city": "<string>",
      "state_or_province": "<string>"
    },
    "junction": {
      "junction_code": "<string>"
    },
    "splc": {
      "splc": "<string>"
    }
  },
  "destinations": [
    {
      "carrier_fsac": {
        "carrier": "<string>",
        "fsac": "<string>"
      },
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "junction": {
        "junction_code": "<string>"
      },
      "splc": {
        "splc": "<string>"
      }
    }
  ],
  "equipment_ownership_statuses": [
    "HIGHWAY_CARRIER"
  ],
  "equipment_profiles": [
    {
      "car_type": "ALL_CAR_TYPES",
      "inside_height_from_inches": 123,
      "inside_height_to_inches": 123,
      "inside_length_from_inches": 123,
      "inside_length_to_inches": 123,
      "name": "<string>",
      "outside_length_from_inches": 123,
      "outside_length_to_inches": 123,
      "special_car_type": "FLAT"
    }
  ],
  "method_of_payment": "PREPAID",
  "number_of_cars": 123,
  "origin": {
    "carrier_fsac": {
      "carrier": "<string>",
      "fsac": "<string>"
    },
    "city_state": {
      "city": "<string>",
      "state_or_province": "<string>"
    },
    "junction": {
      "junction_code": "<string>"
    },
    "splc": {
      "splc": "<string>"
    }
  },
  "origins": [
    {
      "carrier_fsac": {
        "carrier": "<string>",
        "fsac": "<string>"
      },
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "junction": {
        "junction_code": "<string>"
      },
      "splc": {
        "splc": "<string>"
      }
    }
  ],
  "route": {
    "entries": [
      {
        "carrier": "<string>",
        "outbound_junction": "<string>",
        "sequence_code": "<string>"
      }
    ],
    "route_deprecated": "<string>",
    "val": "<string>"
  },
  "ship_date": "<string>"
}
'
{
  "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

Body

application/json
​
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.

​
car_type
enum<string>
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
​
contents
object
​
contract_cifs
string[]

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

​
destination
object
​
destinations
object[]

List of candidate destination locations. Prefer this over the single destination input.

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

Equipment ownership status categories used in EQOS shipment conditions.

  • 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
​
equipment_profiles
object[]

Optional equipment profile filters. When provided, quote search matches rates for any selected profile.

​
method_of_payment
enum<string>
Available options:
PREPAID,
COLLECT,
RULE_11
​
number_of_cars
integer<int32>

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

​
origin
object
​
origins
object[]

List of candidate origin locations. This should be at most a handful, preferably fewer than 10. Prefer this over the single origin input.

​
route
object
​
ship_date
string

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

Response

A successful response.

​
quotes
object[]

Candidate quotes returned for the request.