List consolidated product categories

Store identifier: the sourceIntegrationId returned by GET /v1/products/integrations. Do not use the VTEX App Key — it can be rotated, and the same key can be linked to more than one store or organization.

Deprecated: prefer categoryIds. Matches any level of the VTEX category path, so a department also returns the products of its descendants.

Filters by one or more categories. A product matches when it belongs to ANY of them, directly or through a subcategory — choosing a department also returns the products of its subcategories. Send comma-separated (categoryIds=1,12) or repeated (categoryIds=1&categoryIds=12); blank values and duplicates are ignored. Up to 50 distinct ids (including categoryId, if sent), each up to 50 characters; above that the response is 400.

Inclusive lower bound on netSales — net sales in the period, in the store currency. Must not exceed maxNetSales. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Inclusive upper bound on netSales — net sales in the period, in the store currency. Must not be below minNetSales. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Inclusive lower bound on marginTotal — margin in currency. Products whose margin is N/D (missing sale value or cost) never match. Must not exceed maxMarginTotal. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Inclusive upper bound on marginTotal — margin in currency. Products whose margin is N/D (missing sale value or cost) never match. Must not be below minMarginTotal. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Inclusive lower bound on marginAverage — margin % as a decimal: 0.3 = 30%. Products whose margin is N/D never match. Must not exceed maxMarginAverage. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Inclusive upper bound on marginAverage — margin % as a decimal: 0.3 = 30%. Products whose margin is N/D never match. Must not be below minMarginAverage. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Inclusive lower bound on availableStock — available stock in units. Products whose stock is N/D (not every SKU monitored) never match. Must not exceed maxAvailableStock. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Inclusive upper bound on availableStock — available stock in units. Products whose stock is N/D (not every SKU monitored) never match. Must not be below minAvailableStock. Each category only adds up the products inside every range — the same products GET /v1/products returns for these bounds.

Metrics to return, comma-separated (e.g. netSales,marginTotal). Identity, state, coverage and N/D reasons are always returned. An unknown metric returns 400.