(Quick Reference)
53 Warehouse stocks - Reference Documentation
Version: 2.1
53 Warehouse stocks
53.1 List
Service: List warehouse stocks
Description: This web service returns a json list of warehouse stocks.
URL:
https://BASE_URL/api/VERSION/warehouseStocks
: 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 | |
| warehouseReference | Wildcard search by the warehouse's reference | String | no | warehouseReference=*ef-6* |
| itemReference | Wildcard search by the item's reference | 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": 61,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"warehouseReference": "whse.A",
"warehouse": {
"id": 4,
"reference": "whse.A",
"name": "warehouse A",
"href": "/api/v1.0/warehouses/4"
},
"itemReference": "bracelet-GRP09062",
"unitReference": "pcs",
"item": {
"id": 495,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"href": "/api/v1.0/items/495"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"quantity": 2659,
"reservedSerialNumbers": null,
"supplyDate": null,
"organization": "entity1",
"dateCreated": "2015-12-17T08:21:27Z",
"lastUpdated": "2016-04-18T15:51:19Z"
},
{
"id": 65,
"warehouseReference": "van_main_whse",
"warehouse": {
"id": 31,
"reference": "van_main_whse",
"name": "Ford transit",
"href": "/api/v1.0/warehouses/31"
},
"itemReference": "eliteBook_g2",
"unitReference": "pcs",
"item": {
"id": 775,
"reference": "eliteBook_g2",
"name": "HP EliteBook 820 G2",
"href": "/api/v1.0/items/775"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"quantity": 2,
"reservedSerialNumbers": [
{
"id": 48,
"value": "d43d7ead5d58-11e6",
"href": "/api/v1.0/serialNumbers/48"
},
{
"id": 51,
"value": "41a5496f-bf4d",
"href": "/api/v1.0/serialNumbers/51"
}
],
"supplyDate": null,
"organization": "entity1",
"dateCreated": "2016-10-21T16:48:03Z",
"lastUpdated": "2016-11-07T14:48:45Z"
},
…
]
} 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."
}53.2 Show
Service: Show a warehouse stock
Description: This web service return an existing warehouse stock of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/warehouseStocks/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired warehouse stock | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/warehouseStocks/reference/{itemId}/{unitId}/{warehouseId}:
| Name | Description | Type | Required | Examples values |
|---|
| itemId | reference of the item | String | Yes | eliteBook_820 |
| unitId | reference of the unit | String | Yes | Piéce |
| warehouseId | reference of the warehouse | String | Yes | VETEMENT-001 |
Success Output
Success case: response.status=200
{
"id": 1,
"warehouseReference": "entrepotA",
"warehouse": {
"id": 4,
"reference": "entrepotA",
"name": "entrepot A",
"href": "/api/v1.0/warehouses/4"
},
"itemReference": "bracelet-GRP09062",
"unitReference": "pcs",
"item": {
"id": 495,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"href": "/api/v1.0/items/495"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"quantity": 2659,
"reservedSerialNumbers": null,
"supplyDate": "2017-05-17T08:00:00Z",
"organization": "entity1",
"dateCreated": "2015-12-17T08:21:27Z",
"lastUpdated": "2016-04-18T15:51:19Z"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The warehouse stock with the id 199 doesn't exist."
} Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}53.3 Delete
Service: Delete
Description: This web service is used in order to delete an existing warehouse stock object from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/warehouseStocks/{id}:
| Name | Description | Type | Required | Examples values |
|---|
| id | the numerical ID of the desired warehouse stock to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/warehouseStocks/reference/{itemId}/{unitId}/{warehouseId}:
| Name | Description | Type | Required | Examples values |
|---|
| itemId | reference of the item | String | Yes | eliteBook_820 |
| unitId | reference of the unit | String | Yes | Piéce |
| warehouseId | reference of the warehouse | String | Yes | VETEMENT-001 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The warehouse stock with the id 3 doesn't exist."
} Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}{
"error": "delete_failed",
"error_description": "Failed to delete instance"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}53.4 Upsert
Service: Upsert a warehouse stock
Description: This web service is used to insert a warehouse stock to the database if it does not already exist, or update it.
URL with external_id:
https://BASE_URL/api/VERSION/warehouseStocks/reference/{itemId}/{unitId}/{warehouseId}: POST
Parameters:
| Name | Description | Type | Required | Examples values |
|---|
| itemId | reference of the item | String | Yes | eliteBook_820 |
| unitId | reference of the unit | String | Yes | Piéce |
| warehouseId | reference of the warehouse | String | Yes | VETEMENT-001 |
| supplyDate | | Date | no | 2017-05-17T07:00:00Z |
| resetReservedQty | | Boolean | no | true, false |
| quantity | | Integer | no | |
Success Output
Success case: response.status=200
{
"id": 1,
"warehouseReference": "entrepotA",
"warehouse": {
"id": 4,
"reference": "entrepotA",
"name": "entrepot A",
"href": "/api/v1.0/warehouses/4"
},
"itemReference": "bracelet-GRP09062",
"unitReference": "pcs",
"item": {
"id": 495,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"href": "/api/v1.0/items/495"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"quantity": 2659,
"reservedSerialNumbers": null,
"supplyDate": null,
"organization": "entity1",
"dateCreated": "2015-12-17T08:21:27Z",
"lastUpdated": "2016-04-18T15:51:19Z"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The warehouse stock with the id 199 doesn't exist."
} Failure case:response.status = 400
{
"error": "date_validation_error",
"error_description": "incorrect date format of parameter : supplyDate"
}
