Skip to main content

Get products

Returns paginated products for a category.

Path Parameters
category string REQUIRED

Category name mapped to productFamilies.

Query Parameters
includeAllProducts boolean

Return products across all categories

includeNotOnboarded boolean

Include products that have not completed onboarding

includeAdminDetails boolean

Include administrative product fields and relationships

includeSkuCounts boolean

Include SKU counts using a separate grouped query

search string

Search product name, SKU, MCP SKU, or configuration ID

isTestProductCatalog boolean

Filter products by the test-catalog flag

pageNumber number

Possible values: 1 ≤ value

Page number to fetch

recordsPerPage number

Possible values: 1 ≤ value

Number of products per page

Responses
200

Paginated products returned.

400

Invalid product query request.