/petco/products/reviews

POST /api/petco/products/reviews

Price: 20 credits

Get customer reviews of a Petco product: rating, title, text, photos, recommendation, verified-purchase and syndication flags, reviewer age and gender, and Petco's replies

How to use it

The review count on a Petco product page covers written reviews only, so set has_text to true to match it; without it star-only ratings are included too. Pass the product id from Petco search results, or a product URL. Reviews cover every size of the product.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Petco product id or product URL (examples: "5030043", "https://www.petco.com/product/taste-of-the-wild-pacific-stream-grain-free-dry-dog-food-with-smoked-salmon-28-lbs-2998871"; 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")
• ratings array nullable — Star ratings to keep (examples: [5], [1,2])
• has_text boolean — Only reviews with written text when true, as counted on the product page (default: false)
• has_photos boolean — Only reviews with customer photos when true (default: false)
• is_recommended boolean nullable — Only reviews that recommend the product when true, only those that do not when false
• is_syndicated boolean nullable — Only reviews collected on the brand's own site when true, only Petco reviews when false

Response

• @type string (default: "PetcoReview")
• id string required
• product_id string nullable
• product_name string nullable
• rating integer nullable
• text string nullable
• author string nullable
• author_id string nullable
• author_location string nullable
• author_age_range string nullable
• author_gender string nullable
• created_at integer nullable
• updated_at integer nullable
• helpful_count integer nullable
• unhelpful_count integer nullable
• is_recommended boolean nullable
• is_verified_purchase boolean nullable
• is_ratings_only boolean nullable
• is_syndicated boolean nullable
• syndication_source string nullable
• syndication_url string nullable
• images array (default: [])
• responses array (default: [])
  • @type string (default: "PetcoReviewResponse")
  • text string required
  • author string nullable
  • department string nullable
  • created_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 Petco product has this id or URL. 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.