Warehouse Search
<h2>Overview</h2>
<p>The API endpoint that allows searching for warehouses using parameters such as per_page for pagination, page for specifying the page number, and name for filtering warehouses by name.</p>
<h2>Request</h2>
<ul>
<li>Method: <strong>GET</strong></li>
<li>URI: <code>/warehouses/search?per_page=xx&amp;page=xx&amp;name=xx</code></li>
</ul>
<h2>Code Example</h2>
<pre><code>Request:
curl --location 'https://api.drayeasy.com/api/v2/warehouses/search?per_page=50&amp;page=1&amp;name=test' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
Response:
HTTP/1.1 201 OK
Content-Type: application/json; charset=utf-8
{
&quot;data&quot;: [
{
&quot;id&quot;: 2376,
&quot;name&quot;: &quot;Test Update Warehouse&quot;,
&quot;code&quot;: &quot;100121&quot;,
&quot;zipcode&quot;: &quot;90001&quot;,
&quot;working_hour_from&quot;: &quot;10:41:00&quot;,
&quot;working_hour_to&quot;: &quot;14:41:00&quot;,
&quot;working_day_from&quot;: 3,
&quot;working_day_to&quot;: 6,
&quot;time_zone&quot;: &quot;MST&quot;,
&quot;appointment_by&quot;: 2,
&quot;internal_memo&quot;: null,
&quot;is_residential&quot;: true,
&quot;customer_memo&quot;: &quot;Test Update Warehouse\n Test&quot;,
&quot;live_or_drop&quot;: 1,
&quot;address&quot;: &quot;Test Update Warehouse Stree Address&quot;,
&quot;delivery_order_address&quot;: &quot;TEST UPDATE WAREHOUSE STREE ADDRESS\nLOS ANGELES, CA, USA 90001\nJOHN(11112345688)\nWHES(11113333333)&quot;,
&quot;created_at&quot;: &quot;2023-06-02T12:16:34.000000Z&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;city&quot;: {
&quot;id&quot;: 1,
&quot;country&quot;: &quot;USA&quot;,
&quot;full_name&quot;: &quot;Los Angeles, CA, USA&quot;,
&quot;name&quot;: &quot;LOS ANGELES&quot;,
&quot;state&quot;: &quot;CA&quot;,
&quot;alias&quot;: null,
&quot;latitude&quot;: 33.973093,
&quot;longitude&quot;: -118.247896
},
&quot;contacts&quot;: [
{
&quot;id&quot;: 1388,
&quot;name&quot;: &quot;John&quot;,
&quot;type&quot;: [
&quot;SALES&quot;,
&quot;ACCOUNTING&quot;
],
&quot;role&quot;: &quot;UFO&quot;,
&quot;phone&quot;: &quot;11112345688&quot;,
&quot;fax&quot;: null,
&quot;email&quot;: &quot;john@john.com&quot;,
&quot;remark&quot;: &quot;Test&quot;
},
{
&quot;id&quot;: 1390,
&quot;name&quot;: &quot;whes&quot;,
&quot;type&quot;: [
&quot;APT&quot;,
&quot;SALES&quot;,
&quot;ACCOUNTING&quot;
],
&quot;role&quot;: null,
&quot;phone&quot;: &quot;11113333333&quot;,
&quot;fax&quot;: null,
&quot;email&quot;: &quot;whes@test.com&quot;,
&quot;remark&quot;: null
}
]
},
...
],
&quot;links&quot;: {
&quot;first&quot;: &quot;https://api.drayeasy.com/api/v2/warehouses/search?page=1&quot;,
&quot;last&quot;: &quot;https://api.drayeasy.com/api/v2/warehouses/search?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://api.drayeasy.com/api/v2/warehouses/search&quot;,
&quot;per_page&quot;: &quot;50&quot;,
&quot;to&quot;: 9,
&quot;total&quot;: 9
}
}</code></pre>
<h2>Response Fields Description</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>Warehouse ID</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>Warehouse Name</td>
</tr>
<tr>
<td>code</td>
<td>String</td>
<td>Warehouse Code</td>
</tr>
<tr>
<td>zipcode</td>
<td>String</td>
<td>Warehouse Zipcode</td>
</tr>
<tr>
<td>working_hour_from</td>
<td>String</td>
<td>Start time of working hours</td>
</tr>
<tr>
<td>working_hour_to</td>
<td>String</td>
<td>End time of working hours</td>
</tr>
<tr>
<td>working_day_from</td>
<td>Integer</td>
<td>Start day of working days (0: Sunday, 1: Monday, etc.)</td>
</tr>
<tr>
<td>working_day_to</td>
<td>Integer</td>
<td>End day of working days</td>
</tr>
<tr>
<td>time_zone</td>
<td>String</td>
<td>Time zone of the warehouse</td>
</tr>
<tr>
<td>appointment_by</td>
<td>Integer</td>
<td>Appointment method (0: Unknown, 1: No apt needed, etc.)</td>
</tr>
<tr>
<td>internal_memo</td>
<td>String or Null</td>
<td>Internal memo for the warehouse</td>
</tr>
<tr>
<td>is_residential</td>
<td>Boolean</td>
<td>Residential indicator</td>
</tr>
<tr>
<td>customer_memo</td>
<td>String</td>
<td>Customer memo for the warehouse</td>
</tr>
<tr>
<td>live_or_drop</td>
<td>Integer</td>
<td>Live or Drop indicator (0: Unknown, 1: Live, etc.)</td>
</tr>
<tr>
<td>address</td>
<td>String</td>
<td>Street address of the warehouse</td>
</tr>
<tr>
<td>delivery_order_address</td>
<td>String</td>
<td>Delivery order address with details</td>
</tr>
<tr>
<td>created_at</td>
<td>DateTime</td>
<td>Date and time of warehouse creation</td>
</tr>
<tr>
<td>user</td>
<td>Object</td>
<td>User details associated with the warehouse</td>
</tr>
<tr>
<td>city</td>
<td>Object</td>
<td>City details where the warehouse is located</td>
</tr>
<tr>
<td>contacts</td>
<td>Array of Objects</td>
<td>Array of contacts associated with the warehouse</td>
</tr>
<tr>
<td>contacts[id]</td>
<td>Integer</td>
<td>Contact ID</td>
</tr>
<tr>
<td>contacts[name]</td>
<td>String</td>
<td>Contact Name</td>
</tr>
<tr>
<td>contacts[type]</td>
<td>Array of String</td>
<td>Contact types (e.g., SALES, ACCOUNTING)</td>
</tr>
<tr>
<td>contacts[role]</td>
<td>String or Null</td>
<td>Contact Role</td>
</tr>
<tr>
<td>contacts[phone]</td>
<td>String</td>
<td>Contact Phone</td>
</tr>
<tr>
<td>contacts[fax]</td>
<td>String or Null</td>
<td>Contact Fax</td>
</tr>
<tr>
<td>contacts[email]</td>
<td>String</td>
<td>Contact Email</td>
</tr>
<tr>
<td>contacts[remark]</td>
<td>String or Null</td>
<td>Contact Remark</td>
</tr>
</tbody>
</table>
<h2>User Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>The name of the user.</td>
</tr>
<tr>
<td>email</td>
<td>The email address of the user.</td>
</tr>
<tr>
<td>company</td>
<td>The company associated with the user.</td>
</tr>
</tbody>
</table>
<h2>City Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>The unique identifier for the city.</td>
</tr>
<tr>
<td>country</td>
<td>The country where the city is located.</td>
</tr>
<tr>
<td>full_name</td>
<td>The full name of the city, including state and country.</td>
</tr>
<tr>
<td>name</td>
<td>The name of the city.</td>
</tr>
<tr>
<td>state</td>
<td>The state where the city is located (if applicable).</td>
</tr>
<tr>
<td>alias</td>
<td>An alias for the city (if available).</td>
</tr>
<tr>
<td>latitude</td>
<td>The latitude coordinate of the city.</td>
</tr>
<tr>
<td>longitude</td>
<td>The longitude coordinate of the city.</td>
</tr>
</tbody>
</table>
<h2>Contact Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>The unique identifier for the contact.</td>
</tr>
<tr>
<td>name</td>
<td>The name of the contact.</td>
</tr>
<tr>
<td>type</td>
<td>The type or roles associated with the contact.</td>
</tr>
<tr>
<td>role</td>
<td>The role of the contact (if applicable).</td>
</tr>
<tr>
<td>phone</td>
<td>The phone number of the contact.</td>
</tr>
<tr>
<td>fax</td>
<td>The fax number of the contact (if available).</td>
</tr>
<tr>
<td>email</td>
<td>The email address of the contact.</td>
</tr>
<tr>
<td>remark</td>
<td>Any additional remarks or notes about the contact.</td>
</tr>
</tbody>
</table>