Skip to main content

Get Products

GET 

/v1/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.

Requires profitability.read.

Request and response fields at a glance
  • Query parameters: productIds (array), search (string), state (string), minKeepRate (number), maxKeepRate (number), 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), pagination (object, required), noSignalReason (mixed, required).

Request​