Review created

Topic: v1/review/created

Payload example:

{
    "timestamp": "2024-05-18T12:01:00Z",
    "id": 1,
    "title": "Great product!",
    "body": "I really enjoyed using this product. It exceeded my expectations.",
    "rate": 5,
    "customer": {
        "email": "customer@gmail.com",
        "phone": null,
        "shopifyCustomerId": 5784483037269
    },
    "product": {
        "id": 1234567891011,
        "handle": "awesome-product"
    },
    "reply": null,
    "images": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
    ],
    "votes": 5,
    "isPublished": true,
    "isVerifiedBuyer": true,
    "isPinned": false,
    "createdAt": "2024-05-18T12:00:00Z"
}

Documentation table

Properties

timestampstring: Timestamp when the review was created, in ISO 8601 format.
idnumber: Unique identifier of the review.
titlestring | null: Review title.
bodystring: Main content of the review.
ratenumber: Enum [1, 2, 3, 4, 5]. Corresponds to a specific level of satisfaction or quality. See review_rates for details.
customerobject | null: Details about the customer who created the review. See customer identifier for structure. Can be null if the customer is deleted.
productobject | null: Details about the product related to the review. See product_identifier for structure. Can be null if it is a shop review.
replystring | null: Reply to the review. Can be null if no reply is provided. See review_reply for structure.
imagesstring[]: An array of comma-separated strings, each containing a URL to an image related to the review.
votesnumber: Number of votes the review received.
isPublishedboolean: Indicates whether the review is published (true) or unpublished (false).
isVerifiedBuyerboolean: Indicates whether the customer is a verified buyer (true) or an unverified buyer (false).
isPinnedboolean: Indicates whether the review is pinned (true) or not (false).
createdAtstring: Date and time when the review was created, in ISO 8601 format.

Documentation table​

Properties

Documentation table