GET/v1/tenants/{tenantId}/demand_planning/sales_forecasts

List the sales forecasts SnowBee currently holds Experimental

The current forecast horizon per store and SKU, as applied from processed batches — use it to verify uploads and to compare against your own model. Retail stores come first in store number order, then ecom stores; a page never spans two stores. generatedAt is the planning run that produced each horizon, so an old value means the forecast is stale.

Parameters

tenantIdpathstringnon-nullrequired
retailStoreNumberquerystringnon-nulloptional
ecomStoreNumberquerystringnon-nulloptional
cursorquerystringnon-nulloptional: nextCursor from the previous page
limitqueryintegernon-nulloptional: Page size, default 1000, max 5000
Format: int32

Responses

200Response

application/jsonobjectnon-null

A page of current sales forecasts, retail stores first, ordered by store number then SKU number

itemsarray of objectnon-nullrequired

Show item fields

The sales forecast Snowbee currently holds for one store and SKU

ecomStoreNumberstringnullableoptional: Example"9001"
generatedAtstringnon-nullrequired: The planning run that produced this forecast. An old value means the horizon is stale.
Format: ISO 8681 timestamp
Example"2026-08-31T03:12:00Z"
horizonEndDatestringnon-nullrequired: Format: date
Example"2026-09-30"
horizonStartDatestringnon-nullrequired: Format: date
Example"2026-09-01"
modifiedTimestringnon-nullrequired: When Snowbee applied it
Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
quantitiesarray of stringnon-nullrequired: Expected gross sales quantity per day from horizonStartDate, as decimal strings
Example["4.7","3.1","0"]
retailStoreNumberstringnullableoptional: Example"1001"
skuNumberstringnon-nullrequired: Example"10025"

nextCursorstringnullableoptional

Pass as cursor to fetch the next page; null on the last page

View schema definition

400Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

401Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition