Orders
Pre-populate surveys with verified customer details.
About Orders
Sharing your customer's order details with GetReviews is optional, but does have a few benefits.
If your survey offers respondents a giveaway for their feedback, providing Order IDs allows us to validate the review before triggering integrations with 3PL, etc.
If you want to enforce customers to wait
X
days before writing reviews, providing Order IDs allows us to enforce this delay.You may auto-identify customers during survey initialization, skipping the data-gathering steps (product purchased, customer name / email, etc) as well as validating reviewer authenticity (benefits 1-2 above)
To provide order data itself you may upload CSVs inside our Upload Center or send data programmatically via our API.
Create an Order
Endpoint: /orders
Method: POST
Sample Body:
Sample Response:
Parameter | Status | Description |
---|---|---|
order_id | required | your platform's unique ID for this order |
order_date | optional | date in YYYY-MM-DD format on which order was placed |
name | optional | customer name |
optional | customer email; will be used to request review from customer if attached to Campaign. | |
phone | optional | customer phone; will be used to request review from customer if attached to Campaign |
marketplace_id | required | GetReviews Marketplace primary key ID; used to pre-populate survey details |
survey_code | required | GetReviews survey hash that this user should be redirected to complete |
product_id | optional | used to pre-populate the product a customer purchased, if survey has multiple products |
campaign_id | optional | if you create an Outbound campaign (email, sms), this will associate the order with that campaign automation |
Notes
Order records will be de-duplicated based on the order_id
attribute. If 2+ payloads are received with the same order_id value, only the first will be used to create an Order.
Error Messages
Last updated