Skip to main content

Get Forecast

GET 

/v1/inventory-planning

Page through product forecasts and all their destination rows. Filter by brand, channel, search, or signal; a channel filter keeps matching product rows without stripping destinations.

Requires inventory.read.

Request and response fields at a glance
  • Query parameters: page (integer), limit (integer), sortBy (string), sortOrder (string), signals (array), brandIds (array), saleChannelIds (array), search (string).
  • 200 response (application/json): inventoryForecast (array, required), pagination (object, required).

Request​