/magazineluiza/products/reviews

POST /api/magazineluiza/products/reviews

Price: 1 credit

Get customer reviews for a Magazine Luiza (Magalu) product by SKU/id: review text, title, star rating, author, date and characteristics. Optionally filter by star rating and order by relevance/recency/sentiment.

How to use it

Fetch customer reviews for a Magalu product by SKU/id. Returns a list of reviews with text, review_title, rating (1-5 stars), user_name, created_at, characteristics (per-aspect ratings) and the reviewed product. Order with sort (relevant, recent, positive, negative) and narrow with rating (1-5).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Product SKU/id or a full product URL (examples: "aeaaddfkcb", "ke2kf0a6kg"; minLength: 1)
• count integer required — Max number of reviews (min: 1)
• sort string nullable — Review ordering (one of: "relevant", "recent", "positive", "negative")
• rating integer nullable — Filter reviews by star rating (1-5) (min: 1; max: 5)

Response

• @type string (default: "MagazineluizaReview")
• id string required
• text string nullable
• review_title string nullable
• rating integer nullable
• user_name string nullable
• created_at integer nullable
• partner string nullable
• characteristics array (default: [])
  • @type string (default: "MagazineluizaReviewCharacteristic")
  • label string nullable
  • value string nullable
• product_sku string nullable
• product_name string nullable
• product_url string 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 — Product not found (well-formed but nonexistent SKU/id) 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.