Skip to main content
GET
Get stock overview

Authorizations

Authorization
string
header
required

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

FlowAuthorization Code
Authorization URL
https://dev.flextell.ai/oauth/authorize
Token URL
https://dev.flextell.ai/oauth/token

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