Stock
Get stock overview
GET
Get stock overview
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.
Query Parameters
Filter by warehouse ID.
Required range:
x >= 1Filter by product brand ID.
Required range:
x >= 1Filter by base unit code ID.
Required range:
x >= 1Alias of base_unit_code_id (filter by base unit code ID).
Required range:
x >= 1Filter by stock status (normal, low, critical).
Available options:
normal, low, critical The number of items per page.
Required range:
1 <= x <= 100The page number.
Required range:
x >= 1The field to sort by.
Available options:
product_name, warehouse_name, balance, stock_status, critical_stock_level The sort direction (asc or desc).
Available options:
asc, desc