Send transaction ID and incentivized review data

You can send the transaction ID (order ID) and incentivized review data to Bazaarvoice using any of the following methods:

1. BV Pixel
2. XML feed file
3. Transactions API

Note: Sending transaction ID and incentivized review data is not supported through text feeds. 

Method 1: BV Pixel

The BV Pixel automatically captures the transaction ID from the <orderId>parameter and the incentivized review data from the <incentivizedReview> parameter directly from your site and sends it to Bazaarvoice.

To enable this, implement the BV Pixel on all your order confirmation pages.

Implementation steps

1. Add the BV loader to the relevant pages.
2. Add the transaction event code.
   
   

   Note: The BV Pixel conversion event code cannot be used to trigger review requests. 
3. (Optional) Add PII parameters to the transaction event code.

For detailed information, refer to BV Pixel.  To learn about BV Pixel v1, refer to BV Pixel v1. 

Method 2: XML feed file

If you cannot send order data using BV Pixel, you can provide an XML feed file containing the <TransactionId> and <IncentivizedReview> fields.

For detailed information, refer to XML feed.

Example XML feed

<?xml version="1.0" encoding="UTF-8"?>
<Feed xmlns="httP<span class="dxhe-searchHI">P</span>roducts>
  </Interaction>
</Feed>

Method 3: Transactions API

The Transactions API enables you to manually send order data. Use this API to create records for single or bulk transactions. Make sure your request body includes the transactionidand incentivizedReview parameters.

For detailed information, refer to Transactions API.

Sample POST request - Bulk transaction

Configuration in Portal

To show the transaction ID (order ID) and incentivized review badge on your product page, ensure the following questions are present in your review submission form:

1. Order Number (Question ID: OrderNumber)
2. Did you receive an incentive for this review? (Question ID: IncentivizedReview)

Configure Order ID

1. Sign in to the Bazaarvoice Portal.
2. From the upper-right corner, select the settings icon .
3. Select Configuration.
4. Select the Submission Form Editor.
5. Go to the Product section.
6. Select + New Question.
   
   
   
7. Locate the Question ID: OrderNumber and select Add This Question.
   
   
8. To show or hide order IDs on product display pages (PDPs), open Edit Product Question dialog, go to Global Question Settings section, and check or uncheck Hide on display. Checking the box hides the order ID; clearing it displays it on the PDP.
   
   
9. Select Save Changes.
10. Deploy the changes to your implementation.

For API clients: If you need to hide the transaction ID (Order ID) from the product page but still require it in the reviews.json response, follow these steps:

1. Return to Step 8 and select the Hide on display setting.
2. Go to the Bazaarvoice Portal tab.
3. From the upper-right corner, select the settings icon . 
4. Select API.
5. In the API Keys page, click the required project.
6. Set HIDDEN CDVS/ADDITIONAL FIELDS  to Yes.
   

Configure incentivized review

Use the Question ID:IncentivizedReview to determine if a review was incentivized (i.e., did the user receive a Coupon, Cashback, Sweepstake, etc.). 

1.  In the Submission Form Editor, add or locate the Question ID:IncentivizedReview and select to  edit.
2. Select + Add a new value to add an answer option (Display Label) for this question. Each option requires a Display Label and Display ID.
   1. Display Label: Can be customized to suit your brand voice. For example: Yes and No, Yeah and Nah, or Yup and Nope.
   2. Display ID: Must be set to either True or False.
      

Tip: Bazaarvoice recommends to limit this question type to two answer options, mapping True to a “Yes” equivalent and False to a “No” equivalent.  






Note: To display the incentivized review badge, pass the case-sensitive value True in the incentivizedReview parameter. Only reviews with this parameter set to True display the badge and are syndicated as incentivized within the Bazaarvoice network. 
3. Select Save Changes.

4. Deploy the changes to your implementation