Create Order
<h2>Overview</h2>
<p>This endpoint is used to create new orders with detailed information about the shipment, including container details, delivery information, contact emails, and more.</p>
<h2>Request</h2>
<ul>
<li>Method: <strong>POST</strong></li>
<li>URI: <code>/newOrder</code></li>
</ul>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>mbl_number (*)</td>
<td>String</td>
<td>The MBL#</td>
</tr>
<tr>
<td>rate_id (*)</td>
<td>String</td>
<td>The id of Rate</td>
</tr>
<tr>
<td>destination_type</td>
<td>Integer</td>
<td>The Destination Type. 1: Ocean Port, 2: Ramp Port, Default: 1</td>
</tr>
<tr>
<td>live_or_drop</td>
<td>Integer</td>
<td>Live or Drop. 0: Unkown, 1: Live, 2: Drop, Default: 0</td>
</tr>
<tr>
<td>port_of_discharge_id (*)</td>
<td>Integer</td>
<td>Port of Discharge (Intermodal Region)</td>
</tr>
<tr>
<td>port_of_discharge_eta (*)</td>
<td>Date</td>
<td>POD ETA</td>
</tr>
<tr>
<td>final_port_id (*?)</td>
<td>Integer</td>
<td>Final Port (Intermodal Region), Required if destination_type is ramp port</td>
</tr>
<tr>
<td>final_port_eta (*?)</td>
<td>Date</td>
<td>Final Port ETA, Required if destination_type is ramp port</td>
</tr>
<tr>
<td>warehouse_id</td>
<td>Integer</td>
<td>The ID of Warehouse <br/> <strong>Required when delivery_address is null.</strong></td>
</tr>
<tr>
<td>delivery_address</td>
<td>string</td>
<td>delivery address <br/> <strong>Required when warehouse_id is null.</strong></td>
</tr>
<tr>
<td>pu_number_agent_id</td>
<td>Integer</td>
<td>The ID of Pickup Number Agent</td>
</tr>
<tr>
<td>customer_reference_number (*)</td>
<td>String</td>
<td>Customer Reference Number</td>
</tr>
<tr>
<td>customer_memo</td>
<td>String</td>
<td>Customer Memo</td>
</tr>
<tr>
<td>terminal_firms_code</td>
<td>String</td>
<td>Terminal Firms Code</td>
</tr>
<tr>
<td>urgent</td>
<td>Boolean</td>
<td>Urgent, Default False</td>
</tr>
<tr>
<td>contact_emails</td>
<td>Array<String></td>
<td>Array of Contact Emails</td>
</tr>
<tr>
<td>containers (*)</td>
<td>Array</td>
<td>Array of Container</td>
</tr>
<tr>
<td>containers[number] (*)</td>
<td>String</td>
<td>Container Number, Four Letters + Seven Numbers</td>
</tr>
<tr>
<td>containers[type] (*)</td>
<td>String</td>
<td>Size Type: 20GP, 40HC, 45HC...</td>
</tr>
<tr>
<td>containers[seal_number]</td>
<td>String</td>
<td>Seal Number</td>
</tr>
<tr>
<td>containers[package] (*)</td>
<td>String</td>
<td>Package: 20 Cartons, 100 Boxes...</td>
</tr>
<tr>
<td>containers[weight] (*)</td>
<td>Numeric</td>
<td>Weight KG</td>
</tr>
<tr>
<td>containers[delivery_reference]</td>
<td>String</td>
<td>Delivery Reference</td>
</tr>
<tr>
<td>containers[urgent]</td>
<td>Boolean</td>
<td>Urgent, Default False</td>
</tr>
<tr>
<td>containers[is_dg]</td>
<td>Boolean</td>
<td>Danger Goods, Default False</td>
</tr>
<tr>
<td>containers[is_soc]</td>
<td>Boolean</td>
<td>SOC Container, Default False</td>
</tr>
<tr>
<td>containers[is_overweight]</td>
<td>Boolean</td>
<td>Overweight Container, Default False</td>
</tr>
<tr>
<td>containers[is_reefer]</td>
<td>Boolean</td>
<td>Reefer Container, Default False</td>
</tr>
<tr>
<td>containers[commodity]</td>
<td>Array<String></td>
<td>Array of commodity</td>
</tr>
<tr>
<td><del>files</del></td>
<td>Array</td>
<td>The files field is <code>deprecated</code> and should not be used. It was previously used as an array of files, with a maximum size of 10MB. If applicable, include the header 'Content-Type': 'multipart/form-data'</td>
</tr>
<tr>
<td>file_list</td>
<td>Array</td>
<td>Array of upload files list</td>
</tr>
<tr>
<td>file_list[file]</td>
<td>File</td>
<td>File, Max Size 10M. Please add Header "Content-Type": "multipart/form-data" if applicable</td>
</tr>
<tr>
<td>file_list[type]</td>
<td>Enum</td>
<td>type should be one of the following: DO, DG form, Packing List, MBL, Telex, PU#, SOC Return Guarantee Letter, Arrival Notice, or Other.</td>
</tr>
</tbody>
</table>
<p>> <code>(*)</code> it means the field is required.<br/>
> <code>(*?)</code> it means the field is conditionally required.<br/>
> <strong>Either warehouse_id or delivery_address must be present.</strong></p>
<h2>Code Example</h2>
<pre><code>Request:
curl --location --request POST 'https://api.drayeasy.com/api/v2/newOrder' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
--data-raw '{
&quot;mbl_number&quot;: &quot;MEDU1235435&quot;,
&quot;rate_id&quot;: &quot;S115&quot;,
&quot;commodity&quot;: &quot;commodity&quot;,
&quot;destination_type&quot;: 1,
&quot;port_of_discharge_id&quot;: 94,
&quot;port_of_discharge_eta&quot;: &quot;2023-05-01&quot;,
&quot;delivery_address&quot;: &quot;delivery_address&quot;,
&quot;customer_reference_number&quot;: &quot;customer_reference_number&quot;,
&quot;customer_memo&quot;: &quot;TEST&quot;,
&quot;pu_number_agent_id&quot;: 4,
&quot;containers&quot;: [
{
&quot;number&quot;: &quot;MEDU1234567&quot;,
&quot;type&quot;: &quot;40HC&quot;
}
],
&quot;warehouse_id&quot;: 2386,
&quot;contact_emails&quot;: [&quot;test@test.com&quot;, &quot;test2@test.comd&quot;]
}'
Response:
HTTP/1.1 201 OK
Content-Type: application/json; charset=utf-8
{
&quot;data&quot;: {
{
&quot;id&quot;: 9079,
&quot;mbl_number&quot;: 'MEDU12341232131',
&quot;status&quot;: &quot;open&quot;,
&quot;urgent&quot;: false,
&quot;delivery_address&quot;: &quot;delivery_address&quot;,
&quot;customer_reference_number&quot;: &quot;customer_reference_number&quot;,
&quot;customer_memo&quot;: &quot;TEST&quot;,
&quot;released_status&quot;: &quot;Not Released&quot;,
&quot;destination_type&quot;: 2,
&quot;destination_type_name&quot;: &quot;Ramp Port&quot;,
&quot;port_of_discharge_eta&quot;: &quot;2023-09-13&quot;,
&quot;port_of_discharge&quot;: {
&quot;id&quot;: 82,
&quot;name&quot;: &quot;Atlanta - GA&quot;,
&quot;city&quot;: &quot;Atlanta, GA, USA&quot;,
&quot;latitude&quot;: 33.80446,
&quot;longitude&quot;: -84.499501,
&quot;has_ocean_port&quot;: null,
&quot;has_ramp_port&quot;: true
},
&quot;final_port_eta&quot;: &quot;2023-10-06&quot;,
&quot;final_port&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;commodity&quot;: &quot;commodity&quot;,
&quot;contact_emails&quot;: [
&quot;test@test.com&quot;,
&quot;test2@test.comd&quot;
],
&quot;terminal_firms_code&quot;: &quot;S478&quot;,
&quot;amount_total&quot;: &quot;606.00&quot;,
&quot;live_or_drop&quot;: 1,
&quot;created_at&quot;: &quot;2023-09-19&quot;,
&quot;user&quot;: {
&quot;name&quot;: &quot;Name1&quot;,
&quot;email&quot;: &quot;email1@email.com&quot;,
&quot;company&quot;: &quot;Company1&quot;
},
&quot;containers&quot;: [
{
&quot;id&quot;: 11482,
&quot;number&quot;: &quot;MEDU1234567&quot;,
&quot;type&quot;: &quot;40HC&quot;,
&quot;package&quot;: null,
&quot;weight&quot;: null,
&quot;delivery_reference&quot;: &quot;delivery_reference&quot;,
&quot;urgent&quot;: false,
&quot;is_dg&quot;: false,
&quot;is_soc&quot;: false,
&quot;is_overweight&quot;: false,
&quot;is_reefer&quot;: false,
&quot;is_arrival_on_time&quot;: false,
&quot;is_all_released&quot;: false,
&quot;live_or_drop&quot;: 1,
&quot;shipping_events&quot;: [],
&quot;seal_number&quot;: null,
&quot;destination_type&quot;: 2,
&quot;destination_type_name&quot;: &quot;Ramp Port&quot;,
&quot;port_of_loading_etd&quot;: null,
&quot;port_of_discharge_eta&quot;: &quot;2023-09-13&quot;,
&quot;final_port_eta&quot;: &quot;2023-10-06&quot;,
&quot;lfd&quot;: null,
&quot;empty_returned_at&quot;: null,
&quot;ready_to_pickup_at&quot;: null,
&quot;freight_released_at&quot;: null,
&quot;customs_released_at&quot;: null,
&quot;terminal_released_at&quot;: null,
&quot;terminal_pickuped_at&quot;: null,
&quot;actual_delivered_at&quot;: null,
&quot;actual_empty_returned_at&quot;: null,
&quot;status&quot;: 2,
&quot;status_text&quot;: &quot;Predelivery Appointment confirmed&quot;,
&quot;status_map&quot;: [
{
&quot;status&quot;: 0,
&quot;status_text&quot;: &quot;Order Confirmed&quot;,
&quot;updated_at&quot;: &quot;2023-10-13&quot;
},
{
&quot;status&quot;: 1,
&quot;status_text&quot;: &quot;Predelivery Appointment sent&quot;,
&quot;updated_at&quot;: &quot;2023-10-13&quot;
},
{
&quot;status&quot;: 2,
&quot;status_text&quot;: &quot;Predelivery Appointment confirmed&quot;,
&quot;updated_at&quot;: &quot;2023-10-13&quot;
},
{
&quot;status&quot;: 34,
&quot;status_text&quot;: &quot;Available&quot;,
&quot;updated_at&quot;: null
},
{
&quot;status&quot;: 55,
&quot;status_text&quot;: &quot;WHS Apt Made by Customer&quot;,
&quot;updated_at&quot;: null
},
{
&quot;status&quot;: 56,
&quot;status_text&quot;: &quot;Outgated&quot;,
&quot;updated_at&quot;: null
},
{
&quot;status&quot;: 38,
&quot;status_text&quot;: &quot;Prepull to yard&quot;,
&quot;updated_at&quot;: null
},
{
&quot;status&quot;: 41,
&quot;status_text&quot;: &quot;Deliver to Destination&quot;,
&quot;updated_at&quot;: null
},
{
&quot;status&quot;: 46,
&quot;status_text&quot;: &quot;Empty Returned to terminal/depot&quot;,
&quot;updated_at&quot;: null
}
],
&quot;remark_to_customer&quot;: null,
&quot;invoices&quot;: [
{
&quot;id&quot;: 13730,
&quot;uid&quot;: &quot;IV13730&quot;,
&quot;status&quot;: &quot;estimate&quot;,
&quot;due_at&quot;: &quot;2023-09-13&quot;,
&quot;invoiced_at&quot;: &quot;2023-09-13&quot;,
&quot;charges&quot;: [
{
&quot;qty&quot;: 1,
&quot;code&quot;: &quot;TRUCH&quot;,
&quot;name&quot;: &quot;TRUCKING / DRAYAGE CHARGE&quot;,
&quot;rate&quot;: 535,
&quot;reason&quot;: &quot;test&quot;,
&quot;documents&quot;: [
{
&quot;id&quot;: 785,
&quot;type&quot;: &quot;Unknown&quot;,
&quot;is_customer_upload&quot;: false,
&quot;url&quot;: &quot;https://api.drayeasy.com/api/v2/orders/13730/files/785&quot;,
&quot;filename&quot;: &quot;16sucai_P591F3C147-(2).JPG&quot;
}
],
&quot;container_number&quot;: &quot;TEST2000001&quot;,
&quot;container_id&quot;: 7852
},
{
&quot;qty&quot;: 2,
&quot;code&quot;: &quot;CHAFE&quot;,
&quot;name&quot;: &quot;CHASSIS FEE&quot;,
&quot;rate&quot;: &quot;45&quot;,
&quot;reason&quot;: null,
&quot;documents&quot;: [],
&quot;container_number&quot;: &quot;TEST2000001&quot;,
&quot;container_id&quot;: 7852
}
],
&quot;amount_due&quot;: &quot;625.00&quot;,
&quot;amount_paid&quot;: &quot;0.00&quot;,
&quot;amount_total&quot;: &quot;625.00&quot;
},
...
],
&quot;scenarios&quot;: [
{
&quot;name&quot;: &quot;Best Scenario CHICAGO&quot;,
&quot;rates&quot;: [
{
&quot;qty&quot;: 1,
&quot;name&quot;: &quot;Base Rate&quot;,
&quot;rate&quot;: &quot;523.00&quot;,
&quot;unit&quot;: &quot;CNTR&quot;,
&quot;amount&quot;: &quot;523.00&quot;
},
...
],
&quot;total_rate&quot;: &quot;684.00&quot;,
&quot;description&quot;: &quot;Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n2 Days Chassis Usage&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;: &quot;2&quot;,
&quot;amount&quot;: &quot;90.00&quot;,
&quot;statement&quot;: &quot;Chassis Usage 2 Days&quot;,
&quot;probability&quot;: &quot;0.97&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;cntr_size&quot;: [
0
],
&quot;probability&quot;: &quot;0.97&quot;
},
...
]
}
],
&quot;pickup_number_agent&quot;: {
&quot;id&quot;: 4,
&quot;name&quot;: &quot;test create pu&quot;,
&quot;emails&quot;: [
&quot;email1@agent.com&quot;
],
&quot;user_id&quot;: 1,
&quot;user&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Name1&quot;,
&quot;company&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Company1&quot;
}
}
},
&quot;warehouse&quot;: {
&quot;id&quot;: 2386,
&quot;name&quot;: &quot;test draweer&quot;,
&quot;code&quot;: &quot;132323&quot;,
&quot;zipcode&quot;: &quot;1002&quot;,
&quot;appointment_by&quot;: 0,
&quot;customer_memo&quot;: null,
&quot;live_or_drop&quot;: 0,
&quot;address&quot;: &quot;ddddd&quot;,
&quot;delivery_order_address&quot;: &quot;test draweer\nddddd\nWEST NEW YORK, NJ, USA 1002\nKDDS 333443432 333@qq.c\nwrwer rwr aa@qq.com&quot;,
&quot;created_at&quot;: &quot;2023-05-26T03:31:49.000000Z&quot;,
&quot;user&quot;: {
&quot;name&quot;: &quot;name33&quot;,
&quot;email&quot;: &quot;name33@email.com&quot;,
&quot;company&quot;: &quot;Company1&quot;
},
&quot;city&quot;: {
&quot;id&quot;: 2753,
&quot;country&quot;: &quot;USA&quot;,
&quot;full_name&quot;: &quot;West New York, NJ, USA&quot;,
&quot;name&quot;: &quot;WEST NEW YORK&quot;,
&quot;state&quot;: &quot;NJ&quot;,
&quot;alias&quot;: null,
&quot;latitude&quot;: 40.788192,
&quot;longitude&quot;: -74.012859
},
&quot;contacts&quot;: [
{
&quot;id&quot;: 1409,
&quot;name&quot;: &quot;KDDS&quot;,
&quot;type&quot;: [
&quot;DISPATCH&quot;
],
&quot;phone&quot;: &quot;333443432&quot;,
&quot;email&quot;: &quot;333@qq.c&quot;,
&quot;remark&quot;: null
},
...
]
},
&quot;rate_id&quot;: &quot;S115&quot;,
&quot;rate&quot;: {
&quot;base_rate&quot;: 1320,
&quot;fuel_surcharge&quot;: 0,
&quot;toll_fee&quot;: &quot;43.00&quot;
},
&quot;scenarios&quot;: [
{
&quot;name&quot;: &quot;Best Scenario Los Angeles&quot;,
&quot;rates&quot;: [
{
&quot;name&quot;: &quot;Base Rate&quot;,
&quot;rate&quot;: &quot;1320.00&quot;,
&quot;unit&quot;: &quot;CNTR&quot;,
&quot;qty&quot;: 1,
&quot;amount&quot;: &quot;1320.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;total_rate&quot;: 1915,
&quot;description&quot;: &quot;Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n3 Days Chassis Usage\nPierpass and Clean Truck Fee&quot;,
&quot;possible_charges&quot;: [
{
&quot;code&quot;: &quot;CHAFE&quot;,
&quot;name&quot;: &quot;CHASSIS FEE&quot;,
&quot;explanation&quot;: &quot;3 days min, $75/Day (Over 3 Days, if WCCP Chassis)&quot;,
&quot;rate&quot;: &quot;50&quot;,
&quot;qty&quot;: 3,
&quot;amount&quot;: &quot;150.00&quot;,
&quot;unit&quot;: &quot;DAY&quot;,
&quot;rate_text&quot;: &quot;50.00/DAYx3 3 DAYs MIN&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;cntr_size&quot;: [
0
],
&quot;probability&quot;: &quot;0.97&quot;
},
...
]
},
}
}</code></pre>
<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 order</td>
</tr>
<tr>
<td>mbl_number</td>
<td>MBL numbr</td>
</tr>
<tr>
<td>status</td>
<td>Status of the order</td>
</tr>
<tr>
<td>urgent</td>
<td>Indicates if the order is urgent</td>
</tr>
<tr>
<td>delivery_address</td>
<td>Delivery address for the order</td>
</tr>
<tr>
<td>customer_reference_number</td>
<td>Customer reference number</td>
</tr>
<tr>
<td>customer_memo</td>
<td>Additional memo or notes</td>
</tr>
<tr>
<td>released_status</td>
<td>Status indicating if the order has been released</td>
</tr>
<tr>
<td>destination_type</td>
<td>Type of destination</td>
</tr>
<tr>
<td>port_of_discharge_eta</td>
<td>Estimated Time of Arrival (ETA) at the port of discharge</td>
</tr>
<tr>
<td>port_of_discharge</td>
<td>Details about the port of discharge, including ID, name, city, latitude, and longitude</td>
</tr>
<tr>
<td>final_port_eta</td>
<td>ETA at the final port</td>
</tr>
<tr>
<td>final_port</td>
<td>Details about the final port, including ID, name, city, latitude, and longitude</td>
</tr>
<tr>
<td>commodity</td>
<td>Description of the commodity being shipped</td>
</tr>
<tr>
<td>contact_emails</td>
<td>Email addresses for contacts related to the order</td>
</tr>
<tr>
<td>terminal_firms_code</td>
<td>Firms code for the terminal</td>
</tr>
<tr>
<td>amount_total</td>
<td>Total amount for the order</td>
</tr>
<tr>
<td>live_or_drop</td>
<td>Indicates if it's a live unload or drop</td>
</tr>
<tr>
<td>created_at</td>
<td>Date and time when the order was created</td>
</tr>
<tr>
<td>user</td>
<td>Details about the user associated with the order, including name, email, and company</td>
</tr>
<tr>
<td>containers</td>
<td>Information about containers included in the order, including ID, number, type, and status</td>
</tr>
<tr>
<td>pickup_number_agent</td>
<td>Details about the pickup number agent, including ID, name, and emails</td>
</tr>
<tr>
<td>warehouse</td>
<td>Details about the warehouse, including ID, name, code, address, and contacts</td>
</tr>
<tr>
<td>rate_id</td>
<td>ID of the rate associated with the order</td>
</tr>
<tr>
<td>rate</td>
<td>Details about the rate, including base rate, fuel surcharge, and toll fee</td>
</tr>
<tr>
<td>scenarios</td>
<td>Information about scenarios for the order, including rates, total rate, and possible charges</td>
</tr>
<tr>
<td>possible_charges</td>
<td>Possible charges associated with the order, including code, name, rate, and explanation</td>
</tr>
</tbody>
</table>
<h2>Port of Discharge Object</h2>
<table>
<thead>
<tr>
<th>Field Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>The ID of the port of discharge</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the port of discharge</td>
</tr>
<tr>
<td>city</td>
<td>String</td>
<td>The city where the port of discharge is located</td>
</tr>
<tr>
<td>latitude</td>
<td>Float</td>
<td>The latitude coordinate of the port of discharge</td>
</tr>
<tr>
<td>longitude</td>
<td>Float</td>
<td>The longitude coordinate of the port of discharge</td>
</tr>
<tr>
<td>has_ocean_port</td>
<td>Boolean</td>
<td>Indicates if the port has an ocean port (may be null)</td>
</tr>
<tr>
<td>has_ramp_port</td>
<td>Boolean</td>
<td>Indicates if the port has a ramp port (true/false)</td>
</tr>
</tbody>
</table>
<h2>Final Port Object</h2>
<table>
<thead>
<tr>
<th>Field Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>The ID of the final port</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the final port</td>
</tr>
<tr>
<td>city</td>
<td>String</td>
<td>The city where the final port is located</td>
</tr>
<tr>
<td>latitude</td>
<td>Float</td>
<td>The latitude coordinate of the final port</td>
</tr>
<tr>
<td>longitude</td>
<td>Float</td>
<td>The longitude coordinate of the final port</td>
</tr>
<tr>
<td>has_ocean_port</td>
<td>Boolean</td>
<td>Indicates if the final port has an ocean port (may be null)</td>
</tr>
<tr>
<td>has_ramp_port</td>
<td>Boolean</td>
<td>Indicates if the final port has a ramp port (true/false)</td>
</tr>
</tbody>
</table>
<h2>User Object</h2>
<table>
<thead>
<tr>
<th>Field Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the entity (e.g., person, company)</td>
</tr>
<tr>
<td>email</td>
<td>String</td>
<td>The email address of the entity</td>
</tr>
<tr>
<td>company</td>
<td>String</td>
<td>The name of the company associated with the entity</td>
</tr>
</tbody>
</table>
<h2>Container Object</h2>
<table>
<thead>
<tr>
<th>Field Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>The unique identifier of the container</td>
</tr>
<tr>
<td>number</td>
<td>String</td>
<td>The container number</td>
</tr>
<tr>
<td>type</td>
<td>String</td>
<td>The size/type of the container (e.g., 40HC, 20GP)</td>
</tr>
<tr>
<td>package</td>
<td>String</td>
<td>The package information of the cargo</td>
</tr>
<tr>
<td>weight</td>
<td>String</td>
<td>The weight of the cargo in KG</td>
</tr>
<tr>
<td>delivery_reference</td>
<td>String</td>
<td>The delivery reference information</td>
</tr>
<tr>
<td>urgent</td>
<td>Boolean</td>
<td>Indicates if the container is urgent (True/False)</td>
</tr>
<tr>
<td>is_dg</td>
<td>Boolean</td>
<td>Indicates if the container contains dangerous goods (True/False)</td>
</tr>
<tr>
<td>is_soc</td>
<td>Boolean</td>
<td>Indicates if the container is a SOC container (True/False)</td>
</tr>
<tr>
<td>is_overweight</td>
<td>Boolean</td>
<td>Indicates if the container is overweight (True/False)</td>
</tr>
<tr>
<td>is_reefer</td>
<td>Boolean</td>
<td>Indicates if the container is a reefer container (True/False)</td>
</tr>
<tr>
<td>is_arrival_on_time</td>
<td>Boolean</td>
<td>Indicates if the arrival is on time (True/False)</td>
</tr>
<tr>
<td>is_all_released</td>
<td>Boolean</td>
<td>Indicates if all items are released (True/False)</td>
</tr>
<tr>
<td>live_or_drop</td>
<td>Integer</td>
<td>Live or Drop status (0: Unknown, 1: Live, 2: Drop)</td>
</tr>
<tr>
<td>shipping_events</td>
<td>Array</td>
<td>Array of shipping events</td>
</tr>
<tr>
<td>seal_number</td>
<td>String</td>
<td>The seal number of the container</td>
</tr>
<tr>
<td>destination_type</td>
<td>Integer</td>
<td>Destination type (1: Ocean Port, 2: Ramp Port)</td>
</tr>
<tr>
<td>destination_type_name</td>
<td>String</td>
<td>Name of the destination type</td>
</tr>
<tr>
<td>port_of_loading_etd</td>
<td>Date</td>
<td>Port of Loading Estimated Time of Departure</td>
</tr>
<tr>
<td>port_of_discharge_eta</td>
<td>Date</td>
<td>Port of Discharge Estimated Time of Arrival</td>
</tr>
<tr>
<td>final_port_eta</td>
<td>Date</td>
<td>Final Port Estimated Time of Arrival</td>
</tr>
<tr>
<td>lfd</td>
<td>Date</td>
<td>Last Free Date</td>
</tr>
<tr>
<td>empty_returned_at</td>
<td>Date</td>
<td>Empty Container Returned At</td>
</tr>
<tr>
<td>ready_to_pickup_at</td>
<td>Date</td>
<td>Ready to Pickup At</td>
</tr>
<tr>
<td>freight_released_at</td>
<td>Date</td>
<td>Freight Released At</td>
</tr>
<tr>
<td>customs_released_at</td>
<td>Date</td>
<td>Customs Released At</td>
</tr>
<tr>
<td>terminal_released_at</td>
<td>Date</td>
<td>Terminal Released At</td>
</tr>
<tr>
<td>terminal_pickuped_at</td>
<td>Date</td>
<td>Terminal Pickuped At</td>
</tr>
<tr>
<td>actual_delivered_at</td>
<td>Date</td>
<td>Actual Delivered At</td>
</tr>
<tr>
<td>actual_empty_returned_at</td>
<td>Date</td>
<td>Actual Empty Container Returned At</td>
</tr>
<tr>
<td>status</td>
<td>Integer</td>
<td>Status code</td>
</tr>
<tr>
<td>status_text</td>
<td>String</td>
<td>Status text</td>
</tr>
<tr>
<td>status_map</td>
<td>Array</td>
<td>Array of status mapping objects</td>
</tr>
<tr>
<td>remark_to_customer</td>
<td>String</td>
<td>Remark to Customer</td>
</tr>
<tr>
<td>invoices</td>
<td>Array</td>
<td>Array of invoice objects</td>
</tr>
<tr>
<td>scenarios</td>
<td>Array</td>
<td>Array of scenario objects</td>
</tr>
<tr>
<td>possible_charges</td>
<td>Array</td>
<td>Array of possible charges objects</td>
</tr>
</tbody>
</table>
<h2>Invoice Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>The unique identifier of the invoice.</td>
</tr>
<tr>
<td>uid</td>
<td>The unique identifier of the invoice.</td>
</tr>
<tr>
<td>status</td>
<td>The status of the invoice (e.g., "estimate").</td>
</tr>
<tr>
<td>due_at</td>
<td>The due date of the invoice.</td>
</tr>
<tr>
<td>invoiced_at</td>
<td>The date when the invoice was created.</td>
</tr>
<tr>
<td>charges</td>
<td>An array of charges associated with the invoice.</td>
</tr>
<tr>
<td>charges[qty]</td>
<td>The quantity of the charge.</td>
</tr>
<tr>
<td>charges[code]</td>
<td>The code of the charge.</td>
</tr>
<tr>
<td>charges[name]</td>
<td>The name of the charge (e.g., "TRUCKING / DRAYAGE CHARGE", "CHASSIS FEE").</td>
</tr>
<tr>
<td>charges[rate]</td>
<td>The rate of the charge.</td>
</tr>
<tr>
<td>charges[reason]</td>
<td>The reason for the charge.</td>
</tr>
<tr>
<td>charges[documents]</td>
<td>An array of documents associated with the charge.</td>
</tr>
<tr>
<td>charges[documents][id]</td>
<td>The unique identifier of the document.</td>
</tr>
<tr>
<td>charges[documents][type]</td>
<td>The type of the document.</td>
</tr>
<tr>
<td>charges[documents][is_customer_upload]</td>
<td>Indicates if the document is uploaded by the customer.</td>
</tr>
<tr>
<td>charges[documents][url]</td>
<td>The URL of the document.</td>
</tr>
<tr>
<td>charges[documents][filename]</td>
<td>The filename of the document.</td>
</tr>
<tr>
<td>charges[container_number]</td>
<td>The container number associated with the charge.</td>
</tr>
<tr>
<td>charges[container_id]</td>
<td>The container ID associated with the charge.</td>
</tr>
<tr>
<td>amount_due</td>
<td>The amount due for the invoice.</td>
</tr>
<tr>
<td>amount_paid</td>
<td>The amount paid for the invoice.</td>
</tr>
<tr>
<td>amount_total</td>
<td>The total amount of the invoice.</td>
</tr>
</tbody>
</table>
<h2>Scenario Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>The name of the scenario ("Best Scenario CHICAGO" in this case).</td>
</tr>
<tr>
<td>rates</td>
<td>An array of rates associated with the scenario.</td>
</tr>
<tr>
<td>rates[qty]</td>
<td>The quantity of the rate.</td>
</tr>
<tr>
<td>rates[name]</td>
<td>The name of the rate (e.g., "Base Rate").</td>
</tr>
<tr>
<td>rates[rate]</td>
<td>The rate amount.</td>
</tr>
<tr>
<td>rates[unit]</td>
<td>The unit of the rate (e.g., "CNTR" for container).</td>
</tr>
<tr>
<td>rates[amount]</td>
<td>The total amount for the rate.</td>
</tr>
<tr>
<td>total_rate</td>
<td>The total rate amount for the scenario.</td>
</tr>
<tr>
<td>description</td>
<td>The description of the scenario (e.g., "Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n2 Days Chassis Usage").</td>
</tr>
<tr>
<td>possible_charges</td>
<td>An array of possible charges associated with the scenario.</td>
</tr>
<tr>
<td>possible_charges[code]</td>
<td>The code of the possible charge.</td>
</tr>
<tr>
<td>possible_charges[name]</td>
<td>The name of the possible charge (e.g., "CHASSIS FEE").</td>
</tr>
<tr>
<td>possible_charges[explanation]</td>
<td>The explanation for the possible charge.</td>
</tr>
<tr>
<td>possible_charges[rate]</td>
<td>The rate amount for the possible charge.</td>
</tr>
<tr>
<td>possible_charges[unit]</td>
<td>The unit of the possible charge.</td>
</tr>
<tr>
<td>possible_charges[rate_text]</td>
<td>The rate text for the possible charge.</td>
</tr>
<tr>
<td>possible_charges[free]</td>
<td>Indicates if the charge is free.</td>
</tr>
<tr>
<td>possible_charges[min]</td>
<td>The minimum quantity required for the charge.</td>
</tr>
<tr>
<td>possible_charges[max]</td>
<td>The maximum quantity allowed for the charge.</td>
</tr>
<tr>
<td>possible_charges[cntr_size]</td>
<td>An array of container sizes associated with the charge.</td>
</tr>
<tr>
<td>possible_charges[qty]</td>
<td>The quantity of the charge.</td>
</tr>
<tr>
<td>possible_charges[amount]</td>
<td>The total amount for the charge.</td>
</tr>
<tr>
<td>possible_charges[statement]</td>
<td>The statement describing the charge.</td>
</tr>
<tr>
<td>possible_charges[probability]</td>
<td>The probability of the charge.</td>
</tr>
</tbody>
</table>
<h2>Possible Charge Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>The code of the charge.</td>
</tr>
<tr>
<td>name</td>
<td>The name of the charge.</td>
</tr>
<tr>
<td>explanation</td>
<td>The explanation for the charge.</td>
</tr>
<tr>
<td>rate</td>
<td>The rate amount for the charge.</td>
</tr>
<tr>
<td>unit</td>
<td>The unit of the charge.</td>
</tr>
<tr>
<td>rate_text</td>
<td>The rate text for the charge.</td>
</tr>
<tr>
<td>free</td>
<td>Indicates if the charge is free.</td>
</tr>
<tr>
<td>min</td>
<td>The minimum quantity required for the charge.</td>
</tr>
<tr>
<td>max</td>
<td>The maximum quantity allowed for the charge.</td>
</tr>
<tr>
<td>cntr_size</td>
<td>An array of container sizes associated with the charge.</td>
</tr>
<tr>
<td>probability</td>
<td>The probability of the charge.</td>
</tr>
</tbody>
</table>
<h2>Pickup Number Agent Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>The ID of the pickup number agent.</td>
</tr>
<tr>
<td>name</td>
<td>The name of the pickup number agent.</td>
</tr>
<tr>
<td>emails</td>
<td>An array of email addresses associated with the agent.</td>
</tr>
<tr>
<td>user_id</td>
<td>The ID of the user associated with the agent.</td>
</tr>
<tr>
<td>user</td>
<td>Information about the user associated with the agent, including their ID, name, and company details.</td>
</tr>
</tbody>
</table>
<h2>Warehouse Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>The ID of the warehouse.</td>
</tr>
<tr>
<td>name</td>
<td>The name of the warehouse.</td>
</tr>
<tr>
<td>code</td>
<td>The code associated with the warehouse.</td>
</tr>
<tr>
<td>zipcode</td>
<td>The postal code of the warehouse.</td>
</tr>
<tr>
<td>appointment_by</td>
<td>Appointment details.</td>
</tr>
<tr>
<td>customer_memo</td>
<td>Any memo or notes from the customer .</td>
</tr>
<tr>
<td>live_or_drop</td>
<td>Live or drop status.</td>
</tr>
<tr>
<td>address</td>
<td>The address of the warehouse.</td>
</tr>
<tr>
<td>delivery_order_address</td>
<td>The detailed delivery order address for the warehouse.</td>
</tr>
<tr>
<td>created_at</td>
<td>The timestamp when the warehouse was created.</td>
</tr>
<tr>
<td>user</td>
<td>Information about the user associated with the warehouse, including their name, email, and company details.</td>
</tr>
<tr>
<td>city</td>
<td>Information about the city where the warehouse is located, including ID, name, state, country, and geographical coordinates.</td>
</tr>
<tr>
<td>contacts</td>
<td>An array of contacts associated with the warehouse, including ID, name, type, phone number, email, and remarks.</td>
</tr>
</tbody>
</table>
<h2>Rate Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>base_rate</td>
<td>The base rate associated with the rate.</td>
</tr>
<tr>
<td>fuel_surcharge</td>
<td>The fuel surcharge, if any</td>
</tr>
<tr>
<td>toll_fee</td>
<td>The toll fee associated with the rate.</td>
</tr>
</tbody>
</table>