Skip to main content
GET
cURL recipe

Authorizations

Authorization
string
header
required

Authorization: Bearer

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:500

Default 500, maximum 1000 (both back-office configurable).

Required range: 1 <= x <= 1000
include
string

Comma-separated opt-in heavy fields. Supported: description (adds description and description_short to every item — same content as the detail endpoint). Unknown values return 422.

Example:

"description"

status
enum<string>
default:all
Available options:
active,
inactive,
all
updated_after
string<date-time>

ISO 8601 datetime; filters on the product's last edit time (date_upd).

in_stock
enum<string>
Available options:
true,
false
category_id
integer

Product category id (Meta product taxonomy) — see category.category_id. Products without a category mapping do not match; an unknown id matches nothing (200, empty page).

brand_id
integer

Brand (manufacturer) id — see brand.id on any product row. Must be a positive integer; 0, a non-numeric value or a repeated brand_id[]= answer 422 invalid_parameter. Products with no brand never match, and an unknown id matches nothing (200, empty page).

Required range: x >= 1
product_ids
string

Comma-separated product ids, 1 to 100, to fetch exactly those products (for example ones that entered your offer, see GET /products/ids). Combines with the other filters. Products you are not offered never appear. Anything else, including an empty value, answers 422 invalid_parameter.

Example:

"9597,12402"

Response

One page of products.

status
enum<string>
required
Available options:
success
status_code
integer
required
Example:

200

message
string
required
Example:

"OK"

data
object
required

One key named after the resource (products / product / states / categories / attributes / order / validation).

meta
object
required
error
object | null
required