Skip to main content

Get Brands

GET 
/v1/profitability/brands

Rank brands by settled cleared money within the requested date and channel scope. The result pages brand rows and their channel context rather than order totals.

Requires profitability.read.

Request and response fields at a glance
  • Query parameters: page (integer), limit (integer), sortBy (string), sortOrder (string), brandIds (array), saleChannelIds (array), startDate (string, required), endDate (string, required).
  • 200 response (application/json): brands (array, required), pagination (object, required), noSignalReason (mixed, required).

Request​