v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Warehouse

List warehouses

This endpoint is only available as beta version and will introduce breaking changes without further notice or versioning. Returns a list of active warehouses.

get/api/v1/warehouses

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

key'designation' | 'id'
op'greaterThan' | 'lessThan' | 'equals' | 'notEquals' | 'in' | 'notIn'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "1",
      "project": {
        "id": "2"
      },
      "designation": "Returns"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}