OfficeGest
Stocks/Articles/{article}/Warehouses

List article warehouses

Returns stock data per warehouse for the article, aggregating quantities from stock, orders, and configuration tables. Includes supplier, location, and sector data when available.

GET
/stocks/articles/{article}/warehouses
AuthorizationBearer <token>

In: header

Path Parameters

articlestring

Query Parameters

warehouse_id?integerDeprecated

Filter by warehouse code (supports eq, in operators)

filter[warehouse_id][operator]?integer

Operators: eq, in. Example: filter[warehouse_id][eq]=value

page?integer

Page number. Default 1; a value below 1 counts as 1.

Default1
Range1 <= value
limit?integer

Items per page. Default 50, maximum 250; a larger value is truncated to 250.

Default50
Range1 <= value <= 250

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/stocks/articles/string/warehouses?warehouse_id=0&filter%5Bwarehouse_id%5D%5Boperator%5D=0&page=1&limit=50"
{
  "data": [
    {
      "warehouse_id": 0,
      "warehouse_name": "string",
      "stock_qty": 0.1,
      "client_ordered_qty": 0.1,
      "supplier_ordered_qty": 0.1,
      "min_stock": 0.1,
      "max_stock": 0.1,
      "replenishment_qty": 0.1,
      "location": "string",
      "supplier_id": 0,
      "supplier_name": "string",
      "sector_id": 0,
      "sector_description": "string",
      "sector_barcode": "string",
      "abc": "string"
    }
  ],
  "meta": {
    "per_page": 50,
    "current_page": 1,
    "has_more": true
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}