IKEA · JSON Structure

Ikea Sales Item Sales Location Structure

SalesLocation schema from IKEA Sales Item API

Type: object Properties: 3
RetailHome FurnishingsConsumer ProductsOpensourceCommunityUnofficial APISmart Home

SalesLocation is a JSON Structure definition published by IKEA, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

childItems classUnitKey itemKey

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ikea/refs/heads/main/json-structure/ikea-sales-item-sales-location-structure.json",
  "name": "SalesLocation",
  "description": "SalesLocation schema from IKEA Sales Item API",
  "properties": {
    "childItems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "itemKey": {
            "type": "object",
            "description": "Item key (Product ID and Item type)",
            "properties": {
              "itemNo": {
                "type": "string",
                "description": "Product identifier",
                "example": "00263850"
              },
              "itemType": {
                "type": "string",
                "description": "Item type code\n",
                "enum": [
                  "ART",
                  "SPR"
                ],
                "example": "SPR"
              }
            }
          },
          "salesLocations": {
            "type": "array",
            "items": {
              "type": "object",
              "example": {
                "type": "AISLE_AND_BIN",
                "aisleAndBin": {
                  "aisle": "06",
                  "bin": "01"
                },
                "division": "SELF_SERVE",
                "id": "060100",
                "recommendationRank": 1
              }
            }
          }
        }
      }
    },
    "classUnitKey": {
      "type": "object",
      "description": "Class Unit Key gives context when invoking the AvailabilityClassifications API.\n",
      "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"
        }
      }
    },
    "itemKey": {
      "type": "object",
      "description": "Item key (Product ID and Item type)",
      "properties": {
        "itemNo": {
          "type": "string",
          "description": "Product identifier",
          "example": "00263850"
        },
        "itemType": {
          "type": "string",
          "description": "Item type code\n",
          "enum": [
            "ART",
            "SPR"
          ],
          "example": "SPR"
        }
      }
    }
  }
}