/ikea/stores/search

POST /api/ikea/stores/search

Price: 5 credits

Find IKEA stores in a market by name, city, postal code, state, format or distance from a point, with opening hours and addresses

How to use it

List one IKEA market's stores; with no filter it returns all of them. Pass latitude and longitude to get the nearest first, with distance_km measured in a straight line. Use a returned id with the IKEA stock endpoint's store rows. Most plan-and-order points and pop-up locations are not listed here; the IKEA stores endpoint fetches them by the store_id of a stock row.

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")
• count integer required — Max number of stores to return (min: 1)
• query string nullable — Text the store name, address, city or postal code contains (examples: "Brooklyn"; minLength: 1)
• state string nullable — State or province code (examples: "USNY", "DEBY"; minLength: 1)
• store_types array nullable — Store formats (one of: "store", "small_store", "plan_and_order_point", "shop", "fulfilment_point")
• latitude number nullable — Latitude to order stores by distance from (min: -90; max: 90)
• longitude number nullable — Longitude to order stores by distance from (min: -180; max: 180)
• max_distance_km number nullable — Only stores within this many kilometres (>: 0)

Response

• @type string (default: "IkeaStore")
• id string required
• name string nullable
• display_name string nullable
• alternate_name string nullable
• store_type string nullable
• store_type_name string nullable
• parent_store_id string nullable
• url string nullable
• address string nullable
• address_line2 string nullable
• display_address string nullable
• city string nullable
• state string nullable
• postal_code string nullable
• timezone string nullable
• latitude number nullable
• longitude number nullable
• distance_km number nullable
• google_place_id string nullable
• opened_at integer nullable
• closing_at integer nullable
• is_cash_and_carry boolean nullable
• is_treated_as_store boolean nullable
• is_hidden boolean nullable
• is_home_shopping_unit boolean nullable
• week_start_day string nullable
• hours array (default: [])
  • @type string (default: "IkeaOpeningHours")
  • service string required
  • day string required
  • opens_at string nullable
  • closes_at string nullable
• special_hours array (default: [])
  • @type string (default: "IkeaSpecialHours")
  • date string required
  • opens_at string nullable
  • closes_at string nullable
  • reason string nullable
  • is_closed boolean nullable
• notes array (default: [])
  • @type string (default: "IkeaStoreNote")
  • service string required
  • heading string nullable
  • text string nullable
• pickup_point object nullable
  • @type string (default: "IkeaPickupPoint")
  • name string nullable
  • address string nullable
  • city string nullable
  • postal_code string nullable
  • latitude number nullable
  • longitude number nullable
  • hours array (default: [])
    • @type string (default: "IkeaOpeningHours")
    • service string required
    • day string required
    • opens_at string nullable
    • closes_at string nullable
• ev_charging object nullable
  • @type string (default: "IkeaEvCharging")
  • operator string nullable
  • owner string nullable
  • location_type string nullable
  • is_closed boolean nullable
  • connectors array (default: [])
    • @type string (default: "IkeaChargerConnector")
    • station_id string nullable
    • connector_id string nullable
    • standard string nullable
    • power_type string nullable
    • connector_format string nullable
    • voltage integer nullable
    • amperage integer 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 — The entity was not found, or a precondition failed 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.