Shopify reviews API documentation
We provide a simple to setup REST API that returns reviews in JSON format. Before integrating the API you should be aware of the following:
- The Shopify API returns 10 reviews per request.
- The order in which reviews are returned is by descending date(from newest to oldest).
- You can get all reviews from a single place by using the
offsetparameter.
To get reviews from Wextractor you will need to perform GET requests against
the https://wextractor.com/api/v1/reviews/shopify endpoint.
Reviews endpoint parameters:
| Parameter | Required | Description | Example |
|---|---|---|---|
| auth_token | Required | Your API token for authentication. Once you register to Wextractor you can extract this key from your account's setting page. | - |
| id | Required | A textual identifier that uniquely identifies an app in Shopify. This identifier can be taken from the url of the profile in Shopify. For example, if the url for the app in Shopify is https://apps.shopify.com/loox/ the identifier is loox
|
loox |
| offset | Optional | This parameter defines the result offset. It skips the given number of reviews. It's used for pagination. (e.g., 0 (default) is the first page of results, 10 is the 2nd page of results, 20 is the 3rd page of results, etc.). | 10 |
Example usage:
https://wextractor.com/api/v1/reviews/shopify?id=loox&auth_token=XXXX&offset=0
Example response:
{
"totals": {
"review_count": 15069,
"average_rating": "4.9"
},
"reviews": [
{
"id": "1246975",
"datetime": "2023-12-02T00:00:00",
"text": "bien",
"rating": "5",
"reviewer": "My Store",
"reviewer_country": "France"
},
{
"id": "1246942",
"datetime": "2023-12-02T00:00:00",
"text": "",
"rating": "5",
"reviewer": "Rachael & Justin",
"reviewer_country": "United States"
},
{
"id": "1246927",
"datetime": "2023-12-02T00:00:00",
"text": "",
"rating": "5",
"reviewer": "ImperialChess",
"reviewer_country": "Armenia"
},
{
"id": "1246888",
"datetime": "2023-12-02T00:00:00",
"text": "",
"rating": "5",
"reviewer": "Sporty Sport Plus",
"reviewer_country": "Turkey"
},
{
"id": "1246875",
"datetime": "2023-12-02T00:00:00",
"text": "GOOD",
"rating": "5",
"reviewer": "MOSTELO(New)",
"reviewer_country": "Hong Kong SAR"
},
{
"id": "1246829",
"datetime": "2023-12-02T00:00:00",
"text": "gute app",
"rating": "5",
"reviewer": "MyKuschl",
"reviewer_country": "Germany"
},
{
"id": "1246805",
"datetime": "2023-12-02T00:00:00",
"text": "je conseille cette application",
"rating": "4",
"reviewer": "Fancycats ",
"reviewer_country": "Canada"
},
{
"id": "1246757",
"datetime": "2023-12-02T00:00:00",
"text": "",
"rating": "5",
"reviewer": "Essential Chapters",
"reviewer_country": "India"
},
{
"id": "1246744",
"datetime": "2023-12-01T00:00:00",
"text": "good",
"rating": "5",
"reviewer": "PixelPerfect",
"reviewer_country": "Canada"
},
{
"id": "1246710",
"datetime": "2023-12-01T00:00:00",
"text": "",
"rating": "5",
"reviewer": "UpmeMore Store",
"reviewer_country": "Israel"
}
]
}
Frequently asked questions:
- How do I get all the reviews for a single place?
You need to perform multiple requests incrementing the offset until you get a response without any reviews in it.