Review Payload

How it Works

The ReviewHub Review Ingestion API accepts structured review data from any compliant review collection system. This section outlines the required payload schema, field-level definitions, and the role of each element in the review syndication process.

Purpose

The review payload is the only object your app needs to deliver to ReviewHub. All other metadata—product catalogs, UPCs, customer records, order verification—is transmitted and managed through a clients' Shopify store or our headless technology.

Once a review payload is received, ReviewHub:

Validates purchase order information
Authenticates review metadata
Moderates review content
Synchronizes review formatting
Syndicates review

Request Body Parameters

Parameter	Type	Required	Description
`first_name`	string	Yes	First name of the user
`last_name`	string	Yes	Last name of the user
`email`	string	Yes	Email address of the user
`phone`	string	No	Phone number of the user
`ip_address`	integer	Yes	IP address of the user
`product`	string	Yes	Product ID
`platform`	string	Yes	Partner name
`custom_attributes`	array	No	Additional custom attributes
`review`	object	Yes	Review details for the product

Review Object

Parameter	Type	Required	Description
`star`	integer	Yes	Star rating (1-5)
`title`	string	Yes	Title of the review
`description`	string	Yes	Description of the review

Example Request Body

{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com", "phone": 1234567890,
"ip_address": "192.168.1.1",
"product": "shopify_123456", "platform": "Partner Name", "custom_attributes": [
{
"field_name": "order_number", "field_value": "123456"
}, {
"field_name": "date_of_purchase",
"field_value": "2024-06-04" }
], "review": {
"star": 5,
"title": "Excellent Product!",
"description": "Very satisfied with the quality and performance."
} }