Skip to main content
POST
/
shipper
/
quotes
List Shipper Quotes
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_types": [],
  "contents": {
    "quantity": {
      "amount": {
        "value": "<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>"
    }
  },
  "destination_cifs": [
    "<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": [],
  "equipment_profiles": [
    {
      "measurements": [
        {
          "range": {
            "from": 123,
            "to": 123
          }
        }
      ],
      "name": "<string>"
    }
  ],
  "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>"
    }
  },
  "origin_cifs": [
    "<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>"
      }
    ],
    "val": "<string>"
  },
  "ship_date": "<string>"
}
'
{
  "quotes": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "distance": {
        "value": {
          "value": "<string>"
        }
      },
      "legs": [
        {
          "billing_carrier": "<string>",
          "charges": [
            {
              "amount": {
                "cents": 123,
                "currency": "<string>",
                "dollars": "<string>"
              },
              "per_car_amount": {
                "cents": 123,
                "currency": "<string>",
                "dollars": "<string>"
              },
              "rate": {
                "amount": {
                  "cents": 123,
                  "currency": "<string>",
                  "dollars": "<string>"
                },
                "car_type_conditions": [
                  {}
                ],
                "docket_column": 123,
                "docket_level": 123,
                "docket_line": 123,
                "docket_sub_level": 123,
                "equipment_ownership_conditions": [],
                "matching_equipment_profile_names": [
                  "<string>"
                ],
                "pndr": {
                  "docket_identifier": "<string>",
                  "number": "<string>",
                  "producer": "<string>",
                  "revision": 123
                },
                "publication": {
                  "effective_date": "<string>",
                  "expiration_date": "<string>",
                  "issuer": "<string>",
                  "number": "<string>",
                  "suffix": "<string>"
                }
              },
              "rated_quantity": {
                "amount": {
                  "value": "<string>"
                }
              },
              "special_charge_description": "<string>",
              "special_charge_or_allowance_code": "<string>"
            }
          ],
          "destination": {
            "carrier": "<string>",
            "city": "<string>",
            "fsac": "<string>",
            "junction_code": "<string>",
            "splc": "<string>",
            "state": "<string>"
          },
          "distance": {
            "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>"
              }
            ],
            "val": "<string>"
          },
          "total": {
            "cents": 123,
            "currency": "<string>",
            "dollars": "<string>"
          }
        }
      ],
      "name": "<string>",
      "number_of_cars": 123,
      "route": {
        "entries": [
          {
            "carrier": "<string>",
            "outbound_junction": "<string>",
            "sequence_code": "<string>"
          }
        ],
        "val": "<string>"
      },
      "total": {
        "cents": 123,
        "currency": "<string>",
        "dollars": "<string>"
      }
    }
  ]
}

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_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
​
destination_cifs
string[]

Customer CIFs at the destination; SCRS counterpart of origin_cifs for destinations.

​
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
​
origin_cifs
string[]

Customer CIFs at the origin. When provided, candidate origin stations are filtered to those onto which at least one of these customers may switch traffic under SCRS (Serving Carrier Reciprocal Switch) rules. Empty means no SCRS origin restriction is applied.

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