/ssg/products/reviews

POST /api/ssg/products/reviews

Price: 20 credits

Get customer reviews of an SSG.COM item or deal item: rating, masked author, purchase detail, text, rated attributes, photos, helpful votes and date; a deal item returns the reviews of its component items

How to use it

Take the item id from ssg/products/search. A deal item (a bundle of component items) returns the reviews of its components in page order, each row naming its component in component_item_id. An unknown item id and an item without reviews return an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — SSG item id or item URL (examples: "1000220072503", "https://www.ssg.com/item/itemView.ssg?itemId=1000220072503&siteNo=6001")
• count integer required — Max number of reviews (min: 1; max: 1000)

Response

• @type string (default: "SsgReview")
• id string required
• item_id string required
• item_url string required
• component_item_id string nullable
• rating number nullable
• author string nullable
• purchase_detail string nullable
• text string nullable
• attributes array (default: [])
  • @type string (default: "SsgReviewAttribute")
  • name string nullable
  • value string nullable
• images array (default: [])
• helpful_count integer nullable
• created_date 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 — The entity was not found, or a precondition failed 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.