Skip to main content

List cancellation and return risks by product

GET 

/v1/brand-health/brands/:brandId/cancel-return-products

Page through products with cancellation, return, and combined rejection rates, with channel and reason details.

Requires brandHealth.read.

Request and response fields at a glance
  • Path parameters: brandId (integer, required).
  • Query parameters: saleChannelIds (array), categories (array), productTiers (array), saleChannelId (integer), region (string), productTier (integer), sortBy (string), sortOrder (string), page (integer), limit (integer).
  • 200 response (application/json): cancelReturnProducts (array, required), pagination (object, required).

Request​