SbPublicApiSalesForecastItem

snowbee.publicapi.SbPublicApiSalesForecastItem

object · non-null

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"

View raw schema

{
  "type": "object",
  "description": "Sales forecast for one store and SKU. The item replaces the whole forecast held for that store and SKU.",
  "properties": {
    "ecomStoreNumber": {
      "type": [
        "null",
        "string"
      ],
      "description": "Ecom store number. Exactly one of retailStoreNumber and ecomStoreNumber must be set.",
      "example": "9001",
      "title": "String"
    },
    "ext": {
      "type": [
        "null",
        "object"
      ],
      "additionalProperties": {
        "type": "object",
        "title": "Any"
      },
      "description": "Partner-owned fields. Never interpreted by Snowbee.",
      "title": "Map<String,Any>"
    },
    "horizonEndDate": {
      "type": "string",
      "format": "date",
      "description": "Last forecast day, an ISO 8601 calendar date. Must equal horizonStartDate plus quantities.length - 1 days; catches horizons of the wrong length.",
      "example": "2026-09-30",
      "title": "LocalDate"
    },
    "horizonStartDate": {
      "type": "string",
      "format": "date",
      "description": "First forecast day, an ISO 8601 calendar date. No earlier than 7 days ago.",
      "example": "2026-09-01",
      "title": "LocalDate"
    },
    "quantities": {
      "type": "array",
      "description": "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\"]",
      "items": {
        "type": "string",
        "title": "String"
      },
      "title": "List<String>"
    },
    "retailStoreNumber": {
      "type": [
        "null",
        "string"
      ],
      "description": "Retail store number. Exactly one of retailStoreNumber and ecomStoreNumber must be set.",
      "example": "1001",
      "title": "String"
    },
    "skuNumber": {
      "type": "string",
      "example": "10025",
      "title": "String"
    }
  },
  "required": [
    "horizonEndDate",
    "horizonStartDate",
    "quantities",
    "skuNumber"
  ],
  "title": "SbPublicApiSalesForecastItem"
}