Get Forecast
GET/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.
With groupBy=parent the page is made of items: a parent (one design sold in several sizes or colours) is one item, and a product with no parent is one item. Each variant keeps its own destinations and signal; a parent sums stock, gap and excess over all its variants, takes the earliest ideal ship date and the worst signal, and counts the variants that need action. An item sorts by its parent's figure: the earliest date for IdealShipDate, the sums for Gap, Stock and Excess.
Requires inventory.read.
Request and response fields at a glance
- Query parameters:
page(integer),limit(integer),sortBy(string),sortOrder(string),signals(array),isOutOfStock(boolean),brandIds(array),saleChannelIds(array),search(string),groupBy(string). - 200 response (application/json):
inventoryForecast(array, required),parents(array),pagination(object, required).