/ulta/products/reviews

POST /api/ulta/products/reviews

Price: 20 credits

Get customer reviews of an Ulta Beauty product: rating, title, text, photos, verified-buyer flags and helpful votes

How to use it

Fetch reviews of one Ulta Beauty product by its id or URL. Reviews of some older products are not served, among them every product with an xlsImpprod or VP id: the call returns 412 when such a product shows reviews on Ulta, so use the Ulta product endpoint for its rating and review count instead. Up to 10,000 reviews are reachable per filter combination.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Ulta product id or URL (examples: "pimprod2051122", "https://www.ulta.com/p/cheek-thrills-multi-finish-face-trio-pimprod2051122"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1; max: 10000)
• sort string — Review ordering (default: "newest"; one of: "newest", "oldest", "highest_rating", "lowest_rating", "most_helpful", "with_media_first")
• rating integer nullable — Only reviews with this star rating (min: 1; max: 5)
• has_media boolean — Only reviews with photos or videos when true (default: false)
• is_native boolean — Only reviews written on Ulta when true; reviews shared from the brand's site too when false (default: false)
• query string nullable — Keywords the review text must contain (examples: "pink"; minLength: 1)

Response

• @type string (default: "UltaReview")
• id string required
• product_id string nullable
• rating integer nullable
• text string nullable
• author string nullable
• location string nullable
• created_at integer nullable
• updated_at integer nullable
• is_recommended boolean nullable
• is_verified_buyer boolean nullable
• is_verified_reviewer boolean nullable
• is_staff boolean nullable
• is_syndicated boolean nullable
• source_brand string nullable
• product_name string nullable
• variant_id string nullable
• upc string nullable
• gtin string nullable
• helpful_count integer nullable
• unhelpful_count integer nullable
• locale string nullable
• attributes array (default: [])
  • @type string (default: "UltaReviewAttribute")
  • name string required
  • label string nullable
  • values array (default: [])
• media array (default: [])
  • @type string (default: "UltaReviewMedia")
  • id string required
  • media_type string nullable
  • url string nullable
  • caption 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 — No Ulta product has this id, or reviews of this product are not available. 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.