Rate Search
<h2>Overview</h2>
<p>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, enabling a tailored search for freight rates that match specific requirements.</p>
<h2>Request</h2>
<ul>
<li>Method: <strong>GET</strong></li>
<li>URI: <code>/rates/advanceSearch</code></li>
</ul>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>intermodal_region_id (*)</td>
<td>Integer</td>
<td>The id of Intermodal Region</td>
</tr>
<tr>
<td>to_city_id (*)</td>
<td>Integer</td>
<td>The id of City</td>
</tr>
<tr>
<td>cntr_size</td>
<td>Integer</td>
<td>The container size (20, 40, 45). <strong>It is strongly recommended to send request with cntr_size parameter, if not, 40 will be used by default</strong></td>
</tr>
<tr>
<td>cargo_types</td>
<td>Integer Array</td>
<td>2: HAZMAT, 3: REEFER, For example, [2, 3] refers to the hazmat and reefer container. empty array or null refers to general cargo</td>
</tr>
<tr>
<td>weight</td>
<td>Float</td>
<td>Container weight value</td>
</tr>
<tr>
<td>weight_unit</td>
<td>String</td>
<td>Container weight unit, accpet lb or kg only</td>
</tr>
<tr>
<td>is_limited_area_access</td>
<td>Boolean</td>
<td>Limtied area access</td>
</tr>
</tbody>
</table>
<p>> <code>(*)</code> it means the field is required.</p>
<h2>Code Example</h2>
<pre><code>Request:
curl https://api.drayeasy.com/api/v2/rates/search?intermodal_region_id=77&amp;to_city_id=240 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
curl https://api.drayeasy.com/api/v2/rates/search?intermodal_region_id=94&amp;to_city_id=115 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
curl https://api.drayeasy.com/api/v2/rates/search?intermodal_region_id=92&amp;to_city_id=28269 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
curl https://api.drayeasy.com/api/v2/rates/search?intermodal_region_id=48&amp;to_city_id=6161 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
Response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
&quot;data&quot;: {
&quot;intermodal_region&quot;: {
&quot;id&quot;: 77,
&quot;name&quot;: &quot;Chicago - IL&quot;,
&quot;city&quot;: &quot;Chicago, IL, USA&quot;,
&quot;latitude&quot;: 41.642854,
&quot;longitude&quot;: -87.868063,
&quot;has_ocean_port&quot;: null,
&quot;has_ramp_port&quot;: true
},
&quot;to_city&quot;: {
&quot;id&quot;: 240,
&quot;country&quot;: &quot;USA&quot;,
&quot;full_name&quot;: &quot;Joliet, IL, USA&quot;,
&quot;full_name_zipcode&quot;: &quot;Joliet, IL, USA&quot;,
&quot;zipcodes&quot;: [
&quot;60431&quot;,
&quot;60432&quot;,
&quot;60433&quot;,
&quot;60435&quot;,
&quot;60436&quot;,
&quot;60421&quot;,
&quot;60586&quot;,
&quot;60434&quot;
],
&quot;name&quot;: &quot;JOLIET&quot;,
&quot;state&quot;: &quot;IL&quot;,
&quot;alias&quot;: null,
&quot;latitude&quot;: 41.527154,
&quot;longitude&quot;: -88.08241
},
&quot;currency&quot;: &quot;USD&quot;,
&quot;remaining_limit&quot;: 18,
&quot;rates&quot;: [
{
&quot;id&quot;: &quot;S198972&quot;,
&quot;base_rate&quot;: &quot;497.00&quot;,
&quot;tier_rate&quot;: &quot;400.00&quot;,
&quot;fuel_surcharge&quot;: &quot;0.00&quot;,
&quot;toll_fee&quot;: null,
&quot;truck_rate&quot;: &quot;497.00&quot;,
&quot;expired_at&quot;: &quot;2023-08-14&quot;,
&quot;terminals&quot;: [
{
&quot;id&quot;: 663,
&quot;name&quot;: &quot;CN - JOLIET&quot;,
&quot;firms_code&quot;: &quot;H903&quot;,
&quot;facility_type&quot;: &quot;CN Rail&quot;
}
],
&quot;scenarios&quot;: [
{
&quot;name&quot;: &quot;Best Scenario CHICAGO&quot;,
&quot;description&quot;: &quot;Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n2 Days Chassis Usage&quot;,
&quot;rates&quot;: [
{
&quot;name&quot;: &quot;Base Rate&quot;,
&quot;rate&quot;: &quot;497.00&quot;,
&quot;unit&quot;: &quot;CNTR&quot;,
&quot;qty&quot;: 1,
&quot;amount&quot;: &quot;497.00&quot;
},
{
&quot;name&quot;: &quot;Fuel Surcharge&quot;,
&quot;rate&quot;: &quot;0.00&quot;,
&quot;unit&quot;: &quot;CNTR&quot;,
&quot;qty&quot;: 1,
&quot;amount&quot;: &quot;0.00&quot;
}
],
&quot;possible_charges&quot;: [
{
&quot;code&quot;: &quot;CHAFE&quot;,
&quot;name&quot;: &quot;CHASSIS FEE&quot;,
&quot;explanation&quot;: null,
&quot;rate&quot;: &quot;45&quot;,
&quot;unit&quot;: &quot;DAY&quot;,
&quot;rate_text&quot;: &quot;45.00/DAYx2 2 DAYs MIN&quot;,
&quot;free&quot;: null,
&quot;min&quot;: &quot;2&quot;,
&quot;max&quot;: null,
&quot;cntr_size&quot;: [
0
],
&quot;qty&quot;: 2,
&quot;amount&quot;: &quot;90.00&quot;,
&quot;statement&quot;: &quot;Chassis Usage 2 Days&quot;
}
],
&quot;total_rate&quot;: &quot;587.00&quot;
},
{
&quot;name&quot;: &quot;Average Scenario CHICAGO&quot;,
&quot;description&quot;: &quot;Average Scenario 40'HQ,40',20' / Legal Weight / Live Unload\n4 Days Chassis Usage\nPrepull \n2 Day Storage\nChassis Split&quot;,
&quot;rates&quot;: [
{
&quot;name&quot;: &quot;Base Rate&quot;,
&quot;rate&quot;: &quot;497.00&quot;,
&quot;unit&quot;: &quot;CNTR&quot;,
&quot;qty&quot;: 1,
&quot;amount&quot;: &quot;497.00&quot;
},
{
&quot;name&quot;: &quot;Fuel Surcharge&quot;,
&quot;rate&quot;: &quot;0.00&quot;,
&quot;unit&quot;: &quot;CNTR&quot;,
&quot;qty&quot;: 1,
&quot;amount&quot;: &quot;0.00&quot;
}
],
&quot;possible_charges&quot;: [
{
&quot;code&quot;: &quot;CHAFE&quot;,
&quot;name&quot;: &quot;CHASSIS FEE&quot;,
&quot;explanation&quot;: null,
&quot;rate&quot;: &quot;45&quot;,
&quot;unit&quot;: &quot;DAY&quot;,
&quot;rate_text&quot;: &quot;45.00/DAYx4 2 DAYs MIN&quot;,
&quot;free&quot;: null,
&quot;min&quot;: &quot;2&quot;,
&quot;max&quot;: null,
&quot;cntr_size&quot;: [
0
],
&quot;qty&quot;: 4,
&quot;amount&quot;: &quot;180.00&quot;,
&quot;statement&quot;: &quot;Chassis Usage 4 days&quot;
},
{
&quot;code&quot;: &quot;PRECH&quot;,
&quot;name&quot;: &quot;PREPULL CHARGE&quot;,
&quot;explanation&quot;: null,
&quot;rate&quot;: &quot;200&quot;,
&quot;unit&quot;: &quot;CNTR&quot;,
&quot;rate_text&quot;: &quot;200.00x1&quot;,
&quot;free&quot;: null,
&quot;min&quot;: null,
&quot;max&quot;: null,
&quot;cntr_size&quot;: [
0
],
&quot;qty&quot;: 1,
&quot;amount&quot;: &quot;200.00&quot;,
&quot;statement&quot;: &quot;Prepull&quot;
},
...
],
&quot;total_rate&quot;: &quot;1127.00&quot;
}
],
&quot;possible_charges&quot;: [
{
&quot;code&quot;: &quot;CHAFE&quot;,
&quot;name&quot;: &quot;CHASSIS FEE&quot;,
&quot;explanation&quot;: null,
&quot;rate&quot;: &quot;45&quot;,
&quot;unit&quot;: &quot;DAY&quot;,
&quot;rate_text&quot;: &quot;45.00/DAY 2 DAYs MIN&quot;,
&quot;free&quot;: null,
&quot;min&quot;: &quot;2&quot;,
&quot;max&quot;: null,
&quot;probability&quot;: &quot;94.00&quot;,
&quot;cntr_size&quot;: [
0
]
},
{
&quot;code&quot;: &quot;TERWA&quot;,
&quot;name&quot;: &quot;TERMINAL WAITING TIME (DETENTION)&quot;,
&quot;explanation&quot;: null,
&quot;rate&quot;: &quot;100&quot;,
&quot;unit&quot;: &quot;HR&quot;,
&quot;rate_text&quot;: &quot;100.00/HR 1 HRs FREE&quot;,
&quot;free&quot;: &quot;1&quot;,
&quot;min&quot;: null,
&quot;max&quot;: null,
&quot;probability&quot;: &quot;80.00&quot;,
&quot;cntr_size&quot;: [
0
]
},
...
]
},
...
]
}
}</code></pre>
<h2>Response Fields Description</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>intermodal_region</td>
<td>Object</td>
<td>Contains details about the intermodal region relevant to the search.</td>
</tr>
<tr>
<td>to_city</td>
<td>Object</td>
<td>Details of the destination city including ID, country, and full name.</td>
</tr>
<tr>
<td>currency</td>
<td>String</td>
<td>The currency in which rates are provided, e.g., USD.</td>
</tr>
<tr>
<td>remaining_limit</td>
<td>Integer</td>
<td>The number of requests remaining before hitting the rate limit.</td>
</tr>
<tr>
<td>rates</td>
<td>Array of Rate</td>
<td>A list of rate quotes based on the search criteria, including detailed rate information and scenarios.</td>
</tr>
</tbody>
</table>
<p><strong> Rate Object </strong></p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>String</td>
<td>Unique identifier for the rate quote.</td>
</tr>
<tr>
<td>base_rate</td>
<td>String</td>
<td>The base rate for the freight.</td>
</tr>
<tr>
<td>tier_rate</td>
<td>String</td>
<td>The tier rate for the freight if applicable.</td>
</tr>
<tr>
<td>fuel_surcharge</td>
<td>String</td>
<td>The fuel surcharge applied to the freight rate.</td>
</tr>
<tr>
<td>toll_fee</td>
<td>String</td>
<td>Toll fees, if applicable. Null if not applicable.</td>
</tr>
<tr>
<td>truck_rate</td>
<td>String</td>
<td>Total truck rate combining base rate and other charges.</td>
</tr>
<tr>
<td>expired_at</td>
<td>Date</td>
<td>Expiration date of the rate quote.</td>
</tr>
<tr>
<td>terminals</td>
<td>Array of Terminal</td>
<td>Details of terminals related to the rate quote, including terminal ID and name. null or empty array indicates that this rate apply to all terminal in this Intermodal Region.</td>
</tr>
<tr>
<td>scenarios</td>
<td>Array of Scenario</td>
<td>Different shipping scenarios with respective costs and descriptions.</td>
</tr>
<tr>
<td>possible_charges</td>
<td>Array of Possible Charge</td>
<td>List of possible additional charges that could apply to the rate quote.</td>
</tr>
</tbody>
</table>
<p><strong>Terminal Object</strong></p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>Unique identifier for the terminal.</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the terminal.</td>
</tr>
<tr>
<td>firms_code</td>
<td>String</td>
<td>The FIRMS (Facilities Information and Resources Management System) code associated with the terminal.</td>
</tr>
<tr>
<td>facility_type</td>
<td>String</td>
<td>Type of facility, such as "CN Rail".</td>
</tr>
</tbody>
</table>
<p><strong>Scenario Object</strong></p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the scenario, providing a quick reference to the type of cost calculation.</td>
</tr>
<tr>
<td>description</td>
<td>String</td>
<td>Detailed description of the scenario, including conditions like container size, weight limits, and loading/unloading specifics.</td>
</tr>
<tr>
<td>rates</td>
<td>Array</td>
<td>A list of rates applicable to this scenario, each object detailing the rate name, unit, quantity, and amount.</td>
</tr>
<tr>
<td>possible_charges</td>
<td>Array of Possible Charge</td>
<td>List of possible additional charges specific to this scenario, mirroring the structure of the top-level possible charges.</td>
</tr>
<tr>
<td>total_rate</td>
<td>String</td>
<td>The total calculated rate for this scenario, summing the rates and possible_charges.</td>
</tr>
</tbody>
</table>
<p><strong>Rates within Scenario Object</strong></p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the rate component, such as "Base Rate" or "Fuel Surcharge".</td>
</tr>
<tr>
<td>rate</td>
<td>String</td>
<td>The individual rate cost for this component.</td>
</tr>
<tr>
<td>unit</td>
<td>String</td>
<td>The unit of measure for this rate, typically "CNTR" for container.</td>
</tr>
<tr>
<td>qty</td>
<td>Integer</td>
<td>The quantity of units this rate applies to, often 1 for scenarios involving single shipments.</td>
</tr>
<tr>
<td>amount</td>
<td>String</td>
<td>The total amount for this rate component, calculated as rate * qty.</td>
</tr>
</tbody>
</table>
<p><strong>Possible Charge Object</strong></p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>String</td>
<td>A unique code identifying the type of charge.</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the charge.</td>
</tr>
<tr>
<td>explanation</td>
<td>String</td>
<td>Additional information or explanation about the charge. Null if not applicable.</td>
</tr>
<tr>
<td>rate</td>
<td>String</td>
<td>The rate of the charge.</td>
</tr>
<tr>
<td>unit</td>
<td>String</td>
<td>The unit in which the charge is calculated, e.g., "DAY", "HR".</td>
</tr>
<tr>
<td>rate_text</td>
<td>String</td>
<td>Text description of the rate, including any calculations like "45.00/DAY".</td>
</tr>
<tr>
<td>free</td>
<td>String</td>
<td>Indicates the quantity free of charge before charges apply, if applicable.</td>
</tr>
<tr>
<td>min</td>
<td>String</td>
<td>The minimum quantity for which the charge applies.</td>
</tr>
<tr>
<td>max</td>
<td>String</td>
<td>The maximum limit for the charge, if any.</td>
</tr>
<tr>
<td>cntr_size</td>
<td>Array</td>
<td>Container sizes to which this charge is applicable. [0] indicates all sizes.</td>
</tr>
<tr>
<td>qty</td>
<td>Integer</td>
<td>The quantity related to the charge.</td>
</tr>
<tr>
<td>amount</td>
<td>String</td>
<td>The total amount for this charge.</td>
</tr>
<tr>
<td>statement</td>
<td>String</td>
<td>A brief statement summarizing the charge's context or condition.</td>
</tr>
<tr>
<td>probability</td>
<td>String</td>
<td>Probability percentage for this possible charge to happen.</td>
</tr>
</tbody>
</table>