Skip to main content

Get Declining Products

GET 
/v1/products/declining

Return products or listings declining between two required comparison windows. Use performanceBreakdown and sortBy to choose the grain and ordering.

Requires salesPerformance.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, required), totalRevenue (number, required), unitsSold (number, required), p1UnitsSold (number, required), p2UnitsSold (number, required), brandName (string, required), brandNameAR (string, required), saleChannelBreakdown (array), growthPercentage (number, required), p1Revenue (number, required), p2Revenue (number, required), revenueDelta (number, required), isOutOfStock (boolean, required) or array of listing (object, required), totalRevenue (number, required), unitsSold (number, required), p1UnitsSold (number, required), p2UnitsSold (number, required), brandName (string, required), brandNameAR (string, required), growthPercentage (number, required), p1Revenue (number, required), p2Revenue (number, required), revenueDelta (number, required), isOutOfStock (boolean, required).

Request​