This article discusses how to implement the Checkout Beacon, so that we can collect your customer Order Data to power the Follow-Up Email solicitations as well as conversion analytics. To learn more about the Checkout Beacon and its features and considerations, click here. To learn more about troubleshooting your Checkout Beacon implementation, click here.
Installation Steps
1. Ensure you have your Account Credentials, which can be found in your Implementation Project Workbook. If you do not have these in hand, please reach out to your Implementation Team.
2. Install the Checkout Beacon code on your order confirmation page:
<script type="text/javascript" src="//static.powerreviews.com/t/v1/tracker.js">
</script>
<script type="text/javascript">
(function(){try{
var tracker = POWERREVIEWS.tracker.createTracker({
merchantGroupId: 'MERCHANT_GROUP_ID'});
var orderFeed = {
merchantGroupId: 'MERCHANT_GROUP_ID',
merchantId: 'MERCHANT_ID',
locale: 'LOCALE',
merchantUserId: 'INTERNAL_CUSTOMER_ID',
marketingOptIn: true,
userEmail: 'CUSTOMER_EMAIL ADDRESS',
userFirstName: 'CUSTOMER FIRST_NAME',
userLastName: 'CUSTOMER LAST_NAME',
orderId: 'ORDER_ID',
orderItems: [{
page_id: 'PAGE_ID_1',
product_name: 'PRODUCT_NAME_1',
quantity: QUANTITY,
unit_price: PRICE
}, {
page_id: 'PAGE_ID_2',
page_id_variant: 'VARIANT_ID_2',
product_name: 'PRODUCT NAME 2',
quantity: QUANTITY,
unit_price: PRICE
}]
}
tracker.trackCheckout(orderFeed);
}catch(e){window.console && window.console.log(e)}}());
</script>
3. Update all of the fields with the appropriate data below.
Required Fields
Match the exact spelling and formatting to ensure your code is accurate.
Field | Description | Requirements | Example | Additional Notes |
merchantGroupId | Your Merchant Group ID | This value is provided by PowerReviews | 49047 | |
merchantId | Your Merchant ID | This value is provided by PowerReviews | 512774 | |
locale | Your Locale | This value is provided by PowerReviews | en_US | |
marketingOptIn | A flag that allows PowerReviews to send a Follow-Up Email to the customer on your behalf | This value must be set to 'true' in order for PowerReviews to be able to send emails | true | |
userEmail | The email address of the customer | This value must be a valid email address | john.smith@hotmail.com | |
userFirstName | The customer's first name | John | The first name value will be available when using the PowerReviews Follow-Up email | |
userLastName | The customer's last name | Smith | The last name value will be available when using the PowerReviews Follow-Up email | |
orderId | The ID of the order being placed | 768889456 | ||
orderItems | An array of objects, where each object represents a product in the order | n/a | ||
page_id |
The unique product identifier at the parent level |
This must match exactly the value being passed within the Product Feed or Feedless code
|
7751057291 | |
quantity | The quantity of the product in the order | This value must be an integer greater than 0 | 2 | |
unit_price | The unit price of the product in the order | This value must be a floating point number with two decimal places and greater than 0 | 230.00 | A unit_price of 0 or 0.00 will cause an error that prevents the beacon from firing. Do not include items such as free gifts as part of the order_items array. |
Optional Fields
If you elect to use any of these fields, match the exact spelling and formatting to ensure your code is accurate.
Field | Description | Requirements | Example | Additional Notes |
merchantUserId | Your internal customer ID. The merchantUserId is determined by you. | The merchantUserId must be unique to the customer. In cases where you may not have a unique ID for the customer, please pass an empty string. | 4589550123654 | This value will be available to you in moderation and reporting |
page_id_variant | The unique product identifier at the child level. | This must match exactly the value being passed within the Product Feed or Feedless code | 872760558488 | If you are interested in understanding the specific variation of the product that is being reviewed (e.g. the size, color, etc.), the page_id_variant should be included |
product_name | The name of the product | This must match exactly the value being passed within the Product Feed or Feedless code | Rivno® Jacket |