Skip to main content

List marketplace products and listings

GET 

/products

Page through catalog products with listing facets and category counts. Use the query filters to narrow the brand and sale channel scope.

With groupBy=parent the page is made of items: a parent (one design sold in several sizes or colours) is one item, and a product with no parent is one item. limit and pagination.total count items. Every filter matches variants, and a parent is on the page when any of its variants matches. products holds the matching variants of the page's items, contiguous per item, and parents carries each parent's figures over all its variants. Every variant of one parent is groupBy=parent&ids={parent.productIds}&limit=1.

Requires products.read.

Request and response fields at a glance
  • Query parameters: page (integer), limit (integer), sortBy (string), sortOrder (string), ids (array), brandIds (array), excludedSaleChannelIds (array), categories (array), productTiers (array), sku (string), name (string), listingFilter (array), groupBy (string), statusUnit (string), hasChannelPresence (boolean).
  • 200 response (application/json): products (array, required), parents (array), categories (array, required), filterCounts (object, required), pagination (object, required).

Request​