Topics
review.create
{
"resource": {
"subscriberId": "123e4567-e89b-12d3-a456-426614174000",
"reviewId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "shopify-123456789",
"attributesWithRating": [
{
"minLabel": "Too Small",
"midLabel": "Just Right",
"maxLabel": "Too Big",
"title": "Sizing",
"type": "centered-range",
"value": 1
}
],
"body": "Great quality and price! Would buy again!",
"containsProfanity": true,
"dateCreated": "2025-03-24T07:32:17.872Z",
"helpfulCount": 1,
"isRecommended": true,
"media": [
{
"streamId": "123e4567-e89b-12d3-a456-426614174000",
"fullSizeUrl": "https://example.com",
"largeUrl": "https://example.com",
"thumbnailUrl": "https://example.com",
"type": "image",
"isHidden": true
}
],
"productAttributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"productName": "Laptop Pro",
"order": {
"orderId": "123456789",
"orderNumber": "#OKRXXXX"
},
"rating": 5,
"reply": {
"body": "<p><b>Thanks</b> for your review</p>",
"dateCreated": "2025-03-24T07:32:17.872Z",
"rawBody": "*Thanks* for your review",
"isPrivate": true
},
"reviewer": {
"attributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"avatarUrl": "https://example.com",
"displayName": "Alex S.",
"email": "[email protected]",
"isVerified": true,
"location": {
"country": {
"code": "au",
"name": "Australia"
},
"zoneCode": "NSW"
},
"name": "Alex Stevens",
"socialConnection": "facebook",
"verifiedStatus": "Verified Buyer"
},
"reward": {
"description": "$10 off your next order over $40",
"integration": "rewardsPlatform",
"type": "coupon",
"value": "OKRX-XXXXX-XXXX",
"isCouponUpgrade": true
},
"sentiment": "positive",
"status": "approved",
"tags": [
"Support Needed",
"Favourite"
],
"title": "Fantastic product!",
"unhelpfulCount": 1,
"variantId": "1234567890",
"variantName": "Laptop Pro - 15 Inch"
},
"resourceType": "review",
"sequenceNumber": "123123412",
"topic": "create",
"version": "2025-02-01"
}review.update
{
"resource": {
"subscriberId": "123e4567-e89b-12d3-a456-426614174000",
"reviewId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "shopify-123456789",
"attributesWithRating": [
{
"minLabel": "Too Small",
"midLabel": "Just Right",
"maxLabel": "Too Big",
"title": "Sizing",
"type": "centered-range",
"value": 1
}
],
"body": "Great quality and price! Would buy again!",
"containsProfanity": true,
"dateCreated": "2025-03-24T07:32:17.872Z",
"helpfulCount": 1,
"isRecommended": true,
"media": [
{
"streamId": "123e4567-e89b-12d3-a456-426614174000",
"fullSizeUrl": "https://example.com",
"largeUrl": "https://example.com",
"thumbnailUrl": "https://example.com",
"type": "image",
"isHidden": true
}
],
"productAttributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"productName": "Laptop Pro",
"order": {
"orderId": "123456789",
"orderNumber": "#OKRXXXX"
},
"rating": 5,
"reply": {
"body": "<p><b>Thanks</b> for your review</p>",
"dateCreated": "2025-03-24T07:32:17.872Z",
"rawBody": "*Thanks* for your review",
"isPrivate": true
},
"reviewer": {
"attributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"avatarUrl": "https://example.com",
"displayName": "Alex S.",
"email": "[email protected]",
"isVerified": true,
"location": {
"country": {
"code": "au",
"name": "Australia"
},
"zoneCode": "NSW"
},
"name": "Alex Stevens",
"socialConnection": "facebook",
"verifiedStatus": "Verified Buyer"
},
"reward": {
"description": "$10 off your next order over $40",
"integration": "rewardsPlatform",
"type": "coupon",
"value": "OKRX-XXXXX-XXXX",
"isCouponUpgrade": true
},
"sentiment": "positive",
"status": "approved",
"tags": [
"Support Needed",
"Favourite"
],
"title": "Fantastic product!",
"unhelpfulCount": 1,
"variantId": "1234567890",
"variantName": "Laptop Pro - 15 Inch"
},
"resourceType": "review",
"sequenceNumber": "123123412",
"topic": "update",
"version": "2025-02-01"
}review.delete
{
"resource": {
"subscriberId": "123e4567-e89b-12d3-a456-426614174000",
"reviewId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "shopify-123456789",
"attributesWithRating": [
{
"minLabel": "Too Small",
"midLabel": "Just Right",
"maxLabel": "Too Big",
"title": "Sizing",
"type": "centered-range",
"value": 1
}
],
"body": "Great quality and price! Would buy again!",
"containsProfanity": true,
"dateCreated": "2025-03-24T07:32:17.872Z",
"helpfulCount": 1,
"isRecommended": true,
"media": [
{
"streamId": "123e4567-e89b-12d3-a456-426614174000",
"fullSizeUrl": "https://example.com",
"largeUrl": "https://example.com",
"thumbnailUrl": "https://example.com",
"type": "image",
"isHidden": true
}
],
"productAttributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"productName": "Laptop Pro",
"order": {
"orderId": "123456789",
"orderNumber": "#OKRXXXX"
},
"rating": 5,
"reply": {
"body": "<p><b>Thanks</b> for your review</p>",
"dateCreated": "2025-03-24T07:32:17.872Z",
"rawBody": "*Thanks* for your review",
"isPrivate": true
},
"reviewer": {
"attributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"avatarUrl": "https://example.com",
"displayName": "Alex S.",
"email": "[email protected]",
"isVerified": true,
"location": {
"country": {
"code": "au",
"name": "Australia"
},
"zoneCode": "NSW"
},
"name": "Alex Stevens",
"socialConnection": "facebook",
"verifiedStatus": "Verified Buyer"
},
"reward": {
"description": "$10 off your next order over $40",
"integration": "rewardsPlatform",
"type": "coupon",
"value": "OKRX-XXXXX-XXXX",
"isCouponUpgrade": true
},
"sentiment": "positive",
"status": "approved",
"tags": [
"Support Needed",
"Favourite"
],
"title": "Fantastic product!",
"unhelpfulCount": 1,
"variantId": "1234567890",
"variantName": "Laptop Pro - 15 Inch"
},
"resourceType": "review",
"sequenceNumber": "123123412",
"topic": "delete",
"version": "2025-02-01"
}Last updated