DrayEasy API v2

DrayEasy API v2


Get Orders

<h2>Overview</h2> <p>This endpoint retrieves a list of orders with fields which allow users to query orders based on specific criteria such as order ID, MBL number, container number, or customer reference number. Pagination is also supported with default values for page and per_page parameters</p> <h2>Request</h2> <ul> <li>Method: <strong>GET</strong></li> <li>URI: <code>/orders</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 Order</td> </tr> <tr> <td>mbl_number</td> <td>String</td> <td>The MBL#</td> </tr> <tr> <td>container_number</td> <td>String</td> <td>The Container Number</td> </tr> <tr> <td>customer_reference_number</td> <td>String</td> <td>The Customer Reference Number</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/orders \ --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;: 9079, &amp;quot;mbl_number&amp;quot;: 'MEDU12341232131', &amp;quot;status&amp;quot;: &amp;quot;open&amp;quot;, &amp;quot;urgent&amp;quot;: false, &amp;quot;delivery_address&amp;quot;: &amp;quot;delivery_address&amp;quot;, &amp;quot;customer_reference_number&amp;quot;: &amp;quot;customer_reference_number&amp;quot;, &amp;quot;customer_memo&amp;quot;: &amp;quot;TEST&amp;quot;, &amp;quot;released_status&amp;quot;: &amp;quot;Not Released&amp;quot;, &amp;quot;destination_type&amp;quot;: 2, &amp;quot;destination_type_name&amp;quot;: &amp;quot;Ramp Port&amp;quot;, &amp;quot;port_of_discharge_eta&amp;quot;: &amp;quot;2023-09-13&amp;quot;, &amp;quot;port_of_discharge&amp;quot;: { &amp;quot;id&amp;quot;: 82, &amp;quot;name&amp;quot;: &amp;quot;Atlanta - GA&amp;quot;, &amp;quot;city&amp;quot;: &amp;quot;Atlanta, GA, USA&amp;quot;, &amp;quot;latitude&amp;quot;: 33.80446, &amp;quot;longitude&amp;quot;: -84.499501, &amp;quot;has_ocean_port&amp;quot;: null, &amp;quot;has_ramp_port&amp;quot;: true }, &amp;quot;final_port_eta&amp;quot;: &amp;quot;2023-10-06&amp;quot;, &amp;quot;final_port&amp;quot;: { &amp;quot;id&amp;quot;: 77, &amp;quot;name&amp;quot;: &amp;quot;Chicago - IL&amp;quot;, &amp;quot;city&amp;quot;: &amp;quot;Chicago, IL, USA&amp;quot;, &amp;quot;latitude&amp;quot;: 41.642854, &amp;quot;longitude&amp;quot;: -87.868063, &amp;quot;has_ocean_port&amp;quot;: null, &amp;quot;has_ramp_port&amp;quot;: true }, &amp;quot;commodity&amp;quot;: &amp;quot;commodity&amp;quot;, &amp;quot;contact_emails&amp;quot;: [ &amp;quot;test@test.com&amp;quot;, &amp;quot;test2@test.comd&amp;quot; ], &amp;quot;terminal_firms_code&amp;quot;: &amp;quot;S478&amp;quot;, &amp;quot;amount_total&amp;quot;: &amp;quot;606.00&amp;quot;, &amp;quot;live_or_drop&amp;quot;: 1, &amp;quot;created_at&amp;quot;: &amp;quot;2023-09-19&amp;quot;, &amp;quot;user&amp;quot;: { &amp;quot;name&amp;quot;: &amp;quot;Name1&amp;quot;, &amp;quot;email&amp;quot;: &amp;quot;email1@email.com&amp;quot;, &amp;quot;company&amp;quot;: &amp;quot;Company1&amp;quot; }, &amp;quot;containers&amp;quot;: [ { &amp;quot;id&amp;quot;: 11482, &amp;quot;number&amp;quot;: &amp;quot;MEDU1234567&amp;quot;, &amp;quot;type&amp;quot;: &amp;quot;40HC&amp;quot;, &amp;quot;package&amp;quot;: null, &amp;quot;weight&amp;quot;: null, &amp;quot;delivery_reference&amp;quot;: &amp;quot;delivery_reference&amp;quot;, &amp;quot;urgent&amp;quot;: false, &amp;quot;is_dg&amp;quot;: false, &amp;quot;is_soc&amp;quot;: false, &amp;quot;is_overweight&amp;quot;: false, &amp;quot;is_reefer&amp;quot;: false, &amp;quot;is_arrival_on_time&amp;quot;: false, &amp;quot;is_all_released&amp;quot;: false, &amp;quot;live_or_drop&amp;quot;: 1, &amp;quot;shipping_events&amp;quot;: [], &amp;quot;seal_number&amp;quot;: null, &amp;quot;destination_type&amp;quot;: 2, &amp;quot;destination_type_name&amp;quot;: &amp;quot;Ramp Port&amp;quot;, &amp;quot;port_of_loading_etd&amp;quot;: null, &amp;quot;port_of_discharge_eta&amp;quot;: &amp;quot;2023-09-13&amp;quot;, &amp;quot;final_port_eta&amp;quot;: &amp;quot;2023-10-06&amp;quot;, &amp;quot;lfd&amp;quot;: null, &amp;quot;empty_returned_at&amp;quot;: null, &amp;quot;ready_to_pickup_at&amp;quot;: null, &amp;quot;freight_released_at&amp;quot;: null, &amp;quot;customs_released_at&amp;quot;: null, &amp;quot;terminal_released_at&amp;quot;: null, &amp;quot;terminal_pickuped_at&amp;quot;: null, &amp;quot;actual_delivered_at&amp;quot;: null, &amp;quot;actual_empty_returned_at&amp;quot;: null, &amp;quot;status&amp;quot;: 2, &amp;quot;status_text&amp;quot;: &amp;quot;Predelivery Appointment confirmed&amp;quot;, &amp;quot;status_map&amp;quot;: [ { &amp;quot;status&amp;quot;: 0, &amp;quot;status_text&amp;quot;: &amp;quot;Order Confirmed&amp;quot;, &amp;quot;updated_at&amp;quot;: &amp;quot;2023-10-13&amp;quot; }, { &amp;quot;status&amp;quot;: 1, &amp;quot;status_text&amp;quot;: &amp;quot;Predelivery Appointment sent&amp;quot;, &amp;quot;updated_at&amp;quot;: &amp;quot;2023-10-13&amp;quot; }, { &amp;quot;status&amp;quot;: 2, &amp;quot;status_text&amp;quot;: &amp;quot;Predelivery Appointment confirmed&amp;quot;, &amp;quot;updated_at&amp;quot;: &amp;quot;2023-10-13&amp;quot; }, { &amp;quot;status&amp;quot;: 34, &amp;quot;status_text&amp;quot;: &amp;quot;Available&amp;quot;, &amp;quot;updated_at&amp;quot;: null }, { &amp;quot;status&amp;quot;: 55, &amp;quot;status_text&amp;quot;: &amp;quot;WHS Apt Made by Customer&amp;quot;, &amp;quot;updated_at&amp;quot;: null }, { &amp;quot;status&amp;quot;: 56, &amp;quot;status_text&amp;quot;: &amp;quot;Outgated&amp;quot;, &amp;quot;updated_at&amp;quot;: null }, { &amp;quot;status&amp;quot;: 38, &amp;quot;status_text&amp;quot;: &amp;quot;Prepull to yard&amp;quot;, &amp;quot;updated_at&amp;quot;: null }, { &amp;quot;status&amp;quot;: 41, &amp;quot;status_text&amp;quot;: &amp;quot;Deliver to Destination&amp;quot;, &amp;quot;updated_at&amp;quot;: null }, { &amp;quot;status&amp;quot;: 46, &amp;quot;status_text&amp;quot;: &amp;quot;Empty Returned to terminal/depot&amp;quot;, &amp;quot;updated_at&amp;quot;: null } ], &amp;quot;remark_to_customer&amp;quot;: null, &amp;quot;invoices&amp;quot;: [ { &amp;quot;id&amp;quot;: 13730, &amp;quot;uid&amp;quot;: &amp;quot;IV13730&amp;quot;, &amp;quot;status&amp;quot;: &amp;quot;estimate&amp;quot;, &amp;quot;due_at&amp;quot;: &amp;quot;2023-09-13&amp;quot;, &amp;quot;invoiced_at&amp;quot;: &amp;quot;2023-09-13&amp;quot;, &amp;quot;charges&amp;quot;: [ { &amp;quot;qty&amp;quot;: 1, &amp;quot;code&amp;quot;: &amp;quot;TRUCH&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;TRUCKING / DRAYAGE CHARGE&amp;quot;, &amp;quot;rate&amp;quot;: 535, &amp;quot;reason&amp;quot;: &amp;quot;test&amp;quot;, &amp;quot;documents&amp;quot;: [ { &amp;quot;id&amp;quot;: 785, &amp;quot;type&amp;quot;: &amp;quot;Unknown&amp;quot;, &amp;quot;is_customer_upload&amp;quot;: false, &amp;quot;url&amp;quot;: &amp;quot;https://api.drayeasy.com/api/v2/orders/13730/files/785&amp;quot;, &amp;quot;filename&amp;quot;: &amp;quot;16sucai_P591F3C147-(2).JPG&amp;quot; } ], &amp;quot;container_number&amp;quot;: &amp;quot;TEST2000001&amp;quot;, &amp;quot;container_id&amp;quot;: 7852 }, { &amp;quot;qty&amp;quot;: 2, &amp;quot;code&amp;quot;: &amp;quot;CHAFE&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;CHASSIS FEE&amp;quot;, &amp;quot;rate&amp;quot;: &amp;quot;45&amp;quot;, &amp;quot;reason&amp;quot;: null, &amp;quot;documents&amp;quot;: [], &amp;quot;container_number&amp;quot;: &amp;quot;TEST2000001&amp;quot;, &amp;quot;container_id&amp;quot;: 7852 } ], &amp;quot;amount_due&amp;quot;: &amp;quot;625.00&amp;quot;, &amp;quot;amount_paid&amp;quot;: &amp;quot;0.00&amp;quot;, &amp;quot;amount_total&amp;quot;: &amp;quot;625.00&amp;quot; }, ... ], &amp;quot;scenarios&amp;quot;: [ { &amp;quot;name&amp;quot;: &amp;quot;Best Scenario CHICAGO&amp;quot;, &amp;quot;rates&amp;quot;: [ { &amp;quot;qty&amp;quot;: 1, &amp;quot;name&amp;quot;: &amp;quot;Base Rate&amp;quot;, &amp;quot;rate&amp;quot;: &amp;quot;523.00&amp;quot;, &amp;quot;unit&amp;quot;: &amp;quot;CNTR&amp;quot;, &amp;quot;amount&amp;quot;: &amp;quot;523.00&amp;quot; }, ... ], &amp;quot;total_rate&amp;quot;: &amp;quot;684.00&amp;quot;, &amp;quot;description&amp;quot;: &amp;quot;Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n2 Days Chassis Usage&amp;quot;, &amp;quot;possible_charges&amp;quot;: [ { &amp;quot;code&amp;quot;: &amp;quot;CHAFE&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;CHASSIS FEE&amp;quot;, &amp;quot;explanation&amp;quot;: null, &amp;quot;rate&amp;quot;: &amp;quot;45&amp;quot;, &amp;quot;unit&amp;quot;: &amp;quot;DAY&amp;quot;, &amp;quot;rate_text&amp;quot;: &amp;quot;45.00/DAYx2 2 DAYs MIN&amp;quot;, &amp;quot;free&amp;quot;: null, &amp;quot;min&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;max&amp;quot;: null, &amp;quot;cntr_size&amp;quot;: [ 0 ], &amp;quot;qty&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;amount&amp;quot;: &amp;quot;90.00&amp;quot;, &amp;quot;statement&amp;quot;: &amp;quot;Chassis Usage 2 Days&amp;quot;, &amp;quot;probability&amp;quot;: &amp;quot;0.97&amp;quot; } ] }, ... ], &amp;quot;possible_charges&amp;quot;: [ { &amp;quot;code&amp;quot;: &amp;quot;CHAFE&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;CHASSIS FEE&amp;quot;, &amp;quot;explanation&amp;quot;: null, &amp;quot;rate&amp;quot;: &amp;quot;45&amp;quot;, &amp;quot;unit&amp;quot;: &amp;quot;DAY&amp;quot;, &amp;quot;rate_text&amp;quot;: &amp;quot;45.00/DAY 2 DAYs MIN&amp;quot;, &amp;quot;free&amp;quot;: null, &amp;quot;min&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;max&amp;quot;: null, &amp;quot;cntr_size&amp;quot;: [ 0 ], &amp;quot;probability&amp;quot;: &amp;quot;0.97&amp;quot; }, ... ], &amp;quot;commodity&amp;quot;: [ &amp;quot;TEST&amp;quot; ] } ], &amp;quot;pickup_number_agent&amp;quot;: { &amp;quot;id&amp;quot;: 4, &amp;quot;name&amp;quot;: &amp;quot;test create pu&amp;quot;, &amp;quot;emails&amp;quot;: [ &amp;quot;email1@agent.com&amp;quot; ], &amp;quot;user_id&amp;quot;: 1, &amp;quot;user&amp;quot;: { &amp;quot;id&amp;quot;: 1, &amp;quot;name&amp;quot;: &amp;quot;Name1&amp;quot;, &amp;quot;company&amp;quot;: { &amp;quot;id&amp;quot;: 1, &amp;quot;name&amp;quot;: &amp;quot;Company1&amp;quot; } } }, &amp;quot;warehouse&amp;quot;: { &amp;quot;id&amp;quot;: 2386, &amp;quot;name&amp;quot;: &amp;quot;test draweer&amp;quot;, &amp;quot;code&amp;quot;: &amp;quot;132323&amp;quot;, &amp;quot;zipcode&amp;quot;: &amp;quot;1002&amp;quot;, &amp;quot;appointment_by&amp;quot;: 0, &amp;quot;customer_memo&amp;quot;: null, &amp;quot;live_or_drop&amp;quot;: 0, &amp;quot;address&amp;quot;: &amp;quot;ddddd&amp;quot;, &amp;quot;delivery_order_address&amp;quot;: &amp;quot;test draweer\nddddd\nWEST NEW YORK, NJ, USA 1002\nKDDS 333443432 333@qq.c\nwrwer rwr aa@qq.com&amp;quot;, &amp;quot;created_at&amp;quot;: &amp;quot;2023-05-26T03:31:49.000000Z&amp;quot;, &amp;quot;user&amp;quot;: { &amp;quot;name&amp;quot;: &amp;quot;name33&amp;quot;, &amp;quot;email&amp;quot;: &amp;quot;name33@email.com&amp;quot;, &amp;quot;company&amp;quot;: &amp;quot;Company1&amp;quot; }, &amp;quot;city&amp;quot;: { &amp;quot;id&amp;quot;: 2753, &amp;quot;country&amp;quot;: &amp;quot;USA&amp;quot;, &amp;quot;full_name&amp;quot;: &amp;quot;West New York, NJ, USA&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;WEST NEW YORK&amp;quot;, &amp;quot;state&amp;quot;: &amp;quot;NJ&amp;quot;, &amp;quot;alias&amp;quot;: null, &amp;quot;latitude&amp;quot;: 40.788192, &amp;quot;longitude&amp;quot;: -74.012859 }, &amp;quot;contacts&amp;quot;: [ { &amp;quot;id&amp;quot;: 1409, &amp;quot;name&amp;quot;: &amp;quot;KDDS&amp;quot;, &amp;quot;type&amp;quot;: [ &amp;quot;DISPATCH&amp;quot; ], &amp;quot;phone&amp;quot;: &amp;quot;333443432&amp;quot;, &amp;quot;email&amp;quot;: &amp;quot;333@qq.c&amp;quot;, &amp;quot;remark&amp;quot;: null }, ... ] }, &amp;quot;rate_id&amp;quot;: &amp;quot;S115&amp;quot;, &amp;quot;rate&amp;quot;: { &amp;quot;base_rate&amp;quot;: 1320, &amp;quot;fuel_surcharge&amp;quot;: 0, &amp;quot;toll_fee&amp;quot;: &amp;quot;43.00&amp;quot; }, &amp;quot;scenarios&amp;quot;: [ { &amp;quot;name&amp;quot;: &amp;quot;Best Scenario Los Angeles&amp;quot;, &amp;quot;rates&amp;quot;: [ { &amp;quot;name&amp;quot;: &amp;quot;Base Rate&amp;quot;, &amp;quot;rate&amp;quot;: &amp;quot;1320.00&amp;quot;, &amp;quot;unit&amp;quot;: &amp;quot;CNTR&amp;quot;, &amp;quot;qty&amp;quot;: 1, &amp;quot;amount&amp;quot;: &amp;quot;1320.00&amp;quot; }, { &amp;quot;name&amp;quot;: &amp;quot;Fuel Surcharge&amp;quot;, &amp;quot;rate&amp;quot;: &amp;quot;0.00&amp;quot;, &amp;quot;unit&amp;quot;: &amp;quot;CNTR&amp;quot;, &amp;quot;qty&amp;quot;: 1, &amp;quot;amount&amp;quot;: &amp;quot;0.00&amp;quot; } ], &amp;quot;total_rate&amp;quot;: 1915, &amp;quot;description&amp;quot;: &amp;quot;Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n3 Days Chassis Usage\nPierpass and Clean Truck Fee&amp;quot;, &amp;quot;possible_charges&amp;quot;: [ { &amp;quot;code&amp;quot;: &amp;quot;CHAFE&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;CHASSIS FEE&amp;quot;, &amp;quot;explanation&amp;quot;: &amp;quot;3 days min, $75/Day (Over 3 Days, if WCCP Chassis)&amp;quot;, &amp;quot;rate&amp;quot;: &amp;quot;50&amp;quot;, &amp;quot;qty&amp;quot;: 3, &amp;quot;amount&amp;quot;: &amp;quot;150.00&amp;quot;, &amp;quot;unit&amp;quot;: &amp;quot;DAY&amp;quot;, &amp;quot;rate_text&amp;quot;: &amp;quot;50.00/DAYx3 3 DAYs MIN&amp;quot; }, ... ] }, ... ], &amp;quot;possible_charges&amp;quot;: [ { &amp;quot;code&amp;quot;: &amp;quot;CHAFE&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;CHASSIS FEE&amp;quot;, &amp;quot;explanation&amp;quot;: null, &amp;quot;rate&amp;quot;: &amp;quot;45&amp;quot;, &amp;quot;unit&amp;quot;: &amp;quot;DAY&amp;quot;, &amp;quot;rate_text&amp;quot;: &amp;quot;45.00/DAY 2 DAYs MIN&amp;quot;, &amp;quot;free&amp;quot;: null, &amp;quot;min&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;max&amp;quot;: null, &amp;quot;cntr_size&amp;quot;: [ 0 ], &amp;quot;probability&amp;quot;: &amp;quot;0.97&amp;quot; }, ... ] }, ... ], &amp;quot;links&amp;quot;: { &amp;quot;first&amp;quot;: &amp;quot;https://api.drayeasy.com/api/v2/orders?page=1&amp;quot;, &amp;quot;last&amp;quot;: &amp;quot;https://api.drayeasy.com/api/v2/orders?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/orders&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> <h2>Response Fields Description</h2> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>id</td> <td>The unique identifier for the order</td> </tr> <tr> <td>mbl_number</td> <td>Master Bill of Lading number</td> </tr> <tr> <td>status</td> <td>The status of the order (e.g., open)</td> </tr> <tr> <td>urgent</td> <td>Indicates if the order is urgent or not (true/false)</td> </tr> <tr> <td>delivery_address</td> <td>The delivery address</td> </tr> <tr> <td>customer_reference_number</td> <td>Customer reference number</td> </tr> <tr> <td>customer_memo</td> <td>Customer memo</td> </tr> <tr> <td>released_status</td> <td>The released status of the order (e.g., Not Released)</td> </tr> <tr> <td>destination_type</td> <td>The type of destination (e.g., Ramp Port)</td> </tr> <tr> <td>destination_type_name</td> <td>The name of the destination type (e.g., Ramp Port)</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>Information about the port of discharge including ID, name, city, latitude, longitude, and ports</td> </tr> <tr> <td>final_port_eta</td> <td>ETA at the final port</td> </tr> <tr> <td>final_port</td> <td>Information about the final port including ID, name, city, latitude, longitude, and ports</td> </tr> <tr> <td>commodity</td> <td>The commodity of the cargo</td> </tr> <tr> <td>contact_emails</td> <td>Array of contact emails</td> </tr> <tr> <td>terminal_firms_code</td> <td>Terminal firms code</td> </tr> <tr> <td>amount_total</td> <td>Total amount</td> </tr> <tr> <td>live_or_drop</td> <td>Indicates if the order is live or drop (1: Live, 2: Drop)</td> </tr> <tr> <td>created_at</td> <td>Timestamp of when the order was created</td> </tr> <tr> <td>user</td> <td>Information about the user including name, email, and company</td> </tr> <tr> <td>containers</td> <td>Array of containers with detailed information</td> </tr> <tr> <td>pickup_number_agent</td> <td>Information about the pickup number agent including ID, name, emails, and user</td> </tr> <tr> <td>warehouse</td> <td>Information about the warehouse including ID, name, code, zipcode, and address</td> </tr> <tr> <td>rate_id</td> <td>The ID of the rate</td> </tr> <tr> <td>rate</td> <td>Detailed information about the rate including base rate, fuel surcharge, and toll fee</td> </tr> <tr> <td>scenarios</td> <td>Array of scenarios with detailed information including name, rates, total rate, and possible charges</td> </tr> <tr> <td>possible_charges</td> <td>Array of possible charges with detailed information 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> <tr> <td>commodity</td> <td>Array</td> <td>Array of commodity</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., &quot;estimate&quot;).</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., &quot;TRUCKING / DRAYAGE CHARGE&quot;, &quot;CHASSIS FEE&quot;).</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 (&quot;Best Scenario CHICAGO&quot; 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., &quot;Base Rate&quot;).</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., &quot;CNTR&quot; 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., &quot;Best Scenario / 40'HQ,40',20' / Legal Weight / Live Unload\n2 Days Chassis Usage&quot;).</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., &quot;CHASSIS FEE&quot;).</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>

页面列表

ITEM_HTML