Skip to main content
GET
Get stock overview

Yetkilendirmeler

Authorization
string
header
gerekli

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

Başlıklar

X-Tenant
number
gerekli

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

Sorgu Parametreleri

warehouse_id
integer | null

Filter by warehouse ID.

Gerekli aralık: x >= 1
product_ids[]
integer[]

A product ID to filter by.

brand_id
integer | null

Filter by product brand ID.

Gerekli aralık: x >= 1
base_unit_code_id
integer | null

Filter by base unit code ID.

Gerekli aralık: x >= 1
base_unit
integer | null

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

Gerekli aralık: x >= 1
stock_status
enum<string> | null

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

Mevcut seçenekler:
normal,
low,
critical,
null
per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
product_name,
warehouse_name,
balance,
stock_status,
critical_stock_level,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null

Yanıt

Paginated set of StockOverviewResource

data
StockOverviewResource · object[]
gerekli
meta
object
gerekli