IKEA · JSON Structure

Ikea Sales Item Availability Error Structure

Error object describing the reason of failure

Type: object Properties: 3 Required: 2
RetailHome FurnishingsConsumer ProductsOpensourceCommunityUnofficial APISmart Home

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

Properties

code details message

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-availability-error-structure.json",
  "name": "AvailabilityError",
  "description": "Error object describing the reason of failure",
  "properties": {
    "code": {
      "type": "int32",
      "description": "Error Codes:\n  * `404` - Not found\n  * `405` - ClassUnitCode doesn't exist\n  * `602` - itemNos in query is required\n  * `604` - itemNos.`n` in query should be at least 8 chars long. Where `n` is the positional indicator for the parameter.\n  * `606` - expand.`n` in query should be one of [ChildItems Restocks StoresList SalesLocations DeliveryPrice CollectPrice DisplayLocations DeliveryTime FoodAvailabilities]. Where `n` is the positional indicator for the parameter.\n",
      "example": 404
    },
    "details": {
      "type": "object",
      "description": "Additional error details. These change depending on the context of the query.",
      "example": {
        "classUnitCode": "DE",
        "classUnitType": "RU",
        "itemNo": "s59047406"
      }
    },
    "message": {
      "type": "string",
      "description": "Error message indicating the failure",
      "example": "Not found"
    }
  },
  "required": [
    "code",
    "message"
  ]
}