Fix transaction events

Fix transaction events

The Transactions monitoring tool reveals errors and warnings about your transaction event implementation.

Learn how to resolve the various transaction event errors.

Issue type: Order discount

Priority: 

Issue Description Impact
Order discount invalid The discount is not in the correct format. Your Conversion Impact report (CIR) will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor.

What to do

Make sure the value for discount is in the English format using two decimal places. Do not include a currency symbol, such as $ for USD.

Examples

"discount" : "5.00" // VALID

"discount" : "5.0" // INVALID

"discount" : "5" // INVALID

"discount" : "5.000" // INVALID

"discount" : "$5.00" // INVALID

"discount" : 5.00 // INVALID

Issue type: Order ID

Priority:

Issue Description Impact
Order ID missing The transaction does not have an order ID. Orders cannot be distinguished from one another in reports or during troubleshooting.

What to do

Provide a unique <orderID> for each order. The ID can contain numbers, letters, and special characters.

Examples

"orderId" : "55555", // VALID

"orderId" : "ABC-555", // VALID

"orderId" : , // INVALID

Issue type: Order total

Priority:  

Issue Description Impact
Order total invalid The order total is not in the correct format. Your Conversion Impact report (CIR) will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor .
Order total missing The order did not have a total. Your Conversion Impact Report (CIR) will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor .
Order total mismatch The captured order total does not match the order total calculated by the Transactions tool. Your Conversion Impact Report (CIR) will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor.

What to do

Make sure the value for total is in English format using two decimal places. Do not include a currency symbol, such as $ for USD. Do not use a comma when the total order value is over 1000.

Examples:

"total" : "168.08" // VALID

"total" : "168.0" // INVALID

"total" : "168" // INVALID

"total" : "168.008" // INVALID

"total" : "$168.08" // INVALID

"total" : 168.08 // INVALID

"total" : "1,168.08" // INVALID

"total" : "1168.08" // VALID

Compare the data BV Pixel captured against your own purchase history. If the captured value for total does not equal the sum of each item's price multiplied by each item's quantity minus any discount values, investigate where the calculation error is happening.

Examples:

If the following products are ordered from the StuffForSale.com website:

Product 1

  • Category: Mens Casual Boots
  • Price: $140
  • Discount: $9.99
  • Quantity: 1
  • Name: Leather Chukka
  • Product ID (external ID): 156278

Product 2

  • Category: Home Decor
  • Price: $12.69
  • Quantity: 3
  • Name: Polar White Candle
  • Product ID (external ID): 908736

The transaction event would look like the following code:

Copy Code
JavaScript
<!-- load bv.js -->
  <script async type="text/javascript" src="https://apps.bazaarvoice.com/deployments/stuffforsale/main_site/staging/en_US/bv.js"></script>
    
    <!--load Transaction event and parameters-->
      <script>
      window.bvCallback = function (BV) {
        BV.pixel.trackTransaction({
          "orderId" : "55552",
          "total" : "168.08",  //(sum of all products' items * price with discounts applied, without the $ sign)
          "currency" : "USD",
          "tax" : "11.44",  //(tax amount without the $ sign)
          "shipping" : "10.00",  //(shipping amount without the $ sign)
          "items" : [
            {
              "name" : "Leather Chukka",
              "price" : "140.00", //(individual price of item, not price X quantity, without the $ sign)
              "quantity" : "1",
              "productId" : "156278", //(ExternalId in product feed)
              "category" : "Mens Casual Boots",
              "discount" : "9.99" //(discount applied to this item, without the $ sign)
            },
            {
              "name" : "Polar White Candle",
              "price" : "12.69", //(individual price of item, not price X quantity, without the $ sign)
              "quantity" : "3",
              "productId" : "908736", //(ExternalId in product feed)
              "category" : "Home Decor"
            }
          ],
          "email" : "drew@example.com", //Optional PII parameters
          "locale" : "en_US",
          "nickname" : "Drew"
        });
      };
</script>

Issue type: Item discount

Priority:  

Issue Description Impact
Item discount invalid The discount is not in the correct format. Your Conversion Impact Report (CIR) will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor.

What to do

Make sure the value for discount is in the English format using two decimal places. Do not include a currency symbol, such as $ for USD.

Examples

"discount" : "5.00" // VALID

"discount" : "5.0" // INVALID

"discount" : "5" // INVALID

"discount" : "5.000" // INVALID

"discount" : "$5.00" // INVALID

"discount" : 5.00 // INVALID

Issue type: Item price

Priority:  

Issue Description Impact
Item price invalid Item prices are not in the correct format. Your Conversion Impact Report (CIR) will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor. Return on Investment (ROI) and Return On Ad Spend (ROAS) calculations will also be incorrect.
Item price missing Items do not have associated prices. Your Conversion Impact Report (CIR) will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor. Return on Investment (ROI) and Return On Ad Spend (ROAS) calculations will also be incorrect.

What to do

Provide the price of an individual item, not price X quantity. Make sure the value for price is in the English format using two decimal places. Do not include a currency symbol, such as $ for USD.

Examples

"price" : "16.00" // VALID

"price" : "16.0" // INVALID

"price" : "16" // INVALID

"price" : "16.000" // INVALID

"price" : "$16.00" // INVALID

"price" : 16.00 // INVALID

Issue type: Item quantity

Priority:  

