Developer docs

← All schemas

SbPublicApiEcomStoreProductResponse

snowbee.SbPublicApiEcomStoreProductResponse

object · non-null

brandIdstringnon-nullrequired

Brand identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
bundledProductModelIdsarray of stringnon-nullrequired

IDs of bundled product models

dynamicAttributeValuesarray of objectnon-nullrequired
Show item fields

One or more of these shapes may apply.

SbPublicApiEcomStoreProductDynamicAttributeValuesResponse.SbPublicApiEcomStoreProductDynamicAttributeValuesResponseBoolean objectnon-null
idstringnon-nullrequired

Dynamic attribute identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
typestringnon-nullrequired
Allowed values"BOOLEAN""RANGE""SINGLE_SELECT""MULTI_SELECT""TEXT"
valuebooleannon-nullrequired
Exampletrue
SbPublicApiEcomStoreProductDynamicAttributeValuesResponse.SbPublicApiEcomStoreProductDynamicAttributeValuesResponseMultiSelect objectnon-null
idstringnon-nullrequired

Dynamic attribute identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
typestringnon-nullrequired
Allowed values"BOOLEAN""RANGE""SINGLE_SELECT""MULTI_SELECT""TEXT"
valuearray of stringnon-nullrequired

List of selected option IDs

SbPublicApiEcomStoreProductDynamicAttributeValuesResponse.SbPublicApiEcomStoreProductDynamicAttributeValuesResponseRange objectnon-null
idstringnon-nullrequired

Dynamic attribute identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
typestringnon-nullrequired
Allowed values"BOOLEAN""RANGE""SINGLE_SELECT""MULTI_SELECT""TEXT"
valuestringnon-nullrequired
  • Format: BigDecimal
Example"42.5"
SbPublicApiEcomStoreProductDynamicAttributeValuesResponse.SbPublicApiEcomStoreProductDynamicAttributeValuesResponseSingleSelect objectnon-null
idstringnon-nullrequired

Dynamic attribute identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
typestringnon-nullrequired
Allowed values"BOOLEAN""RANGE""SINGLE_SELECT""MULTI_SELECT""TEXT"
valuestringnullableoptional

Selected option ID

Example"01234567-89ab-cdef-0123-456789abcdef"
SbPublicApiEcomStoreProductDynamicAttributeValuesResponse.SbPublicApiEcomStoreProductDynamicAttributeValuesResponseText objectnon-null
idstringnon-nullrequired

Dynamic attribute identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
typestringnon-nullrequired
Allowed values"BOOLEAN""RANGE""SINGLE_SELECT""MULTI_SELECT""TEXT"
valueobjectnon-nullrequired
Show child fields
valuedictionary of stringnon-nullrequired
Show dictionary values

Each dictionary key maps to stringnon-null.

View schema definition

exclusivityLevelIdstringnullableoptional

Exclusivity level identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
idstringnon-nullrequired
Example"01234567-89ab-cdef-0123-456789abcdef"
imagesarray of objectnon-nullrequired
Show item fields
idstringnon-nullrequired
Example"01234567-89ab-cdef-0123-456789abcdef"
productColorIdstringnullableoptional

The product colour this image shows, matching a sku's productColorId; null for images of the product as such

sortOrderintegernon-nullrequired

Sort order for display

  • Format: int32
Example1
urlstringnon-nullrequired
Example"https://cdn.example.com/images/product-001.jpg"
mainProductGroupIdstringnon-nullrequired

Main product group identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
newFromstringnullableoptional

Date the product is tagged as new from (inclusive)

  • Format: date
Example"2026-06-01"
newTostringnullableoptional

Date the product is tagged as new until (inclusive)

  • Format: date
Example"2026-08-31"
offersarray of objectnon-nullrequired

Basket offers such as 3 for 2 that cover the product; the prices above do not include them

Show item fields

A basket offer that covers the product, such as 3 for 2. It has no unit price of its own; the cart applies it once the basket qualifies.

campaignIdstringnon-nullrequired
campaignTypestringnon-nullrequired

Kind of offer; currently only THREE_FOR_TWO

Allowed values"NORMAL""THREE_FOR_TWO"
Example"THREE_FOR_TWO"
codestringnullableoptional
Example"TFT-SUMMER"
loyaltyProgramMembershipRequiredbooleannon-nullrequired

Whether only loyalty members get the offer

Examplefalse
namestringnon-nullrequired
pricedictionary of objectnon-nullrequired

Current prices by currency (key is ISO 4217 currency code)

Show dictionary values

Each dictionary key maps to objectnon-null.

campaignPricestringnullableoptional
  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"249.00"
loyaltyMemberPricestringnullableoptional
  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"239.00"
pricestringnon-nullrequired

Regular price

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"299.00"
productCategoryIdstringnon-nullrequired

Product category identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
productConceptIdstringnullableoptional

Product concept identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
productDescriptionobjectnon-nullrequired
Show child fields
valuedictionary of stringnon-nullrequired
Show dictionary values

