SbPublicApiDemandPlanningBatchStatusResponse

snowbee.publicapi.SbPublicApiDemandPlanningBatchStatusResponse

object · non-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 raw schema

{
  "type": "object",
  "properties": {
    "batchId": {
      "type": "string",
      "description": "Client-generated batch id",
      "example": "0192a3b4-5c6d-7e8f-9012-3456789abcde",
      "title": "String"
    },
    "batchIndex": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "example": "12",
      "title": "Int"
    },
    "batchKind": {
      "$ref": "#/components/schemas/snowbee.publicapi.SbPublicApiDemandPlanningBatchKind"
    },
    "batchTotal": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "example": "140",
      "title": "Int"
    },
    "completedTime": {
      "type": [
        "null",
        "string"
      ],
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "counts": {
      "description": "Null until the batch has been processed",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.publicapi.SbPublicApiDemandPlanningBatchCounts"
        }
      ]
    },
    "errorMessage": {
      "type": [
        "null",
        "string"
      ],
      "description": "Why the batch FAILED",
      "title": "String"
    },
    "generatedAt": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2026-08-28T03:12:00Z",
      "title": "ISO8681"
    },
    "itemCount": {
      "type": "integer",
      "format": "int32",
      "example": "5000",
      "title": "Int"
    },
    "progress": {
      "$ref": "#/components/schemas/snowbee.publicapi.SbPublicApiDemandPlanningBatchProgress"
    },
    "receivedTime": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "description": "When Snowbee stored the batch",
      "example": "2026-08-28T03:12:04.120Z",
      "title": "ISO8681"
    },
    "rejectedItems": {
      "type": [
        "null",
        "array"
      ],
      "description": "First rejected items; null until processed. See rejectedItemsTruncated.",
      "items": {
        "$ref": "#/components/schemas/snowbee.publicapi.SbPublicApiDemandPlanningRejectedItem"
      },
      "title": "List<SbPublicApiDemandPlanningRejectedItem>"
    },
    "rejectedItemsTruncated": {
      "type": "boolean",
      "description": "True when more items were rejected than are listed",
      "example": "false",
      "title": "Boolean"
    },
    "startedTime": {
      "type": [
        "null",
        "string"
      ],
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "warnings": {
      "type": [
        "null",
        "array"
      ],
      "description": "Warnings recorded at receipt and during processing",
      "items": {
        "$ref": "#/components/schemas/snowbee.publicapi.SbPublicApiDemandPlanningWarning"
      },
      "title": "List<SbPublicApiDemandPlanningWarning>"
    }
  },
  "required": [
    "batchId",
    "batchKind",
    "generatedAt",
    "itemCount",
    "progress",
    "receivedTime",
    "rejectedItemsTruncated"
  ],
  "title": "SbPublicApiDemandPlanningBatchStatusResponse"
}