Skip to main content
GET
/
v1
/
stocks
/
overview
Get stock overview
curl --request GET \
  --url https://dev.flextell.ai/api/v1/stocks/overview \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'
{
  "data": [
    {
      "product": {
        "id": 123,
        "name": "<string>"
      },
      "warehouse": {
        "id": 123,
        "name": "<string>"
      },
      "balance": 123,
      "unit_label": "<string>",
      "critical_stock_level": 123
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Query Parameters

warehouse_id
integer | null

Filter by warehouse ID.

Required range: x >= 1
brand_id
integer | null

Filter by product brand ID.

Required range: x >= 1
base_unit_code_id
integer | null

Filter by base unit code ID.

Required range: x >= 1
base_unit
integer | null

Alias of base_unit_code_id (filter by base unit code ID).

Required range: x >= 1
stock_status
enum<string> | null

Filter by stock status (normal, low, critical).

Available options:
normal,
low,
critical
per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
page
integer | null

The page number.

Required range: x >= 1
sort_by
enum<string> | null

The field to sort by.

Available options:
product_name,
warehouse_name,
balance,
stock_status,
critical_stock_level
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc

Response

Paginated set of StockOverviewResource

data
StockOverviewResource · object[]
required
meta
object
required