← All schemas

SbPublicApiSalesForecastBatchRequest

snowbee.publicapi.SbPublicApiSalesForecastBatchRequest

object · non-null

A batch of sales forecasts from one planning run

batchIndexintegernullableoptional

1-based position of this batch within the run. Set together with batchTotal or not at all.

• Format: int32

Example12

batchTotalintegernullableoptional

Number of batches in the run

• Format: int32

Example140

extdictionary of objectnullableoptional

Partner-owned fields. Never interpreted by Snowbee.

Show dictionary values

Each dictionary key maps to objectnon-null.

generatedAtstringnon-nullrequired

Timestamp of the planning run that produced every item in the batch. Identical for all batches of one run; a later run must have a later value.

• Format: ISO 8681 timestamp

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

itemCountintegernon-nullrequired

Must equal the length of items

• Format: int32

Example5000

itemsarray of objectnon-nullrequired

Show item fields

Sales forecast for one store and SKU. The item replaces the whole forecast held for that store and SKU.

ecomStoreNumberstringnullableoptional

Ecom store number. Exactly one of retailStoreNumber and ecomStoreNumber must be set.

Example"9001"

extdictionary of objectnullableoptional

Partner-owned fields. Never interpreted by Snowbee.

Show dictionary values

Each dictionary key maps to objectnon-null.

horizonEndDatestringnon-nullrequired

Last forecast day, an ISO 8601 calendar date. Must equal horizonStartDate plus quantities.length - 1 days; catches horizons of the wrong length.

• Format: date

Example"2026-09-30"

horizonStartDatestringnon-nullrequired

First forecast day, an ISO 8601 calendar date. No earlier than 7 days ago.

• Format: date

Example"2026-09-01"

quantitiesarray of stringnon-nullrequired

Expected gross sales quantity per day from horizonStartDate to horizonEndDate inclusive, as decimal strings with at most 4 decimals. quantities[i] is the forecast for horizonStartDate plus i days.

Example["4.7","3.1","0","5.25"]

retailStoreNumberstringnullableoptional

Retail store number. Exactly one of retailStoreNumber and ecomStoreNumber must be set.

Example"1001"

skuNumberstringnon-nullrequired

Example"10025"

{
  "type": "object",
  "description": "A batch of sales forecasts from one planning run",
  "properties": {
    "batchIndex": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "description": "1-based position of this batch within the run. Set together with batchTotal or not at all.",
      "example": "12",
      "title": "Int"
    },
    "batchTotal": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "description": "Number of batches in the run",
      "example": "140",
      "title": "Int"
    },
    "ext": {
      "type": [
        "null",
        "object"
      ],
      "additionalProperties": {
        "type": "object",
        "title": "Any"
      },
      "description": "Partner-owned fields. Never interpreted by Snowbee.",
      "title": "Map<String,Any>"
    },
    "generatedAt": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "description": "Timestamp of the planning run that produced every item in the batch. Identical for all batches of one run; a later run must have a later value.",
      "example": "2026-08-28T03:12:00Z",
      "title": "ISO8681"
    },
    "itemCount": {
      "type": "integer",
      "format": "int32",
      "description": "Must equal the length of items",
      "example": "5000",
      "title": "Int"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.publicapi.SbPublicApiSalesForecastItem"
      },
      "title": "List<SbPublicApiSalesForecastItem>"
    }
  },
  "required": [
    "generatedAt",
    "itemCount",
    "items"
  ],
  "title": "SbPublicApiSalesForecastBatchRequest"
}