(Quick Reference)
Service: list warehouses
Description: This web service returns a json list of warehouses.
URL:
https://BASE_URL/api/VERSION/warehouses
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The
max parameter is set to
100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| reference | Wildcard search by the resource's reference | String | no | reference=Ref-6* , reference=*ef-6 , reference=*ef-6* |
| name | Wildcard search by the resource's name | String | no | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Status: HTTP/1.1 200 OK
{
"paging": {
"total": 18,
"max": 5,
"offset": 0,
"previous": null,
"next": "/api/v1.0/warehouses?max=5&offset=5&sort=dateCreated&order=asc"
},
"data": [
{
"id": 4,
"name": "entrepot1",
"reference": "entrepot1",
"organization": "entity1",
"isRoot": false,
"parentReference": "wh-01",
"parentWhse": {
"id": 2,
"reference": "wh-01",
"name": "Main warehouse",
"href": "/api/v1.0/warehouses/2"
},
"description": "entrepot1",
"address": "entrepot1",
"isVan": false,
"users": [
{
"id": 4,
"reference": "emp-00",
"href": "/api/v1.0/users/4"
},
{
"id": 5,
"reference": "emp-03",
"href": "/api/v1.0/users/5"
}
],
"dateCreated": "2015-12-15T16:58:46Z",
"lastUpdated": "2016-05-04T14:48:26Z"
},…
]
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}
