Skip to main content

Get Overview

GET 

/v1/vendor/purchase-orders/overview

Read vendor purchase-order totals and operational overview for the selected brand, channel, category, tier, and date scope.

Requires salesPerformance.read.

Request and response fields at a glance
  • Query parameters: brandIds (array), saleChannelIds (array), startDate (string), endDate (string).
  • 200 response (application/json): metrics (object, required), actionsRequired (object, required), brandPerformance (array, required), retailerPerformance (array, required), distributions (object, required), topPerformers (array, required).

Request​