Each dictionary key maps to stringnon-null.

productFeaturesarray of objectnon-nullrequired
Show item fields
valuedictionary of stringnon-nullrequired
Show dictionary values

Each dictionary key maps to stringnon-null.

productNameobjectnon-nullrequired
Show child fields
valuedictionary of stringnon-nullrequired
Show dictionary values

Each dictionary key maps to stringnon-null.

productNumberstringnon-nullrequired
Example"PROD-001"
publishedbooleannon-nullrequired
Exampletrue
skusarray of objectnon-nullrequired
Show item fields
barcodestringnullableoptional

Barcode (EAN/UPC)

Example"1234567890123"
idstringnon-nullrequired
Example"01234567-89ab-cdef-0123-456789abcdef"
productColorIdstringnullableoptional

Product color identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
publishedbooleannon-nullrequired
Exampletrue
sizeIdstringnullableoptional

Size identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
skuNumberstringnon-nullrequired
Example"PROD-BLK-M"
subProductGroupIdstringnon-nullrequired

Sub product group identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
upcomingPriceCalendardictionary of array of objectnon-nullrequired

Upcoming price changes by currency for the next 30 days, including timed campaign changes later today

Show dictionary values

Each dictionary key maps to array of objectnon-null.

activatesAtstringnon-nullrequired

Exact activation instant in the tenant time zone; may be within the day rather than at midnight

  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
campaignPricestringnullableoptional
  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"269.00"
loyaltyMemberPricestringnullableoptional
  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"259.00"
pricestringnon-nullrequired

Regular price

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"319.00"
vatGroupIdstringnon-nullrequired

VAT group identifier

Example"01234567-89ab-cdef-0123-456789abcdef"
View raw schema
{
  "type": "object",
  "properties": {
    "brandId": {
      "type": "string",
      "description": "Brand identifier",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "bundledProductModelIds": {
      "type": "array",
      "description": "IDs of bundled product models",
      "items": {
        "type": "string",
        "title": "String"
      },
      "title": "List<String>"
    },
    "dynamicAttributeValues": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiEcomStoreProductDynamicAttributeValuesResponse"
      },
      "title": "List<SbPublicApiEcomStoreProductDynamicAttributeValuesResponse>"
    },
    "exclusivityLevelId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Exclusivity level identifier",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "images": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiEcomStoreProductImageResponse"
      },
      "title": "List<SbPublicApiEcomStoreProductImageResponse>"
    },
    "mainProductGroupId": {
      "type": "string",
      "description": "Main product group identifier",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "newFrom": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "description": "Date the product is tagged as new from (inclusive)",
      "example": "2026-06-01",
      "title": "LocalDate"
    },
    "newTo": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "description": "Date the product is tagged as new until (inclusive)",
      "example": "2026-08-31",
      "title": "LocalDate"
    },
    "offers": {
      "type": "array",
      "description": "Basket offers such as 3 for 2 that cover the product; the prices above do not include them",
      "items": {
        "$ref": "#/components/schemas/snowbee.ecom.catalog.SbPublicApiProductOffer"
      },
      "title": "List<SbPublicApiProductOffer>"
    },
    "price": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiProductPrice"
      },
      "description": "Current prices by currency (key is ISO 4217 currency code)",
      "title": "Map<String,SbPublicApiProductPrice>"
    },
    "productCategoryId": {
      "type": "string",
      "description": "Product category identifier",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "productConceptId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Product concept identifier",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "productDescription": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiLocalizedString"
    },
    "productFeatures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiLocalizedString"
      },
      "title": "List<SbPublicApiLocalizedString>"
    },
    "productName": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiLocalizedString"
    },
    "productNumber": {
      "type": "string",
      "example": "PROD-001",
      "title": "String"
    },
    "published": {
      "type": "boolean",
      "example": "true",
      "title": "Boolean"
    },
    "skus": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiEcomStoreProductSkuResponse"
      },
      "title": "List<SbPublicApiEcomStoreProductSkuResponse>"
    },
    "subProductGroupId": {
      "type": "string",
      "description": "Sub product group identifier",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "upcomingPriceCalendar": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/snowbee.SbPublicApiUpcomingProductPrice"
        },
        "title": "List<SbPublicApiUpcomingProductPrice>"
      },
      "description": "Upcoming price changes by currency for the next 30 days, including timed campaign changes later today",
      "title": "Map<String,List<SbPublicApiUpcomingProductPrice>>"
    },
    "vatGroupId": {
      "type": "string",
      "description": "VAT group identifier",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    }
  },
  "required": [
    "brandId",
    "bundledProductModelIds",
    "dynamicAttributeValues",
    "id",
    "images",
    "mainProductGroupId",
    "offers",
    "price",
    "productCategoryId",
    "productDescription",
    "productFeatures",
    "productName",
    "productNumber",
    "published",
    "skus",
    "subProductGroupId",
    "upcomingPriceCalendar",
    "vatGroupId"
  ],
  "title": "SbPublicApiEcomStoreProductResponse"
}