DrayEasy API v2

DrayEasy API v2


Rate Request List

<h2>Overview</h2> <p>This endpoint is used to retrieve a list of rate requests. You can filter the results based on the Rate Request ID, Intermodal Region ID, and Destination City ID. Pagination parameters (<code>page</code> and <code>per_page</code>) are also available to navigate through the list of rate requests.</p> <h2>Request</h2> <ul> <li>Method: <strong>GET</strong></li> <li>URI: <code>/rateRequests</code></li> </ul> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>id</td> <td>Integer</td> <td>The id of the Rate Request</td> </tr> <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 To City</td> </tr> <tr> <td>page</td> <td>Integer</td> <td>Current page of the list, default: 1</td> </tr> <tr> <td>per_page</td> <td>Integer</td> <td>Current per page of the list, default: 20</td> </tr> </tbody> </table> <p>&gt; <code>(*)</code> it means the field is required.</p> <h2>Code Example</h2> <pre><code>Request: curl https://api.drayeasy.com/api/v2/rateRequests \ --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 { &amp;quot;data&amp;quot;: [ { &amp;quot;id&amp;quot;: 1392, &amp;quot;to_zipcode&amp;quot;: null, &amp;quot;status&amp;quot;: &amp;quot;created&amp;quot;, // created, completed, rejected &amp;quot;rejected_reason&amp;quot;: null, &amp;quot;created_at&amp;quot;: &amp;quot;2022-12-01 13:58:25&amp;quot;, &amp;quot;memo&amp;quot;: null, &amp;quot;to_city_id&amp;quot;: 115, &amp;quot;intermodal_region_id&amp;quot;: 94, &amp;quot;intermodal_region&amp;quot;: &amp;quot;Los Angeles/Long Beach - CA&amp;quot;, &amp;quot;to_city&amp;quot;: &amp;quot;Ontario, CA, USA&amp;quot;, &amp;quot;rate&amp;quot;: { &amp;quot;id&amp;quot;: &amp;quot;S198972&amp;quot;, &amp;quot;base_rate&amp;quot;: &amp;quot;497.00&amp;quot;, &amp;quot;fuel_surcharge&amp;quot;: &amp;quot;0.00&amp;quot;, &amp;quot;toll_fee&amp;quot;: null, &amp;quot;truck_rate&amp;quot;: &amp;quot;497.00&amp;quot;, &amp;quot;expired_at&amp;quot;: &amp;quot;2023-08-14&amp;quot;, &amp;quot;terminals&amp;quot;: [ { &amp;quot;id&amp;quot;: 663, &amp;quot;name&amp;quot;: &amp;quot;CN - JOLIET&amp;quot;, &amp;quot;firms_code&amp;quot;: &amp;quot;H903&amp;quot;, &amp;quot;facility_type&amp;quot;: &amp;quot;CN Rail&amp;quot; } ], , &amp;quot;scenarios&amp;quot;: [], &amp;quot;possible_charges&amp;quot;: [] } }, { &amp;quot;id&amp;quot;: 1393, &amp;quot;to_zipcode&amp;quot;: null, &amp;quot;status&amp;quot;: &amp;quot;completed&amp;quot;, &amp;quot;rejected_reason&amp;quot;: null, &amp;quot;created_at&amp;quot;: &amp;quot;2022-12-01 13:58:25&amp;quot;, &amp;quot;memo&amp;quot;: null, &amp;quot;to_city_id&amp;quot;: 20, &amp;quot;intermodal_region_id&amp;quot;: 73, &amp;quot;intermodal_region&amp;quot;: &amp;quot;INDIANAPOLIS-IN&amp;quot;, &amp;quot;to_city&amp;quot;: &amp;quot;Cincinnati, OH, USA&amp;quot;, &amp;quot;rate&amp;quot;: null }, { &amp;quot;id&amp;quot;: 1303, &amp;quot;to_zipcode&amp;quot;: null, &amp;quot;status&amp;quot;: &amp;quot;rejected&amp;quot;, &amp;quot;rejected_reason&amp;quot;: &amp;quot;Rejected&amp;quot;, &amp;quot;created_at&amp;quot;: &amp;quot;2022-11-08 09:34:35&amp;quot;, &amp;quot;memo&amp;quot;: &amp;quot;10 Tons&amp;quot;, &amp;quot;to_city_id&amp;quot;: 7698, &amp;quot;intermodal_region_id&amp;quot;: 21, &amp;quot;intermodal_region&amp;quot;: &amp;quot;Norfolk - VA&amp;quot;, &amp;quot;to_city&amp;quot;: &amp;quot;Radford, VA, USA&amp;quot;, &amp;quot;rate&amp;quot;: null } ], &amp;quot;links&amp;quot;: { &amp;quot;first&amp;quot;: &amp;quot;https://api.drayeasy.com/api/v2/rateRequests?page=1&amp;quot;, &amp;quot;last&amp;quot;: &amp;quot;https://api.drayeasy.com/api/v2/rateRequests?page=1&amp;quot;, &amp;quot;prev&amp;quot;: null, &amp;quot;next&amp;quot;: null }, &amp;quot;meta&amp;quot;: { &amp;quot;current_page&amp;quot;: 1, &amp;quot;from&amp;quot;: 1, &amp;quot;last_page&amp;quot;: 1, &amp;quot;path&amp;quot;: &amp;quot;https://api.drayeasy.com/api/v2/rateRequests&amp;quot;, &amp;quot;per_page&amp;quot;: &amp;quot;20&amp;quot;, &amp;quot;to&amp;quot;: 2, &amp;quot;total&amp;quot;: 2 } }</code></pre> <p>&lt;/details&gt;</p> <h2>Response Fields Description</h2> <table> <thead> <tr> <th>Field Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>id</td> <td>Unique identifier for the entry</td> </tr> <tr> <td>to_zipcode</td> <td>Destination ZIP code</td> </tr> <tr> <td>status</td> <td>Status of the entry (created, completed, rejected)</td> </tr> <tr> <td>rejected_reason</td> <td>Reason for rejection</td> </tr> <tr> <td>created_at</td> <td>Date and time when the entry was created</td> </tr> <tr> <td>memo</td> <td>Additional notes or comments</td> </tr> <tr> <td>to_city_id</td> <td>ID of the destination city</td> </tr> <tr> <td>intermodal_region_id</td> <td>ID of the intermodal region</td> </tr> <tr> <td>intermodal_region</td> <td>Name of the intermodal region</td> </tr> <tr> <td>to_city</td> <td>Destination city</td> </tr> <tr> <td>rate</td> <td>Information about the rate, including its ID, base rate, fuel surcharge, truck rate, expiry date, terminals, scenarios, and possible charges</td> </tr> </tbody> </table>

页面列表

ITEM_HTML