(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

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
maxLimits the number of resources requested to return.Integerno 
offsetTells where to start returning records from the entire set of results.Integerno 
orderOrders ascending or descending.Integernoasc,desc
sortOrders the results by the specified field.Stringno 

The max parameter is set to 100 by default.

Filters parameters:

NameDescriptionTypeRequiredExample values
dateCreated_gtFilters by the resource's creation date time and operator greater thanDateno2016-08-15T14:52:48Z
dateCreated_gteFilters by the resource's creation date time and operator greater than or equalDateno 
dateCreated_ltFilters by the resource's creation date time and operator less thanDateno 
dateCreated_lteFilters by the resource's creation date time and operator less than or equalDateno 
lastUpdated_gtFilters by the resource's last-modified date time and operator greater thanDateno 
lastUpdated_gteFilters by the resource's last-modified date time and operator greater than or equalDateno 
lastUpdated_ltFilters by the resource's last-modified date time and operator less thanDateno 
lastUpdated_lteFilters by the resource's last-modified date time and operator less than or equalDateno 
warehouseReferenceWildcard search by the warehouse's referenceStringnowarehouseReference=*ef-6*
itemReferenceWildcard search by the item's referenceStringno 

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}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idThe numerical ID of the desired warehouse stockLongYes777

URL with external_id:

https://BASE_URL/api/VERSION/warehouseStocks/reference/{itemId}/{unitId}/{warehouseId}

Parameters:

NameDescriptionTypeRequiredExamples values
itemIdreference of the itemStringYeseliteBook_820
unitIdreference of the unitStringYesPiéce
warehouseIdreference of the warehouseStringYesVETEMENT-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}

Parameters:

NameDescriptionTypeRequiredExamples values
idthe numerical ID of the desired warehouse stock to deleteLongYes777

URL with external_id:

https://BASE_URL/api/VERSION/warehouseStocks/reference/{itemId}/{unitId}/{warehouseId}

Parameters:

NameDescriptionTypeRequiredExamples values
itemIdreference of the itemStringYeseliteBook_820
unitIdreference of the unitStringYesPiéce
warehouseIdreference of the warehouseStringYesVETEMENT-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}

Method: POST

Parameters:

NameDescriptionTypeRequiredExamples values
itemIdreference of the itemStringYeseliteBook_820
unitIdreference of the unitStringYesPiéce
warehouseIdreference of the warehouseStringYesVETEMENT-001
supplyDate Dateno2017-05-17T07:00:00Z

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"
}