Skip to main content

Get Growing Products

GET 

/products/growing

Return products or listings growing between two required comparison windows. Results follow the requested brand, channel, and sort filters.

With performanceBreakdown=ByParent each row is an item: a parent (one design sold in several sizes or colours), or a product with no parent. A parent row carries parentKey, parent and variants and no product. Its p1Revenue, p2Revenue, p1UnitsSold, p2UnitsSold and revenueDelta are its variants' sums, growthPercentage is computed from them, isOutOfStock is true when every variant in scope is out of stock, and saleChannelBreakdown sums the variants per channel. A product with no parent is a row with parentKey: null, its product, and variants holding that one product. page and limit count items, and each variant keeps its own figures in variants.

Requires sales-performance.read.

Request and response fields at a glance
  • Query parameters: p1StartDate (string, required), p1EndDate (string, required), p2StartDate (string, required), p2EndDate (string, required), brandIds (array), excludeSaleChannelIds (array), performanceBreakdown (string), page (integer), limit (integer), sortBy (string).
  • 200 response (application/json): array of product (object), totalRevenue (number, required), unitsSold (number, required), p1UnitsSold (number, required), p2UnitsSold (number, required), brandName (string, required), brandNameAR (string or null, required), saleChannelBreakdown (array), growthPercentage (number, required), p1Revenue (number, required), p2Revenue (number, required), revenueDelta (number, required), isOutOfStock (boolean, required), listing (object), parentKey (string or null), parent (object), variants (array).

Request​