Live Sales Tracking Instructions

This is JavaScript tag which is deployed onto your website to allow Confer With to track a sale related to a Live Video call on the platform and we call this the Sales Tracking Script. This script drives your Conversion Rate, Average Order Value and Sales Attribution in your reporting portal. 

Quick Start

• Identify mechanism for deploying the Tag -  Direct into the page. 
  We only recommend direct deployment as Google Tag Manager is frequently blocked by add blockers. 
• Trigger the Tag on your order confirmation page (the page a customer sees after they make a purchase).
• Ensure it executes after the order confirmation page has loaded.
• Before running the script, please set four variables (InvoiceID, InvoiceDate, InvoiceValue and optionally an array of products). 

Example Config here, including the tag : 

conferwithTrackingInvoiceId = YOURINVOICEID;
invoiceValue = YOURVALUE;
invoiceDate = YOURDATE;
products = YOURARRAY;
<script src="https://live.conferwith.io/cdn/checkout.js"></script>

Note : if you don't use a tag manager you can deploy the scripts directly into your order confirmation page if you prefer - the details below are the same.

The flow of events to manage this script is as follows : 

If a call has happened on Confer With, on the same device, we will then then report back into your reporting dashboard to show your conversion rate. Further details will be available, if passed, to understand more about the same (these are all optional but we would recommend the reference and value as a minimum). 

• Invoice/Order reference
  - Variable Name : "conferwithTrackingInvoiceId"
  - Type : Text
  This is your sale reference and should be something that you can lookup against your ecommerce sale to find the relevant details to cross check your sale e.g. "INV1234"
  
  
• Date
  - Variable Name : "invoiceDate"
  - Type : Text (we will format as date time if possible)
  This is the date of which you wish to pass which is related to the sale e.g. "01/01/2022 12:00"
  
  
• Value
  - Variable Name : "invoiceValue"
  - Type : Text (we will format as value if possible)
  This is the invoice / sale value and will drive your Average Order Value in the platform - this should be the total amount of the sale, including taxes and without the currency. e.g. "100"
  
  
• List of products
  - Variable Name : "products"
  - Type : Array
  This is usually an array of products that have been purchased in the sale and should be passed with one array entry for each sale which can consist of any number of fields however please ensure the four below are set (productId, productName, quantity, unitPrice) - note: pricemust be a number
  e.g.     
  products: [ { id, name , quantity, price }, { id, name , quantity, price } ] 

Step 1 - Ensure the Tag Manager / Script is executed on your Order Confirmation page

It's important to confirm that the tag is executed on the page you display your order confirmation on. This ensures that sales are tracked by your different purchase journeys. Please identify the page which has the order details, post purchase and follow the instructions below on configuring the event trigger to ensure our Sales Tracking script is executed on this page. 

Note : Certain versions of eCommerce platforms don't do this by default (e.g. Shopify is phasing this out and doesn't support with new setups). Please reach out to us for guidance if this is the case and if you're unsure we can confirm if the tag is being executed post configuration of Steps 2 and 3 below. 

Step 2 - Identify the parameters you wish to pass to us for reporting or select our default

Before enabling and configuring the script its important to identify you have the relevant data on the page you wish to trigger the event on. We have used Shopify as an example below to show what data is passed if you choose our default parameters.

Passing data-ecommerce="shopify" before our script e.g. 

<script>var ecommerce = "shopify" </script>
<script src="https://live.conferwith.io/cdn/checkout.js"> </script>

will set the following, automatically:

• conferwithTrackingInvoiceId = Shopify.checkout.order_id
• invoiceValue = Shopify.checkout.total_price
• invoiceDate = Shopify.checkout.created_at
• products = Shopify.checkout.line_items

More Information can be found here : https://shopify.dev/api/liquid/objects/checkout

Alternatively, you can set these variables yourself as along as they are set before our script is executed which is how you would do this if you were using a different ecommerce / custom setup e.g.

conferwithTrackingInvoiceId = YOURINVOICEID;
invoiceValue = YOURVALUE;
invoiceDate = YOURDATE;
products = YOURARRAY;
<script src="https://live.conferwith.io/cdn/checkout.js"></script>

Step 3 - Configure the Script

TEST MODE

If you're using a bespoke endpoint please utilise test mode to ensure that test data does not get added to our core reporting. To do this please ensure you add the following querystring parameter when you call our script : &dryrun=true

<script src="https://live.conferwith.io/cdn/checkout.js?dryrun=true"></script>

Returned Values

200 : Valid Payload
400 : Description of Error e.g. 400 - bad payload arguments 400- missing qty in product structure

V1.3 : 15/07/2024