Skip to main content
GET
Get all products

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

search
string | null

The search query.

Maximum string length: 255
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. full_name sorts by the brand-prefixed product name shown in the product list.

Mevcut seçenekler:
full_name,
name,
price,
is_active,
created_at,
updated_at,
null
sort_order
enum<string> | null

The sort direction (asc or desc). Defaults to newest first for the default listing, ascending for a requested text sort and descending for any other requested sort.

Mevcut seçenekler:
asc,
desc,
null
is_active
boolean | null

Filter by active status.

product_brand_id
integer | null

Filter by brand.

product_category_id
integer | null

Filter by category.

product_type_id
integer | null

Filter by product type.

base_unit_code_id
integer | null

Filter by base unit code.

catalog_product_id
integer | null

Filter by the central catalog product the product was created from.

tax_rate
enum<integer> | null

Filter by tax rate percentage.

Mevcut seçenekler:
0,
1,
10,
20,
null
created_at_from
string<date-time> | null

Filter products created at or after this timestamp (tenant timezone).

created_at_to
string<date-time> | null

Filter products created at or before this timestamp (tenant timezone).

Yanıt

Paginated set of ProductResource

data
ProductResource · object[]
gerekli
meta
object
gerekli