List Ocean Shipment
<h1>List Ocean Shipment</h1>
<h2>Request</h2>
<ul>
<li>Method: <strong>GET</strong></li>
<li>URI: <code>/api/v2/oceanShipments</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>Search By MBL#</td>
</tr>
<tr>
<td>hbl_number</td>
<td>String</td>
<td>Search By HBL#</td>
</tr>
<tr>
<td>container_number</td>
<td>String</td>
<td>Search By Container#</td>
</tr>
<tr>
<td>search</td>
<td>String</td>
<td>Search for records that partially match with MBL#, HBL#, or Container#.</td>
</tr>
<tr>
<td>per_page</td>
<td>Number</td>
<td>Number of record per page</td>
</tr>
<tr>
<td>page</td>
<td>Number</td>
<td>Page number</td>
</tr>
</tbody>
</table>
<h2>Code Example</h2>
<pre><code>Request:
curl https://admin.easyfreight.solutions/api/v2/oceanShipments \
--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;id&quot;: 5800,
&quot;mbl_number&quot;: &quot;mbl1&quot;,
&quot;carrier_scac_code&quot;: null,
&quot;depart_vessel_name&quot;: null,
&quot;depart_voyage_number&quot;: null,
&quot;arrival_vessel_name&quot;: null,
&quot;arrival_voyage_number&quot;: null,
&quot;incoterm&quot;: null,
&quot;service_term&quot;: null,
&quot;payment_type&quot;: null,
&quot;marking&quot;: null,
&quot;description&quot;: null,
&quot;pol_code&quot;: &quot;AUALO&quot;,
&quot;pod_code&quot;: &quot;AUALO&quot;,
&quot;del_code&quot;: &quot;AUALO&quot;,
&quot;etd&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;del_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;commodity&quot;: &quot;test&quot;,
&quot;package_qty&quot;: 12,
&quot;shipper&quot;: {
&quot;id&quot;: 4157,
&quot;code&quot;: &quot;TESSS2333T&quot;,
&quot;type&quot;: &quot;te333st&quot;,
&quot;name&quot;: &quot;TE33ST&quot;,
&quot;billing_to_name&quot;: &quot;test&quot;,
&quot;country&quot;: null,
&quot;state&quot;: null,
&quot;city&quot;: null,
&quot;zipcode&quot;: null,
&quot;address&quot;: null,
&quot;billing_address&quot;: &quot;TE33ST&quot;,
&quot;bl_address&quot;: &quot;T33EST&quot;
},
&quot;consignee&quot;: null,
&quot;notify&quot;: null,
&quot;isf_needed&quot;: false,
&quot;freight_needed&quot;: true,
&quot;custom_needed&quot;: false,
&quot;truck_needed&quot;: true,
&quot;bl_type&quot;: null,
&quot;original_bl_type&quot;: null,
&quot;containers&quot;: [
{
&quot;id&quot;: 5107,
&quot;number&quot;: &quot;cntr1&quot;,
&quot;pod_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;ir_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;size_type&quot;: &quot;20FR&quot;,
&quot;seal_number&quot;: null,
&quot;commodity&quot;: &quot;Test&quot;,
&quot;package_qty&quot;: 12,
&quot;package_measure_unit&quot;: &quot;test&quot;,
&quot;gross_weight_kg&quot;: &quot;12.00&quot;,
&quot;measurement_cbm&quot;: &quot;12.00&quot;,
&quot;is_reefer&quot;: false,
&quot;is_dg&quot;: false,
&quot;is_soc&quot;: false,
&quot;is_overweight&quot;: false,
&quot;chassis_number&quot;: null,
&quot;status&quot;: 0,
&quot;is_exam&quot;: false,
&quot;freight_released_at&quot;: null,
&quot;customs_released_at&quot;: null,
&quot;terminal_released_at&quot;: null,
&quot;trucker&quot;: null,
&quot;delivery_location&quot;: null,
&quot;lfd&quot;: null,
&quot;schedule_pickup_at&quot;: null,
&quot;ready_to_pickup_at&quot;: null,
&quot;schedule_delivered_at&quot;: null,
&quot;actual_delivered_at&quot;: null,
&quot;actual_pickup_at&quot;: null,
&quot;empty_at&quot;: null,
&quot;notified_empty_at&quot;: null,
&quot;returned_at&quot;: null,
&quot;chassis_days&quot;: null,
&quot;remark&quot;: null,
&quot;customer_remark&quot;: null,
&quot;shipping_events&quot;: null,
&quot;freight_location&quot;: null
},
{
&quot;id&quot;: 5108,
&quot;number&quot;: &quot;cntr2&quot;,
&quot;pod_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;ir_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;size_type&quot;: &quot;20FR&quot;,
&quot;seal_number&quot;: null,
&quot;commodity&quot;: &quot;Test&quot;,
&quot;package_qty&quot;: 12,
&quot;package_measure_unit&quot;: &quot;test&quot;,
&quot;gross_weight_kg&quot;: &quot;12.00&quot;,
&quot;measurement_cbm&quot;: &quot;12.00&quot;,
&quot;is_reefer&quot;: false,
&quot;is_dg&quot;: false,
&quot;is_soc&quot;: false,
&quot;is_overweight&quot;: false,
&quot;chassis_number&quot;: null,
&quot;status&quot;: 0,
&quot;is_exam&quot;: false,
&quot;freight_released_at&quot;: null,
&quot;customs_released_at&quot;: null,
&quot;terminal_released_at&quot;: null,
&quot;trucker&quot;: null,
&quot;lfd&quot;: null,
&quot;delivery_location&quot;: null,
&quot;schedule_pickup_at&quot;: null,
&quot;ready_to_pickup_at&quot;: null,
&quot;schedule_delivered_at&quot;: null,
&quot;actual_delivered_at&quot;: null,
&quot;actual_pickup_at&quot;: null,
&quot;empty_at&quot;: null,
&quot;notified_empty_at&quot;: null,
&quot;returned_at&quot;: null,
&quot;chassis_days&quot;: null,
&quot;remark&quot;: null,
&quot;customer_remark&quot;: null,
&quot;shipping_events&quot;: null,
&quot;freight_location&quot;: null
}
],
&quot;hbls&quot;: [
{
&quot;id&quot;: 4796,
&quot;hbl_number&quot;: &quot;hbl1&quot;,
&quot;marking&quot;: null,
&quot;shipper&quot;: null,
&quot;partner&quot;: null,
&quot;customer&quot;: null,
&quot;customer_reference&quot;: null,
&quot;consignee&quot;: null,
&quot;notify&quot;: null,
&quot;carrier_scac_code&quot;: null,
&quot;depart_vessel_name&quot;: null,
&quot;depart_voyage_number&quot;: null,
&quot;arrival_vessel_name&quot;: null,
&quot;arrival_voyage_number&quot;: null,
&quot;ship_mode&quot;: null,
&quot;incoterm&quot;: null,
&quot;service_term&quot;: null,
&quot;payment_type&quot;: null,
&quot;pol_code&quot;: &quot;AUALO&quot;,
&quot;pod_code&quot;: &quot;AUALO&quot;,
&quot;del_code&quot;: &quot;AUALO&quot;,
&quot;fdest_code&quot;: &quot;AUALO&quot;,
&quot;fdest_zipcode&quot;: &quot;02134&quot;,
&quot;pod_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;del_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;fdest_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;description&quot;: null,
&quot;bl_type&quot;: null,
&quot;original_bl_type&quot;: null,
&quot;original_received_date&quot;: null,
&quot;express_received_date&quot;: null,
&quot;commodity&quot;: &quot;2020-10-01&quot;,
&quot;package_qty&quot;: 12,
&quot;package_measure_unit&quot;: null,
&quot;containers&quot;: [
{
&quot;id&quot;: 5108,
&quot;number&quot;: &quot;cntr2&quot;,
&quot;pod_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;ir_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;size_type&quot;: &quot;20FR&quot;,
&quot;seal_number&quot;: null,
&quot;commodity&quot;: &quot;Test&quot;,
&quot;package_qty&quot;: 12,
&quot;package_measure_unit&quot;: &quot;test&quot;,
&quot;gross_weight_kg&quot;: &quot;12.00&quot;,
&quot;measurement_cbm&quot;: &quot;12.00&quot;,
&quot;is_reefer&quot;: false,
&quot;is_dg&quot;: false,
&quot;is_soc&quot;: false,
&quot;is_overweight&quot;: false,
&quot;chassis_number&quot;: null,
&quot;status&quot;: 0,
&quot;is_exam&quot;: false,
&quot;freight_released_at&quot;: null,
&quot;customs_released_at&quot;: null,
&quot;terminal_released_at&quot;: null,
&quot;trucker&quot;: null,
&quot;delivery_location&quot;: null,
&quot;lfd&quot;: null,
&quot;schedule_pickup_at&quot;: null,
&quot;ready_to_pickup_at&quot;: null,
&quot;schedule_delivered_at&quot;: null,
&quot;actual_delivered_at&quot;: null,
&quot;actual_pickup_at&quot;: null,
&quot;empty_at&quot;: null,
&quot;notified_empty_at&quot;: null,
&quot;returned_at&quot;: null,
&quot;chassis_days&quot;: null,
&quot;remark&quot;: null,
&quot;customer_remark&quot;: null,
&quot;shipping_events&quot;: null,
&quot;freight_location&quot;: null
}
],
&quot;customs_clearance&quot;: {
&quot;id&quot;: xxx,
&quot;number&quot;: &quot;CC1599&quot;,
&quot;current_step&quot;: 0,
&quot;broker&quot;: null,
&quot;poa_signer&quot;: null,
&quot;progresses&quot;: [
{
&quot;id&quot;: xxx,
&quot;step&quot;: 0,
&quot;action_at&quot;: null,
&quot;complete_at&quot;: &quot;2023-08-17&quot;,
&quot;complete_by&quot;: &quot;hm_meihua&quot;
},
...
]
}
},
{
&quot;id&quot;: 4797,
&quot;hbl_number&quot;: &quot;hbl2&quot;,
&quot;marking&quot;: null,
&quot;shipper&quot;: null,
&quot;partner&quot;: null,
&quot;customer&quot;: null,
&quot;customer_reference&quot;: null,
&quot;consignee&quot;: null,
&quot;notify&quot;: null,
&quot;carrier_scac_code&quot;: null,
&quot;depart_vessel_name&quot;: null,
&quot;depart_voyage_number&quot;: null,
&quot;arrival_vessel_name&quot;: null,
&quot;arrival_voyage_number&quot;: null,
&quot;ship_mode&quot;: null,
&quot;incoterm&quot;: null,
&quot;service_term&quot;: null,
&quot;payment_type&quot;: null,
&quot;pol_code&quot;: &quot;AUALO&quot;,
&quot;pod_code&quot;: &quot;AUALO&quot;,
&quot;del_code&quot;: &quot;AUALO&quot;,
&quot;fdest_code&quot;: &quot;AUALO&quot;,
&quot;fdest_zipcode&quot;: &quot;02134&quot;,
&quot;pod_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;del_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;fdest_eta&quot;: &quot;2020-10-01T07:00:00.000000Z&quot;,
&quot;description&quot;: null,
&quot;bl_type&quot;: null,
&quot;original_bl_type&quot;: null,
&quot;original_received_date&quot;: null,
&quot;express_received_date&quot;: null,
&quot;commodity&quot;: &quot;2020-10-01&quot;,
&quot;package_qty&quot;: 12,
&quot;package_measure_unit&quot;: null,
&quot;containers&quot;: []
}
]
}
],
&quot;links&quot;: {
&quot;first&quot;: &quot;xxxx&quot;,
&quot;last&quot;: &quot;xxxx&quot;,
&quot;prev&quot;: null,
&quot;next&quot;: null
},
&quot;meta&quot;: {
&quot;current_page&quot;: 1,
&quot;from&quot;: 1,
&quot;last_page&quot;: 1,
&quot;path&quot;: &quot;xxxx&quot;,
&quot;per_page&quot;: 25,
&quot;to&quot;: 1,
&quot;total&quot;: 1
}
}</code></pre>