/ikea/products/reviews

POST /api/ikea/products/reviews

Price: 20 credits

Get customer reviews of an IKEA product: rating, aspect ratings, text, photos, reviewer market and language, verified-purchase flag, helpful votes and IKEA's reply

How to use it

Fetch reviews of one IKEA product. By default the list holds reviews from every IKEA market in their own languages, including those left on the same product under its item number in another market, so set origin to this_market or review_language to narrow it. Estonia, Latvia, Lithuania, Israel, China and Ukraine do not serve reviews, so use another country for their products.

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", "https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)
• sort string — Review ordering (default: "newest"; one of: "newest", "oldest", "highest_rating", "lowest_rating", "most_helpful")
• origin string — Which markets the reviews come from (default: "all"; one of: "all", "this_market", "other_markets")
• rating integer nullable — Only reviews with this star rating (min: 1; max: 5)
• review_language string nullable — Only reviews written in this language (examples: "en"; pattern: ^[a-z]{2}$)
• has_media boolean — Only reviews with photos when true (default: false)
• is_verified_purchase boolean — Only reviews from verified purchases when true (default: false)

Response

• @type string (default: "IkeaReview")
• id string required
• product_id string nullable
• source_product_id string nullable
• item_type string nullable
• rating number nullable
• rating_range integer nullable
• text string nullable
• author string nullable
• country string nullable
• language string nullable
• review_type string nullable
• is_recommended boolean nullable
• is_verified_purchase boolean nullable
• is_verified_reviewer boolean nullable
• is_anonymous boolean nullable
• helpful_count integer nullable
• unhelpful_count integer nullable
• has_media boolean nullable
• images array (default: [])
  • @type string (default: "IkeaReviewImage")
  • id string required
  • image string nullable
• rating_aspects array (default: [])
  • @type string (default: "IkeaRatingAspect")
  • id string required
  • label string nullable
  • rating number nullable
• response object nullable
  • @type string (default: "IkeaReviewResponse")
  • text string nullable
  • author string nullable
  • response_type string nullable
  • created_at integer nullable
• created_at integer nullable
• updated_at 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 — 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.