SbPublicApiReplenishmentParameterBatchRequest

snowbee.publicapi.SbPublicApiReplenishmentParameterBatchRequest

object · non-null

A batch of replenishment parameters from one planning run

batchIndexintegernullableoptional

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

Format: int32

Example1

batchTotalintegernullableoptional

Number of batches in the run

Format: int32

Example3

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

extdictionary of objectnullableoptional: Partner-owned fields. Never interpreted by Snowbee.
Show dictionary values
Each dictionary key maps to objectnon-null.
maximumInventorystringnon-nullrequired: Maximum inventory as a decimal string with at most 4 decimals
Example"12"
reorderPointstringnon-nullrequired: Reorder point as a decimal string with at most 4 decimals. Must be less than maximumInventory.
Example"3"
retailStoreNumberstringnon-nullrequired: Example"1001"
skuNumberstringnon-nullrequired: Example"10025"

View raw schema

{
  "type": "object",
  "description": "A batch of replenishment parameters 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": "1",
      "title": "Int"
    },
    "batchTotal": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "description": "Number of batches in the run",
      "example": "3",
      "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.SbPublicApiReplenishmentParameterItem"
      },
      "title": "List<SbPublicApiReplenishmentParameterItem>"
    }
  },
  "required": [
    "generatedAt",
    "itemCount",
    "items"
  ],
  "title": "SbPublicApiReplenishmentParameterBatchRequest"
}