/ikea/products/accessories

POST /api/ikea/products/accessories

Price: 20 credits

Get the accessories IKEA lists for a product, each with its relation to the product, price, rating and images

How to use it

List the accessories and add-ons of one IKEA product in one market; relation says how each one relates to the product. An accessory with is_sold_in_market false is not sold in the chosen market and carries no price.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string — IKEA market (default: "us"; one of: "ae", "at", "au", "be", "bh", "ca", "ch", "cl", "cn", "co", "cz", "de", "dk", "ee", "eg", "es", "fi", "fr", "gb", "hr", "hu", "ie", "il", "in", "it", "jo", "jp", "kr", "kw", "lt", "lv", "ma", "mx", "my", "nl", "no", "nz", "om", "ph", "pl", "pt", "qa", "ro", "rs", "sa", "se", "sg", "si", "sk", "th", "ua", "us")
• language string nullable — Site language of the market; English where the market offers it when omitted (one of: "ar", "cs", "da", "de", "en", "es", "et", "fi", "fr", "he", "hr", "hu", "it", "ja", "ko", "lt", "lv", "ms", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl", "sr", "sv", "th", "uk", "zh")
• product string required — IKEA item number or product URL; a URL's market and language apply when country is omitted (examples: "20522046", "s19445469", "https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/"; minLength: 1)
• count integer required — Max number of accessories to return (min: 1)

Response

• @type string (default: "IkeaAccessory")
• id string required
• item_type string nullable
• global_item_id string nullable
• name string nullable
• type_name string nullable
• variant_text string nullable
• measure_text string nullable
• url string nullable
• image string nullable
• image_alt string nullable
• contextual_image string nullable
• contextual_image_alt string nullable
• images array (default: [])
  • @type string (default: "IkeaImage")
  • image string required
  • image_type string nullable
  • alt string nullable
• price number nullable
• currency string nullable
• previous_price number nullable
• previous_price_label string nullable
• discount_amount number nullable
• discount_percentage number nullable
• price_tag string nullable
• price_tag_text string nullable
• price_tags array (default: [])
• price_unit string nullable
• price_unit_text string nullable
• price_valid_from_date string nullable
• price_valid_to_date string nullable
• price_disclaimer string nullable
• is_breathtaking_price boolean nullable
• offer object nullable
  • @type string (default: "IkeaPriceOffer")
  • text string nullable
  • member_text string nullable
  • audiences array (default: [])
  • valid_from_date string nullable
  • valid_to_date string nullable
  • validity_text string nullable
• rating number nullable
• rating_count integer nullable
• badge string nullable
• badge_type string nullable
• is_online_sellable boolean nullable
• is_last_chance boolean nullable
• last_chance_text string nullable
• set_item_count integer nullable
• energy_class string nullable
• energy_class_image string nullable
• energy_class_image_alt string nullable
• energy_label_image string nullable
• energy_sheet_url string nullable
• quick_facts array (default: [])
  • @type string (default: "IkeaQuickFact")
  • id string required
  • name string nullable
  • fact_type string nullable
  • type_name string nullable
• min_order_quantity integer nullable
• product_class string nullable
• colors array (default: [])
  • @type string (default: "IkeaColor")
  • id string required
  • name string nullable
  • hex string nullable
• categories array (default: [])
  • @type string (default: "IkeaCategoryRef")
  • id string required
  • name string nullable
• business_area object nullable
  • @type string (default: "IkeaBusinessArea")
  • business_id string nullable
  • business_name string nullable
  • range_area_id string nullable
  • range_area_name string nullable
  • product_area_id string nullable
  • product_area_name string nullable
• variant_count integer nullable
• variants array (default: [])
  • @type string (default: "IkeaVariant")
  • id string required
  • item_type string nullable
  • global_item_id string nullable
  • name string nullable
  • type_name string nullable
  • variant_text string nullable
  • measure_text string nullable
  • url string nullable
  • image string nullable
  • image_alt string nullable
  • contextual_image string nullable
  • contextual_image_alt string nullable
  • images array (default: [])
    • @type string (default: "IkeaImage")
    • image string required
    • image_type string nullable
    • alt string nullable
  • price number nullable
  • currency string nullable
  • previous_price number nullable
  • previous_price_label string nullable
  • discount_amount number nullable
  • discount_percentage number nullable
  • price_tag string nullable
  • price_tag_text string nullable
  • price_tags array (default: [])
  • price_unit string nullable
  • price_unit_text string nullable
  • price_valid_from_date string nullable
  • price_valid_to_date string nullable
  • price_disclaimer string nullable
  • is_breathtaking_price boolean nullable
  • offer object nullable
    • @type string (default: "IkeaPriceOffer")
    • text string nullable
    • member_text string nullable
    • audiences array (default: [])
    • valid_from_date string nullable
    • valid_to_date string nullable
    • validity_text string nullable
  • rating number nullable
  • rating_count integer nullable
  • badge string nullable
  • badge_type string nullable
  • is_online_sellable boolean nullable
  • is_last_chance boolean nullable
  • last_chance_text string nullable
  • set_item_count integer nullable
  • energy_class string nullable
  • energy_class_image string nullable
  • energy_class_image_alt string nullable
  • energy_label_image string nullable
  • energy_sheet_url string nullable
  • quick_facts array (default: [])
    • @type string (default: "IkeaQuickFact")
    • id string required
    • name string nullable
    • fact_type string nullable
    • type_name string nullable
• variations array (default: [])
  • @type string (default: "IkeaVariation")
  • id string required
  • name string nullable
  • values array (default: [])
    • @type string (default: "IkeaVariationValue")
    • name string required
    • product_ids array (default: [])
• relation string nullable
• relevance_score integer nullable
• product_type string nullable
• is_sold_in_market boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No IKEA product has this item number. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.