SbPublicApiSalesForecastResponse

snowbee.publicapi.SbPublicApiSalesForecastResponse

The sales forecast Snowbee currently holds for one store and SKU

ecomStoreNumberoptional
Example"9001"
generatedAtrequired

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"
horizonEndDaterequired
  • Format: date
Example"2026-09-30"
horizonStartDaterequired
  • Format: date
Example"2026-09-01"
modifiedTimerequired

When Snowbee applied it

  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
quantitiesrequired

Expected gross sales quantity per day from horizonStartDate, as decimal strings

Example["4.7","3.1","0"]
retailStoreNumberoptional
Example"1001"
skuNumberrequired
Example"10025"
View raw schema
{
  "type": "object",
  "description": "The sales forecast Snowbee currently holds for one store and SKU",
  "properties": {
    "ecomStoreNumber": {
      "type": [
        "null",
        "string"
      ],
      "example": "9001",
      "title": "String"
    },
    "generatedAt": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "description": "The planning run that produced this forecast. An old value means the horizon is stale.",
      "example": "2026-08-31T03:12:00Z",
      "title": "ISO8681"
    },
    "horizonEndDate": {
      "type": "string",
      "format": "date",
      "example": "2026-09-30",
      "title": "LocalDate"
    },
    "horizonStartDate": {
      "type": "string",
      "format": "date",
      "example": "2026-09-01",
      "title": "LocalDate"
    },
    "modifiedTime": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "description": "When Snowbee applied it",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "quantities": {
      "type": "array",
      "description": "Expected gross sales quantity per day from horizonStartDate, as decimal strings",
      "example": "[\"4.7\", \"3.1\", \"0\"]",
      "items": {
        "type": "string",
        "title": "String"
      },
      "title": "List<String>"
    },
    "retailStoreNumber": {
      "type": [
        "null",
        "string"
      ],
      "example": "1001",
      "title": "String"
    },
    "skuNumber": {
      "type": "string",
      "example": "10025",
      "title": "String"
    }
  },
  "required": [
    "generatedAt",
    "horizonEndDate",
    "horizonStartDate",
    "modifiedTime",
    "quantities",
    "skuNumber"
  ],
  "title": "SbPublicApiSalesForecastResponse"
}