/ikea/products/stock

POST /api/ikea/products/stock

Price: 20 credits

Get IKEA stock of a product in every store of a market, with quantities, restock dates and aisle locations, plus home delivery and click and collect for a postal code

How to use it

Check where one IKEA product is in stock across a market's stores. Pass zip_code to get the delivery price, delivery dates and click and collect for that address. Store rows include plan-and-order points and pop-up locations; a few rows carry only the location id and stock, with no name or address.

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)
• zip_code string nullable — Postal code for home delivery and click and collect (examples: "10001"; pattern: ^[0-9A-Za-z][0-9A-Za-z -]{1,10}$)

Response

• @type string (default: "IkeaStock")
• id string required
• item_type string nullable
• country string required
• zip_code string nullable
• delivery object nullable
  • @type string (default: "IkeaDelivery")
  • is_available boolean nullable
  • is_in_range boolean nullable
  • stock_level string nullable
  • is_parcel boolean nullable
  • has_limited_methods boolean nullable
  • is_stock_notification_eligible boolean nullable
  • price number nullable
  • min_price number nullable
  • currency string nullable
  • delivery_type string nullable
  • earliest_date string nullable
  • from_date string nullable
  • to_date string nullable
  • min_days integer nullable
  • max_days integer nullable
  • updated_at integer nullable
• is_available_for_click_collect boolean nullable
• store_count integer nullable
• in_stock_store_count integer nullable
• stores array (default: [])
  • @type string (default: "IkeaStoreStock")
  • store_id string required
  • store_name string nullable
  • store_type string nullable
  • city string nullable
  • state string nullable
  • postal_code string nullable
  • latitude number nullable
  • longitude number nullable
  • store_url string nullable
  • is_available_for_cash_carry boolean nullable
  • is_available_for_click_collect boolean nullable
  • is_in_range boolean nullable
  • is_click_collect_in_range boolean nullable
  • quantity integer nullable
  • stock_level string nullable
  • stock_updated_at integer nullable
  • is_stock_notification_eligible boolean nullable
  • tags array (default: [])
  • restocks array (default: [])
    • @type string (default: "IkeaRestock")
    • quantity integer nullable
    • earliest_date string nullable
    • latest_date string nullable
    • reliability string nullable
    • restock_type string nullable
    • updated_at integer nullable
  • shelf_locations array (default: [])
    • @type string (default: "IkeaShelfLocation")
    • id string required
    • aisle string nullable
    • bin string nullable
    • division string nullable
    • location_type string nullable
    • recommendation_rank integer nullable

Errors

• 422 — IKEA does not recognise this postal code in this market. 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 — The product is not sold in this market or 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.