SbPublicApiDemandPlanningLimitsResponse

snowbee.publicapi.SbPublicApiDemandPlanningLimitsResponse

object · non-null

Published limits for demand planning batch uploads. Requests above a hard limit are rejected with 413.

maxBodyBytesintegernon-nullrequired: Maximum request body size in bytes as sent over the wire
Format: int64
Example10485760
maxCompressionRatiointegernon-nullrequired: Maximum ratio between decompressed and compressed body size
Format: int32
Example100
maxDecimalsintegernon-nullrequired: Maximum decimals in quantities and replenishment parameters
Format: int32
Example4
maxDecompressedBodyBytesintegernon-nullrequired: Maximum request body size in bytes after gzip decompression
Format: int64
Example52428800
maxHorizonDaysintegernon-nullrequired: Maximum number of days in a sales forecast horizon: two full years, the current one and the next
Format: int32
Example731
maxInlineRejectedItemsintegernon-nullrequired: Maximum number of rejected items listed in a batch status
Format: int32
Example500
maxInlineValidationErrorsintegernon-nullrequired: Maximum number of validation errors listed in a 400 response
Format: int32
Example100
maxItemsPerBatchintegernon-nullrequired: Maximum number of items per batch
Format: int32
Example20000
recommendedBodyBytesintegernon-nullrequired: Recommended request body size in bytes as sent over the wire, assuming gzip. A 1,000-item forecast batch of 731-day horizons is ~5.7 MB uncompressed and ~1.3 MB gzipped.
Format: int64
Example1048576
recommendedHorizonDaysintegernon-nullrequired: Recommended number of days in a sales forecast horizon: to the end of next year
Format: int32
Example731
recommendedItemsPerBatchintegernon-nullrequired: Recommended number of items per batch, sized for horizons of up to two years
Format: int32
Example1000

View raw schema

{
  "type": "object",
  "description": "Published limits for demand planning batch uploads. Requests above a hard limit are rejected with 413.",
  "properties": {
    "maxBodyBytes": {
      "type": "integer",
      "format": "int64",
      "description": "Maximum request body size in bytes as sent over the wire",
      "example": "10485760",
      "title": "Long"
    },
    "maxCompressionRatio": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum ratio between decompressed and compressed body size",
      "example": "100",
      "title": "Int"
    },
    "maxDecimals": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum decimals in quantities and replenishment parameters",
      "example": "4",
      "title": "Int"
    },
    "maxDecompressedBodyBytes": {
      "type": "integer",
      "format": "int64",
      "description": "Maximum request body size in bytes after gzip decompression",
      "example": "52428800",
      "title": "Long"
    },
    "maxHorizonDays": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum number of days in a sales forecast horizon: two full years, the current one and the next",
      "example": "731",
      "title": "Int"
    },
    "maxInlineRejectedItems": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum number of rejected items listed in a batch status",
      "example": "500",
      "title": "Int"
    },
    "maxInlineValidationErrors": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum number of validation errors listed in a 400 response",
      "example": "100",
      "title": "Int"
    },
    "maxItemsPerBatch": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum number of items per batch",
      "example": "20000",
      "title": "Int"
    },
    "recommendedBodyBytes": {
      "type": "integer",
      "format": "int64",
      "description": "Recommended request body size in bytes as sent over the wire, assuming gzip. A 1,000-item forecast batch of 731-day horizons is ~5.7 MB uncompressed and ~1.3 MB gzipped.",
      "example": "1048576",
      "title": "Long"
    },
    "recommendedHorizonDays": {
      "type": "integer",
      "format": "int32",
      "description": "Recommended number of days in a sales forecast horizon: to the end of next year",
      "example": "731",
      "title": "Int"
    },
    "recommendedItemsPerBatch": {
      "type": "integer",
      "format": "int32",
      "description": "Recommended number of items per batch, sized for horizons of up to two years",
      "example": "1000",
      "title": "Int"
    }
  },
  "required": [
    "maxBodyBytes",
    "maxCompressionRatio",
    "maxDecimals",
    "maxDecompressedBodyBytes",
    "maxHorizonDays",
    "maxInlineRejectedItems",
    "maxInlineValidationErrors",
    "maxItemsPerBatch",
    "recommendedBodyBytes",
    "recommendedHorizonDays",
    "recommendedItemsPerBatch"
  ],
  "title": "SbPublicApiDemandPlanningLimitsResponse"
}