IKEA · Schema

ClassUnitKey

Class Unit Key gives context when invoking the AvailabilityClassifications API.

RetailHome FurnishingsConsumer ProductsOpensourceCommunityUnofficial APISmart Home

Properties

Name	Type	Description
classUnitCode	string	`classUnitCode` is the unique identifier of a Class Unit when combined with a `classUnitType`. A valid `classUnitCode` always has a pattern like `^([A-Z]\|[0-9]){2,5}$`. This can either be a: * **Retai
classUnitType	string	Class Unit Type: * `RU` - Retail Unit - Retail Unit must be combined with a valid `classUnitCode`. For example, `SE` for Sweden or `DE` for Germany. A list of valid Retail Units can be found [in CBD](

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ikea/refs/heads/main/json-schema/ikea-sales-item-class-unit-key-schema.json",
  "title": "ClassUnitKey",
  "description": "Class Unit Key gives context when invoking the AvailabilityClassifications API.\n",
  "type": "object",
  "properties": {
    "classUnitCode": {
      "type": "string",
      "minLength": 2,
      "maxLength": 5,
      "description": "`classUnitCode` is the unique identifier of a Class Unit when\ncombined with a `classUnitType`.\n\nA valid `classUnitCode` always has a pattern like `^([A-Z]|[0-9]){2,5}$`.\n\nThis can either be a:\n\n* **Retail Unit** - Retail Unit must be combined with a valid `classUnitCode`. For example, `SE` for Sweden or `DE` for Germany. A list of valid Class Units can be found [in CBD](https://iwww.cbdview.ikea.com/) (requires VPN or internal network).\n* **Store ID** - The 3-digit store ID. E.g. `066`.\n",
      "examples": [
        "GB",
        "DE",
        "066"
      ]
    },
    "classUnitType": {
      "type": "string",
      "description": "Class Unit Type:\n  * `RU` - Retail Unit - Retail Unit must be combined with a valid `classUnitCode`. For example, `SE` for Sweden or `DE` for Germany. A list of valid Retail Units can be found [in CBD](https://iwww.cbdview.ikea.com/) (requires VPN or internal network).\n  * `STO` - Store - The store availability for a given store\n",
      "enum": [
        "RU",
        "STO"
      ],
      "example": "RU"
    }
  }
}