Warehouses
The Warehouses resource allows Warehouses to be listed.
The full range of URIs and HTTP Verbs supported are:
| Operation |
HTTP Action |
| List all Warehouses |
GET /Warehouses |
| View the Warehouses for a specific page |
GET /Warehouses/{pageNumber}
GET /Warehouses/Page/{pageNumber} |
GET Warehouses
Available Filters for GET Warehouses
| Filter |
Description |
modifiedSince |
Returns Warehouses created or edited after a specified date in UTC time zone. For example: modifiedSince=2024-04-17T23:11:05 |
warehouseCode |
Returns Warehouses that start with the specific warehouse code. |
warehouseName |
Returns Warehouses that start with the specific warehouse name. |
Note: Date filters should be provided in the ISO format YYYY-MM-DD. The time zone is UTC. Default ordering is done by warehouseCode ascending
Available Fields for GET Warehouses
| Property |
Type |
Length |
Notes |
| AddressLine1 |
String |
500 |
|
| AddressLine2 |
String |
500 |
|
| City |
String |
500 |
|
| ContactName |
String |
50 |
|
| Country |
String |
500 |
|
| DDINumber |
String |
25 |
|
| FaxNumber |
String |
25 |
|
| Guid |
Guid |
|
Unique identifier. |
| IsDefault |
Boolean |
|
|
| LastModifiedOn |
DateTime |
|
|
| MobileNumber |
String |
25 |
|
| Obsolete |
Boolean |
|
|
| PhoneNumber |
String |
25 |
|
| PostCode |
String |
500 |
|
| Region |
String |
500 |
|
| StreetNo |
String |
500 |
|
| WarehouseCode |
String |
15 |
Unique code. |
| WarehouseName |
String |
100 |
|
Examples for Request GET /Warehouses
show xml example
<?xml version="1.0"?>
<Warehouses xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
<Pagination>
<NumberOfItems>2</NumberOfItems>
<PageSize>200</PageSize>
<PageNumber>1</PageNumber>
<NumberOfPages>1</NumberOfPages>
</Pagination>
<Warehouse>
<Guid>c7c4a7ee-bb28-41bd-918b-a09240154141</Guid>
<LastModifiedOn>2016-03-29T02:32:20.803</LastModifiedOn>
<WarehouseCode>HQ</WarehouseCode>
<WarehouseName>Head Office</WarehouseName>
<IsDefault>false</IsDefault>
<Obsolete>false</Obsolete>
</Warehouse>
<Warehouse>
<Guid>5797c041-4d5b-4860-8ac4-eb4714e7bae0</Guid>
<LastModifiedOn>2016-03-29T02:32:20.8</LastModifiedOn>
<WarehouseCode>MAIN</WarehouseCode>
<WarehouseName>Main Warehouse</WarehouseName>
<IsDefault>true</IsDefault>
<Obsolete>false</Obsolete>
</Warehouse>
</Warehouses>
show json example
{
"Pagination": {
"NumberOfItems": 2,
"PageSize": 200,
"PageNumber": 1,
"NumberOfPages": 1
},
"Items": [
{
"WarehouseCode": "HQ",
"WarehouseName": "Head Office",
"IsDefault": false,
"StreetNo": null,
"AddressLine1": null,
"AddressLine2": null,
"City": null,
"Region": null,
"Country": null,
"PostCode": null,
"PhoneNumber": null,
"FaxNumber": null,
"MobileNumber": null,
"DDINumber": null,
"ContactName": null,
"Obsolete": false,
"Guid": "c7c4a7ee-bb28-41bd-918b-a09240154141",
"LastModifiedOn": "/Date(1459218740803)/"
},
{
"WarehouseCode": "MAIN",
"WarehouseName": "Main Warehouse",
"IsDefault": true,
"StreetNo": null,
"AddressLine1": null,
"AddressLine2": null,
"City": null,
"Region": null,
"Country": null,
"PostCode": null,
"PhoneNumber": null,
"FaxNumber": null,
"MobileNumber": null,
"DDINumber": null,
"ContactName": null,
"Obsolete": false,
"Guid": "5797c041-4d5b-4860-8ac4-eb4714e7bae0",
"LastModifiedOn": "/Date(1459218740800)/"
}
]
}
Use the API Sandbox to see how the object is rendered in JSON or XML.
Note: An Unleashed account is required before you can use the API Sandbox.
Trial accounts are also allowed to connect to the API.
You can register a new account here: Register.
