Review Ingestion API

API Documentation

Review Ingestion API

Description

This document outlines the requirements for sending a review from an external source (ie. a Review Collector) to ReviewHub via API integration.

Endpoint

Contact Wholescale for specific endpoints and API keys.

Request

Headers

Header	Required	Description
Content-Type	Yes	application/json
API-Key	Yes	Unique to each client

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	Shopify Product ID
`platform`	string	Yes	Partner name
`custom_attributes`	array	Yes	Attributes used to validate reviews according to your parameters, in most cases order number.
`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."
} }