Loads
<h1>List Loads</h1>
<h2>Request</h2>
<ul>
<li>Method: <strong>GET</strong></li>
<li>URI: <code>/api/v3/loads</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>container_number</td>
<td>String</td>
<td>Search By Container#</td>
</tr>
<tr>
<td>receiver_reference_id</td>
<td>String</td>
<td>Receiver Reference ID</td>
</tr>
<tr>
<td>receiver_shipment_id</td>
<td>String</td>
<td>Search By Receiver Shipment ID</td>
</tr>
<tr>
<td>customer_reference</td>
<td>String</td>
<td>Search By Customer Reference</td>
</tr>
<tr>
<td>per_page</td>
<td>Number</td>
<td>Number of record per page (10, 20, 50, 100)</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/v3/loads \
--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;: 26782,
&quot;mbl_number&quot;: &quot;ZCSU6941919&quot;,
&quot;container_number&quot;: &quot;ZCSU6941919&quot;,
&quot;bol_id&quot;: 8774,
&quot;type&quot;: 1,
&quot;type_text&quot;: &quot;FBA&quot;,
&quot;tracking_status&quot;: 34,
&quot;tracking_status_name&quot;: &quot;Delivery Apt Time&quot;,
&quot;marking&quot;: &quot;LGB8&quot;,
&quot;customer_reference&quot;: &quot;2209013283&quot;,
&quot;receiver_shipment_id&quot;: &quot;FBA16V2KVQ8F&quot;,
&quot;receiver_reference_id&quot;: &quot;FBA16V2KVQ8F&quot;,
&quot;commodity&quot;: &quot;ZCSU6941919&quot;,
&quot;qty&quot;: 22,
&quot;unit&quot;: null,
&quot;actual_qty&quot;: 22,
&quot;weight_kg&quot;: 847,
&quot;volume_cbm&quot;: 1,
&quot;delivery_code&quot;: &quot;LGB8&quot;,
&quot;delivery_name&quot;: &quot;LGB8 - AMAZON FULFILLMENT CENTER&quot;,
&quot;delivery_address&quot;: &quot;1568 N LINDEN AVE&quot;,
&quot;delivery_appointment_numbers&quot;: [],
&quot;markup_pallet_count&quot;: 1,
&quot;pod_code&quot;: &quot;USLGB&quot;,
&quot;pod_name&quot;: &quot;LONG BEACH, CA, US&quot;,
&quot;del_code&quot;: &quot;USLGB&quot;,
&quot;del_name&quot;: &quot;LONG BEACH, CA, US&quot;,
&quot;del_eta&quot;: &quot;2022-10-10&quot;,
&quot;container_ready_to_pickup_at&quot;: null,
&quot;container_pickuped_at&quot;: null,
&quot;container_schedule_delivered_at&quot;: &quot;12:00am 10/26/2022&quot;,
&quot;pre_dispatched_at&quot;: &quot;1:26am 10/30/2022&quot;,
&quot;warehouse_alert_sent_at&quot;: null,
&quot;arrived_at_whs_yard_time&quot;: &quot;7:17am 10/26/2022&quot;,
&quot;internal_warehouse_received_at&quot;: &quot;7:17am 10/26/2022&quot;,
&quot;scheduled_pickup_time&quot;: &quot;12:00am 12/01/2022&quot;,
&quot;actual_pickup_time&quot;: &quot;11:07am 12/06/2022&quot;,
&quot;delivery_appointment_time&quot;: &quot;12:00am 12/02/2022&quot;,
&quot;delivered_at&quot;: null,
&quot;has_whs_work_order&quot;: false,
&quot;whs_work_orders_completed_at&quot;: null,
&quot;pod_files&quot;: [
&quot;https://xxxxxxxxxxxx/api/v3/loads/26782/media/119198&quot;
]
}
...
],
&quot;links&quot;: {
&quot;first&quot;: &quot;https://xxxxx/api/v3/loads?page=1&quot;,
&quot;last&quot;: &quot;http://xxxxx/api/v3/loads?page=1&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;https://xxxxx/api/v3/loads&quot;,
&quot;per_page&quot;: 20,
&quot;to&quot;: 1,
&quot;total&quot;: 1
}
}</code></pre>
<h2>Response Fields Description</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>number</td>
<td>Load的唯一编码</td>
<td>L349747</td>
</tr>
<tr>
<td>mbl_number</td>
<td>string</td>
<td>Load所属的海运MBL#</td>
<td>COSU123456789</td>
</tr>
<tr>
<td>container_number</td>
<td>string</td>
<td>Load所属的Container#</td>
<td>TCNU1234578</td>
</tr>
<tr>
<td>bol_id</td>
<td>number</td>
<td>load所属的BOL ID</td>
<td>BOL123456</td>
</tr>
<tr>
<td>type</td>
<td>number</td>
<td>货物类型</td>
<td>1</td>
</tr>
<tr>
<td>type_text</td>
<td>string</td>
<td>货物类型名称</td>
<td>FedEx</td>
</tr>
<tr>
<td>tracking_status</td>
<td>string</td>
<td>追踪状态</td>
<td>Delivered</td>
</tr>
<tr>
<td>marking</td>
<td>string</td>
<td>唛头</td>
<td>FedEx LABEL</td>
</tr>
<tr>
<td>customer_reference</td>
<td>string</td>
<td>客户追踪号码</td>
<td>730938616</td>
</tr>
<tr>
<td>receiver_shipment_id</td>
<td>string</td>
<td>收货人追踪代码</td>
<td>FBA17PLDF5PF</td>
</tr>
<tr>
<td>receiver_reference_id</td>
<td>string</td>
<td>收货人参考代码</td>
<td>2SILLF1U</td>
</tr>
<tr>
<td>commodity</td>
<td>string</td>
<td>产品描述</td>
<td>Furniture</td>
</tr>
<tr>
<td>qty</td>
<td>number</td>
<td>数量</td>
<td>10</td>
</tr>
<tr>
<td>unit</td>
<td>string</td>
<td>单位</td>
<td>Carton</td>
</tr>
<tr>
<td>actual_qty</td>
<td>number</td>
<td>实际数量</td>
<td>10</td>
</tr>
<tr>
<td>weight_kg</td>
<td>number</td>
<td>重量</td>
<td>7020.42</td>
</tr>
<tr>
<td>volume_cbm</td>
<td>number</td>
<td>立方数</td>
<td>16.53</td>
</tr>
<tr>
<td>delivery_code</td>
<td>string</td>
<td>目的地代码</td>
<td>ONT8</td>
</tr>
<tr>
<td>delivery_name</td>
<td>string</td>
<td>目的地名称</td>
<td>Ontario FBA Warehouse</td>
</tr>
<tr>
<td>delivery_address</td>
<td>string</td>
<td>目的地地址</td>
<td>12345 XXXX, Ontario CA</td>
</tr>
<tr>
<td>delivery_appointment_number</td>
<td>string</td>
<td>目的地预约号码</td>
<td>ISA123456</td>
</tr>
<tr>
<td>markup_pallet_count</td>
<td>number</td>
<td>托盘数量</td>
<td>5</td>
</tr>
<tr>
<td>pod_code</td>
<td>string</td>
<td>卸货港口代码</td>
<td>USLGB</td>
</tr>
<tr>
<td>pod_name</td>
<td>string</td>
<td>卸货港口名称</td>
<td>LONG BEACH, CA, US</td>
</tr>
<tr>
<td>del_code</td>
<td>string</td>
<td>最终目的港代码</td>
<td>USLGB</td>
</tr>
<tr>
<td>del_name</td>
<td>string</td>
<td>最终目的港名称</td>
<td>LONG BEACH, CA, US</td>
</tr>
<tr>
<td>del_eta</td>
<td>string</td>
<td>最终目的港ETA</td>
<td>2024/5/5</td>
</tr>
<tr>
<td>container_ready_to_pickup_at</td>
<td>string</td>
<td>码头可提 (Terminal Ready)</td>
<td>2024/5/6</td>
</tr>
<tr>
<td>container_pickuped_at</td>
<td>string</td>
<td>码头实际提柜日期 (Terminal Pickup</td>
<td>2024/5/7</td>
</tr>
<tr>
<td>container_schedule_delivered_at</td>
<td>string</td>
<td>送达转运仓库预约时间 (Schedule Delivery)</td>
<td>2024/5/8</td>
</tr>
<tr>
<td>pre_dispatched_at</td>
<td>string</td>
<td>预调度日期</td>
<td>2024/4/30</td>
</tr>
<tr>
<td>warehouse_alert_sent_at</td>
<td>string</td>
<td>仓库预报日期</td>
<td>2024/4/30</td>
</tr>
<tr>
<td>arrived_at_whs_yard_time</td>
<td>string</td>
<td>实际到达仓库日期 (WHS Received)</td>
<td>2024/5/5</td>
</tr>
<tr>
<td>internal_warehouse_received_at</td>
<td>string</td>
<td>实际入库日期 (Finish Unloading)</td>
<td>2024/5/5</td>
</tr>
<tr>
<td>scheduled_pickup_time</td>
<td>string</td>
<td>派送预约提货时间 (Schedule Pickup)</td>
<td>2024/5/6</td>
</tr>
<tr>
<td>actual_pickup_time</td>
<td>string</td>
<td>派送实际提货时间 (Carrier Pickedup)</td>
<td>2024/5/6</td>
</tr>
<tr>
<td>delivery_appointment_time</td>
<td>string</td>
<td>预约送到目的仓日期 (Delivery Apt Time)</td>
<td>2024/5/7</td>
</tr>
<tr>
<td>delivered_at</td>
<td>string</td>
<td>实际派送到目的仓日期 (Delivered)</td>
<td>2024/5/7</td>
</tr>
<tr>
<td>has_whs_work_order</td>
<td>string</td>
<td>是否有工单</td>
<td>YES</td>
</tr>
<tr>
<td>whs_work_orders_completed_at</td>
<td>string</td>
<td>工单完成日期</td>
<td>2024/5/5</td>
</tr>
<tr>
<td>pod_files</td>
<td>Array of Image URL</td>
<td>POD 文件</td>
<td>["<a href="https://ef.com/v3/loads/{loadId}/media/{mediaId">https://ef.com/v3/loads/{loadId}/media/{mediaId</a>}”]</td>
</tr>
</tbody>
</table>
<p><strong>The api token is required when download the file in pod_files.</strong></p>
<h3>Example</h3>
<pre><code>curl --location 'http://admin.easyfreight.solutions/api/v3/loads/165081/media/92912' \
--header 'Authorization: Bearer &lt;Your Api Token&gt;'</code></pre>