Skip to main content

Get Products

GET 

/profitability/products

Rank products by settled cleared money, with optional product IDs, search, state, or keep-rate bounds. Page and sort this table independently of the distribution chart.

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. Items fold on the parent, the account brand and the currency, so currencies never mix. An item ranks by its parent's sums under sortBy, currency first, the lowest product id breaking ties. Each variant keeps its own channels, keep rate and listing state.

Requires profitability.read.

Request and response fields at a glance
  • Query parameters: productIds (array), search (string), state (string), minKeepRate (number), maxKeepRate (number), groupBy (string), page (integer), limit (integer), sortBy (string), sortOrder (string), brandIds (array), saleChannelIds (array), startDate (string, required), endDate (string, required).
  • 200 response (application/json): products (array, required), parents (array), pagination (object, required), noSignalReason (string or null, required).

Request​