IKEA · Schema

SearchPart

Replacement part (returned in search results)

RetailHome FurnishingsConsumer ProductsOpensourceCommunityUnofficial APISmart Home

Properties

Name Type Description
itemId string Part identifier - typically 5-8 digit number, may include suffix like `/1` or `-1`
partName string Part name
partDescription string Part description
categoryId string Category identifier
subCategoryId string Subcategory identifier
stock integer Stock status
status string Part Status: * `AVAILABLE` - Part is available * `NOT_AVAILABLE` - Part is not available * `ORDER_AT_CSC` - Order at the Customer Service Center * `OUT_OF_STOCK` - Part is out of stock * `DISCONTINUED
partColor string Part Color
partReplaceId string Part identifier - typically 5-8 digit number, may include suffix like `/1` or `-1`
View JSON Schema on GitHub

JSON Schema

ikea-after-purchase-ordering-search-part-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ikea/refs/heads/main/json-schema/ikea-after-purchase-ordering-search-part-schema.json",
  "title": "SearchPart",
  "description": "Replacement part (returned in search results)",
  "type": "object",
  "properties": {
    "itemId": {
      "type": "string",
      "description": "Part identifier - typically 5-8 digit number, may include suffix like `/1` or `-1`",
      "example": "100001"
    },
    "partName": {
      "type": "string",
      "description": "Part name",
      "example": "KEY HEXAGON 4MM SSH L48 ZN"
    },
    "partDescription": {
      "type": "string",
      "description": "Part description",
      "example": "S-SHAPE, WIDTH=20, LENGTH=48, HARDENED HRC 52 +5/-10"
    },
    "categoryId": {
      "type": "string",
      "description": "Category identifier",
      "example": "P1201"
    },
    "subCategoryId": {
      "type": "string",
      "description": "Subcategory identifier",
      "example": "12101"
    },
    "stock": {
      "type": "integer",
      "description": "Stock status",
      "example": 352
    },
    "status": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "NOT_AVAILABLE",
        "ORDER_AT_CSC",
        "OUT_OF_STOCK",
        "DISCONTINUED_WITH_REPLACEMENTID"
      ],
      "description": "Part Status:\n  * `AVAILABLE` - Part is available\n  * `NOT_AVAILABLE` - Part is not available\n  * `ORDER_AT_CSC` - Order at the Customer Service Center\n  * `OUT_OF_STOCK` - Part is out of stock\n  * `DISCONTINUED_WITH_REPLACEMENTID` - Part is discontinued and replaced by provided id.\n",
      "example": "AVAILABLE"
    },
    "partColor": {
      "type": "string",
      "description": "Part Color",
      "example": "Grey"
    },
    "partReplaceId": {
      "type": "string",
      "description": "Part identifier - typically 5-8 digit number, may include suffix like `/1` or `-1`",
      "example": "100001"
    }
  },
  "required": [
    "itemId",
    "partName",
    "categoryId",
    "subCategoryId",
    "stock",
    "status",
    "partColor",
    "partReplaceId"
  ]
}