/ifixit/products/reviews

POST /api/ifixit/products/reviews

Price: 5 credits

Get customer reviews for one iFixit store product with its star breakdown

How to use it

What buyers said about a part, with the star histogram beside the individual reviews. iFixit normalises the product you ask for up to its parent product, so a variant-level part number such as IF262-036-1 answers with the reviews of the whole product, not that one option — check the returned reviews' sku before attributing a review to a specific option. The returned id is the parent product's own handle, feedable straight into the products endpoint. rating_count is the product's lifetime total and is normally larger than the number of reviews returned, so do not read the returned rows as the whole population.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Store part number, product code, product handle or product page URL (examples: "IF262-036", "262036", "iphone-13-battery"; minLength: 1)
• store_locale string — Which regional store to read the reviews of. The English stores serve the English-language reviews; the German and French stores serve reviews in every language (default: "en-us"; one of: "en-us", "en-eu", "en-au", "en-ca", "de-de", "fr-fr", "fr-ca")

Response

• @type string (default: "IfixitProductReviews")
• id string required
• average_rating number nullable
• rating_count integer nullable
• store_locale string nullable
• rating_histogram array (default: [])
  • @type string (default: "IfixitRatingBucket")
  • stars integer required
  • review_count integer (default: 0)
• reviews array (default: [])
  • @type string (default: "IfixitProductReview")
  • id string required
  • rating integer nullable
  • headline string nullable
  • text string nullable
  • product_name string nullable
  • variant_name string nullable
  • sku string nullable
  • language string nullable
  • created_at integer nullable
  • modified_at integer nullable
  • author object nullable
    • @type string (default: "IfixitAuthor")
    • id string required
    • name string nullable
    • alias string nullable
    • url string nullable
    • image string nullable
    • reputation integer nullable
    • joined_at integer nullable
    • contribution_percent number nullable
    • team_ids array (default: [])

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 store product matches that part number, product code or handle. 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.