Skip to main content

Get Product Performance

GET 

/products/:id/performance

Read this product’s performance using the product ID and optional date, channel, and breakdown filters.

When the product is a variant of a parent (one design sold in several sizes or colours), parent names the parent and lists every one of its variants with its catalog stock, units and revenue, so a caller can move between sizes or colours from one read. performanceBreakdown does not change this read.

Requires sales-performance.read.

Request and response fields at a glance
  • Path parameters: id (integer, required).
  • Query parameters: startDate (string), endDate (string), excludeSaleChannelIds (array), performanceBreakdown (string), page (integer), limit (integer), productTiers (array), categories (array).
  • 200 response (application/json): listingsPerformance (array, required), productPerformance (object, required), productTotalRevenue (number, required), productTotalUnitsSold (number, required), productTotalOrderCount (number, required), aov (number, required), product (object, required), trafficTrends (array, required), inventoryTrends (array), pricingImpact (array), ratingTrends (array), listings (array, required), parent (object or null).

Request​