Review data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
item_id | string | No | Reference to the product being reviewed (reference to CommerceItem) |
item_variant_id | string | No | Optional reference to specific variant if applicable (reference to CommerceCommerceItemvariant) |
location_id | string | No | (reference to CommerceLocation) |
rating | number | No | 1-5 rating |
title | string | No | |
content | string | No | |
author_name | string | No | |
author_email | string | No | |
author_avatar_url | string | No | |
author_location | string | No | |
verified_purchase | boolean | No | |
helpful_votes | number | No | |
unhelpful_votes | number | No | |
media | CommerceItemMedia[] | No | Photosvideos attached to the review |
media[].id | string | No | |
media[].url | string | Yes | |
media[].alt | string | No | |
media[].type | enum | No | Values: image, video |
media[].height | number | No | |
media[].width | number | No | |
media[].position | number | No | 1 is the first |
media[].metadata | CommerceMetadata[] | No | |
media[].metadata[].id | string | No | |
media[].metadata[].value | object | No | |
media[].metadata[].namespace | string | No | |
media[].metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
media[].metadata[].extra_data | object | No | |
media[].metadata[].slug | string | No | |
media[].metadata[].description | string | No | |
media[].metadata[].is_required | boolean | No | |
status | enum | No | Values: PENDING, APPROVED, REJECTED, SPAM |
is_verified | boolean | No | |
is_featured | boolean | No | |
is_public | boolean | No | |
comments | CommerceReviewComment[] | No | |
comments[].id | string | No | |
comments[].created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
comments[].updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
comments[].content | string | No | |
comments[].author_name | string | No | |
comments[].author_email | string | No | |
comments[].author_avatar_url | string | No | |
comments[].author_location | string | No | |
comments[].helpful_votes | number | No | |
comments[].unhelpful_votes | number | No | |
comments[].status | enum | No | Values: PENDING, APPROVED, REJECTED, SPAM |
comments[].is_verified | boolean | No | |
comments[].is_public | boolean | No | |
comments[].metadata | CommerceMetadata[] | No | |
comments[].metadata[].id | string | No | |
comments[].metadata[].value | object | No | |
comments[].metadata[].namespace | string | No | |
comments[].metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
comments[].metadata[].extra_data | object | No | |
comments[].metadata[].slug | string | No | |
comments[].metadata[].description | string | No | |
comments[].metadata[].is_required | boolean | No | |
metadata | CommerceMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
metadata[].slug | string | No | |
metadata[].description | string | No | |
metadata[].is_required | boolean | No | |
url | string | No |
Are we missing anything? Let us know