# Rate Search

This API endpoint is designed to facilitate detailed searches for freight rates across various intermodal regions. It allows users to specify criteria such as intermodal region ID, destination city ID, container size, cargo types, and whether the area has limited access.

Endpoint: GET /rates/advanceSearch
Version: 1.0.0
Security: bearerAuth

## Query parameters:

  - `intermodal_region_id` (integer, required)
    The id of Intermodal Region

  - `to_city_id` (integer, required)
    The id of City

  - `cntr_size` (integer)
    The container size (20, 40, 45). It is strongly recommended to send request with cntr_size parameter, if not, 40 will be used by default
    Enum: 20, 40, 45

  - `cargo_types` (array)
    2: HAZMAT, 3: REEFER. For example, [2, 3] refers to the hazmat and reefer container. empty array or null refers to general cargo
    Enum: 2, 3

  - `weight` (number)
    Container weight value

  - `weight_unit` (string)
    Container weight unit, accept lb or kg only
    Enum: "lb", "kg"

  - `cargo_value` (number)
    Cargo value, if not provided, premium will be 0, minimum is 0, maximum is 1000000
    Example: 100000

  - `is_limited_area_access` (boolean)
    Limited area access

## Response 200 fields (application/json):

  - `data` (object)

  - `data.intermodal_region` (object)

  - `data.intermodal_region.id` (integer)
    A unique identifier for the intermodal region
    Example: 50

  - `data.intermodal_region.name` (string)
    The name of the intermodal region, typically including the city name and state abbreviation
    Example: "Albany - NY"

  - `data.intermodal_region.city` (string)
    A detailed string that includes the city name, state abbreviation, and country
    Example: "Albany, NY, USA"

  - `data.intermodal_region.latitude` (number)
    The geographic latitude of the intermodal region's central point
    Example: 42.914506

  - `data.intermodal_region.longitude` (number)
    The geographic longitude of the intermodal region's central point
    Example: -73.709122

  - `data.intermodal_region.has_ocean_port` (boolean)
    Indicates whether the intermodal region has access to an ocean port

  - `data.intermodal_region.has_ramp_port` (boolean)
    Indicates whether the region includes a ramp port

  - `data.intermodal_region.unlocodes` (array)
    A list of UN/LOCODEs associated with the intermodal region
    Example: ["USMHV"]

  - `data.to_city` (object)

  - `data.to_city.id` (integer)
    Example: 240

  - `data.to_city.country` (string)
    Example: "USA"

  - `data.to_city.full_name` (string)
    Example: "Joliet, IL, USA"

  - `data.to_city.full_name_zipcode` (string)
    Example: "Joliet, IL, USA"

  - `data.to_city.zipcodes` (array)
    Example: ["60431"]

  - `data.to_city.name` (string)
    Example: "Joliet"

  - `data.to_city.state` (string)
    Example: "IL"

  - `data.to_city.alias` (string,null)

  - `data.to_city.latitude` (number)
    Example: 41.527154

  - `data.to_city.longitude` (number)
    Example: -88.08241

  - `data.currency` (string)
    The currency in which rates are provided
    Example: "USD"

  - `data.remaining_limit` (integer)
    The number of requests remaining before hitting the rate limit
    Example: 18

  - `data.rates` (array)

  - `data.rates.id` (string)
    Unique rate identifier
    Example: "S198972"

  - `data.rates.base_rate` (string)
    Base rate for freight
    Example: "497.00"

  - `data.rates.tier_rate` (string)
    Tier rate if applicable
    Example: "400.00"

  - `data.rates.fuel_surcharge` (string)
    Fuel surcharge amount
    Example: "0.00"

  - `data.rates.toll_fee` (string,null)
    Toll fees if applicable

  - `data.rates.truck_rate` (string)
    Total truck rate
    Example: "497.00"

  - `data.rates.expired_at` (string)
    Rate expiration date
    Example: "2023-08-14"

  - `data.rates.terminals` (array)
    List of applicable terminals

  - `data.rates.terminals.id` (integer)
    Terminal ID
    Example: 663

  - `data.rates.terminals.name` (string)
    Terminal name
    Example: "CN - JOLIET"

  - `data.rates.terminals.firms_code` (string)
    FIRMS code
    Example: "H903"

  - `data.rates.terminals.facility_type` (string)
    Type of facility
    Example: "CN Rail"

  - `data.rates.terminals.latitude` (number)
    Terminal latitude
    Example: 41.527154

  - `data.rates.terminals.longitude` (number)
    Terminal longitude
    Example: -88.08241

  - `data.rates.terminals.unlocode` (string)
    UN/LOCODE
    Example: "USJOT"

  - `data.rates.scenarios` (array)
    Different shipping scenarios

  - `data.rates.scenarios.name` (string)
    Scenario name
    Example: "Best Scenario CHICAGO"

  - `data.rates.scenarios.rates` (array)
    List of rates

  - `data.rates.scenarios.rates.qty` (number)
    Quantity
    Example: 1

  - `data.rates.scenarios.rates.name` (string)
    Rate name
    Example: "Base Rate"

  - `data.rates.scenarios.rates.rate` (number)
    Rate amount
    Example: 100

  - `data.rates.scenarios.rates.unit` (string)
    Rate unit
    Example: "CNTR"

  - `data.rates.scenarios.rates.amount` (number)
    Total amount
    Example: 100

  - `data.rates.scenarios.total_rate` (number)
    Total rate amount
    Example: 100

  - `data.rates.scenarios.description` (string)
    Scenario description
    Example: "Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n2 Days Chassis Usage"

  - `data.rates.scenarios.possible_charges` (array)
    List of possible charges

  - `data.rates.scenarios.possible_charges.code` (string)
    Enum: "CHAFE", "TERWA", "WARWA", "PRECH", "YARST", "CHASP", "DRYRU", "LAYOV", "STOOF", "RESDE", "HAZCA", "TRIFE", "OVECH", "TOLFE", "REESU", "CHAFL", "REVOR", "RUSH", "HAZPREM", "PORCO", "RERO", "OTHCH", "EXAFE", "FBAFEE", "CLECF", "EQMFE", "EXAHA", "PIEPA", "CLETR"

  - `data.rates.scenarios.possible_charges.name` (string)
    Name of the charge
    Example: "CHASSIS FEE"

  - `data.rates.scenarios.possible_charges.explanation` (string)
    Explanation of the charge

  - `data.rates.scenarios.possible_charges.unit` (string)
    Unit of measurement
    Example: "DAY"

  - `data.rates.scenarios.possible_charges.rate_text` (string)
    Text description of the rate
    Example: "45.00/DAY 2 DAYs MIN"

  - `data.rates.scenarios.possible_charges.free` (number)
    Whether the charge is free

  - `data.rates.scenarios.possible_charges.min` (number)
    Minimum quantity required
    Example: 2

  - `data.rates.scenarios.possible_charges.max` (number)
    Maximum quantity allowed

  - `data.rates.scenarios.possible_charges.cntr_size` (array)
    Applicable container sizes
    Example: [0]

  - `data.rates.scenarios.possible_charges.probability` (number)
    Probability of the charge occurring
    Example: 0.97

  - `data.premium` (number)
    Premium
    Example: 56

  - `data.quote_id` (string)
    Quote ID


## Response 401 fields