Generate a rich snippet for a product

Returns schema.org Product structured data (JSON-LD) for a product page, with the product's star rating and review count from Yotpo. Search engines can use it to show star ratings in search results.

Yotpo adds only aggregateRating. The name, image, price and currency you send are returned as they are, so send your real product data. offers is added only when you send both price and currency.

No access token is needed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your Yotpo store ID (app key).

string
required

Your product ID: the same ID your e-commerce platform sends to Yotpo.

Body Params
string
required

The product name. Can't be blank.

string
required

The product image URL. Can't be blank.

number

The product price. Used only together with currency.

string
length ≤ 3

The ISO 4217 currency code, for example USD. Used only together with price.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
text/plain