GET/v1/tenants/{tenantId}/demand_planning/sales_forecast_batches/{batchId}

Get the status of a batch of sales forecasts Experimental

Parameters

tenantIdpathstringnon-nullrequired
batchIdpathstringnon-nullrequired: Client-generated UUID of the batch

Responses

200Response

application/jsonobjectnon-null

batchIdstringnon-nullrequired

Client-generated batch id

Example"0192a3b4-5c6d-7e8f-9012-3456789abcde"

batchIndexintegernullableoptional

Format: int32

Example12

batchKindstringnon-nullrequired

Allowed values"SALES_FORECAST""REPLENISHMENT_PARAMETERS"

batchTotalintegernullableoptional

Format: int32

Example140

completedTimestringnullableoptional

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

countsobjectnullableoptional

Null until the batch has been processed

Show child fields

apiUpdatesDisabledintegernon-nullrequired: Items skipped because the retail store is not set to take updates from the API in Snowbee (replenishment parameters only)
Format: int32
Example0
appliedintegernon-nullrequired: Items written to Snowbee
Format: int32
Example4996
itemsintegernon-nullrequired: Format: int32
Example5000
lockedintegernon-nullrequired: Items skipped because the line is locked in Snowbee (replenishment parameters only)
Format: int32
Example0
rejectedintegernon-nullrequired: Items not applied; listed in rejectedItems
Format: int32
Example4
supersededintegernon-nullrequired: Items skipped because a newer generatedAt was already applied for the same key
Format: int32
Example0
unchangedintegernon-nullrequired: Items skipped because they match the values the store already uses (replenishment parameters only)
Format: int32
Example0

errorMessagestringnullableoptional

Why the batch FAILED

generatedAtstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2026-08-28T03:12:00Z"

itemCountintegernon-nullrequired

Format: int32

Example5000

progressstringnon-nullrequired

Allowed values"PENDING""PROCESSING""COMPLETED""COMPLETED_WITH_REJECTED_ITEMS""FAILED"

receivedTimestringnon-nullrequired

When Snowbee stored the batch

Format: ISO 8681 timestamp

Example"2026-08-28T03:12:04.120Z"

rejectedItemsarray of objectnullableoptional

First rejected items; null until processed. See rejectedItemsTruncated.

Show item fields

codestringnon-nullrequired: One of: UNKNOWN_RETAIL_STORE, RETAIL_STORE_NOT_RELEASED, UNKNOWN_ECOM_STORE, ECOM_STORE_NOT_RELEASED, UNKNOWN_SKU, SKU_NOT_IN_ASSORTMENT, REPLENISHMENT_TYPE_MANUAL
Example"UNKNOWN_SKU"
ecomStoreNumberstringnullableoptional: Example"9001"
indexintegernon-nullrequired: 0-based index into items
Format: int32
Example17
messagestringnullableoptional
retailStoreNumberstringnullableoptional: Example"1001"
skuNumberstringnullableoptional: Example"10025"

rejectedItemsTruncatedbooleannon-nullrequired

True when more items were rejected than are listed

Examplefalse

startedTimestringnullableoptional

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

warningsarray of objectnullableoptional

Warnings recorded at receipt and during processing

Show item fields

A non-fatal observation about the batch

codestringnon-nullrequired: UNKNOWN_FIELD: a field Snowbee does not know and did not apply
Example"UNKNOWN_FIELD"
countintegernullableoptional: How many times the observation occurred
Format: int32
Example5000
fieldstringnullableoptional: Path of the field, with [] for array elements
Example"items[].campaignQuantity"
messagestringnullableoptional

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

404Response

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