Issue Description Impact
Item quantity invalid The quantity of items purchased is not in the correct format. The order total will be incorrect, which impacts the accuracy of the Conversion Impact Report.
Item quantity missing Items do not have an associated quantity. The order total will be incorrect, which impacts the accuracy of the Conversion Impact Report.

What to do

Provide the quantity of individual items purchased for each product ID. The value must be a whole number with no decimals or other punctuation marks.

Examples

"quantity" : "2" // VALID

"quantity" : "2.0" // INVALID

"quantity" : "02" // INVALID

"quantity" : "2," // INVALID

Issue type: Items

Priority:  

Issue Description Impact
Items missing The transaction did not contain any items. Your Conversion Impact Report will have incorrect data for Revenue, Average Order Value, and Revenue for each Visitor.

What to do

Make sure your BV Pixel implementation is configured to capture the price, quantity, and productId of each item in a purchase. Optional parameters include name, category, and discount.

Note: If the Order details section indicates a captured product ID is not in your Bazaarvoice catalog, make sure the product ID shown is correct and update your Bazaarvoice catalog with that product ID.

Tip
As a best practice, ensure your Bazaarvoice catalog includes all your active products.

Example

Copy Code
JavaScript
"items" : [
  {
    "name" : "Leather Chukka",
    "price" : "140.00", // (individual price of item, not price X quantity, without the $ sign)
    "quantity" : "1",
    "productId" : "156278", //(ExternalId in product feed)
    "category" : "Men's Casual Boots",
    "discount" : "9.99" //(discount applied to this item, without the $ sign)
  }
],

Issue type: Product ID

Priority:  

Issue Description Impact
Product ID not in catalog The product ID isn't in your Bazaarvoice product catalog.
  • Review request—If using BV Pixel to power review requests, review requests for this product cannot be generated.
  • Dashboards—The product will not appear in reporting dashboards unless a dashboard's Product Status filter is set to include inactive products. Even then, without the product's supporting catalog data, correlating the product to report entries will be difficult.
  • Implementation—The product will not be included in the ratings-only export feed.
  • Content management—Workbench won't have a product name, image, category, or PDP URL to associate with reviews submitted about the product.
Product ID missing The transaction did not include a product ID.
  • Review request—If using BV Pixel to power review requests, review requests for this product cannot be generated.
  • Dashboards—The transaction will be excluded from product reporting dashboards because determining the product will not be possible.

What to do

Specify a valid product ID or add this product to your catalog.

Issue type: Locale

Priority:  

Issue Description Impact
Locale invalid The locale format isn't a valid four-character locale code. We will send review requests in the default locale: en_US. Consumers who cannot read English won't understand the contents of the review requests and therefore won't write a review.
Locale missing The transaction did not specify a locale. When a locale is missing, we send review requests in the default locale: en_US. Consumers who cannot read English won't understand the contents of the review requests and therefore won't write a review.

What to do

Locale determines the language-specific review request template to use when asking consumers for product reviews. The default locale is en_US. If you are sending unique review request templates to other locales, provide a locale using the correct four-character locale code.

Examples

"locale" : "fr_FR" // VALID

"locale" : "French" // INVALID

"locale" : "FR" // INVALID

"locale" : fr_FR // INVALID

Issue type: Currency

Priority:   

Issue Description Impact
Currency invalid The currency isn't in the correct ISO 4217 alphabetic code. The Conversion Impact Report (CIR) and Return On Ad Spend (ROAS) will list prices and totals in USD.
Currency missing The transaction did not have an associated currency. The Conversion Impact Report (CIR) and Return On Ad Spend (ROAS) will list prices and totals in USD.

What to do

Provide a currency using the correct ISO 4217 alphabetic code Opens in new tab.

Examples

"currency" : "USD" // VALID

"currency" : "EUR" // VALID

"currency" : "US" // INVALID

"currency" : "$" // INVALID

"currency" : USD // INVALID

Issue type: Shipping

Priority:  

Issue Description Impact
Shipping invalid The shipping cost is not in the correct format. Order totals in the Conversion Impact Report may be incorrect.
Currency missing The transaction did not have an associated currency. The Conversion Impact Report (CIR) and Return On Ad Spend (ROAS) will list prices and totals in USD.

What to do

Make sure the value for shipping is in the English format using two decimal places. Do not include a currency symbol, such as $ for USD.

Examples

"shipping" : "10.00" // VALID

"shipping" : "10.0" // INVALID

"shipping" : "10" // INVALID

"shipping" : "10.000" // INVALID

"shipping" : "$10.00" // INVALID

"shipping" : 10.00 // INVALID

Issue type: Email

Priority:   

Issue Description Impact
Email missing The transaction did not include a consumer email address.
  • Review request—If using BV Pixel to power review requests, review requests for this product cannot be generated.

What to do

Include a valid consumer email address in the transaction.

Issue type: Tax

Priority:  

Issue Description Impact
Tax invalid The tax is not in the correct format. Order totals in the Conversion Impact Report may be incorrect.

What to do

Provide the tax. Make sure the value for tax is in the English format using two decimal places. Do not include a currency symbol, such as $ for USD.

Examples

"tax" : "10.00" // VALID

"tax" : "10.0" // INVALID

"tax" : "10" // INVALID

"tax" : "10.000" // INVALID

"tax" : "$10.00" // INVALID

"tax" : 10.00 // INVALID

Provide feedback button