Introduction
This guide will walk you through the process of installing Roster's Referral Tracking Script to accurately track referral link clicks and referred orders on your store or website. Follow these steps to ensure seamless integration and effective attribution for your brand ambassadors.
Section 1: Supported Platforms
Shopify
The Roster link tracking and referral tracking scripts are automatically installed when you connect your store in Roster. You do not need to follow the steps on this page.
WooCommerce / BigCommerce / Wix
Follow the platform-specific guides for WooCommerce, BigCommerce, Wix or Ecwid.
Section 2: Installation Overview
The Referral Tracking Script is the mechanism by which Roster is able to track referral link clicks and referred orders on your store or website. To enable accurate tracking, follow these four steps:
Step 1: Get Your Public Access Token
Navigate to the Integrations settings in the Brand Portal.
In the API Access Tokens section, generate a new Public Access Token.
Keep the newly created Public Access Token handy for Step 2 and Step 3.
NOTE: The tracking scripts will NOT work with a Private Access Token.
Step 2. Add the click-tracking script to your store/site
The click tracking script attributes incoming link clicks to the correct ambassador using a Roster referral link. Follow these steps:
Copy the following JavaScript code to your clipboard:
<!-- Roster -->
<script async type="application/javascript" src="https://sa.getroster.com/sa.js?token=ACCESS_TOKEN"></script>Paste the JavaScript just before the closing
</head>tag in your site or store template. Ensure this script is added to every page of your site.Replace
ACCESS_TOKENwith the Public Access Token from Step 1.
Note: If your store has multiple sub-domains, ensure the tracking script works across all domains. See enable cookie tracking or contact our support team for assistance.
Step 3: Add the Order Tracking Script to Your Store/Site
The order tracking script attributes referred orders (conversions) to the correct ambassador. Follow these steps:
Copy the JavaScript below to your clipboard.
Provide as much order data as possible to ensure accurate sales attribution processing in Roster. Note the required attributes indicated below. If the orderDate isn't provided, the system will auto set it to the current timestamp. It's recommended you set it to the date the order was created.
<!-- START: Roster Order Submission-->
<script type="application/javascript">
function submitOrder() {
if (sAttribution) {
sAttribution.set({
orderId: "123456", // required
orderNumber: "56789ABC", // recommended
orderDate: "2024-01-12", // Format: YYYY-MM-DDT00:00:00
discountCodes: ["sale2020", "janedoe123"], // recommended
currency: "USD", // required
subtotalPrice: 17.00, // recommended
totalPrice: 29.99, // required
customerId: "9876ABC", // recommended
firstName: "John",
lastName: "Doe",
email: "[email protected]", // required
});
sAttribution.emitOrder();
}
}
var saScript = document.createElement("script");
saScript.addEventListener("load", submitOrder);
saScript.src = "https://sa.getroster.com/sa.js?token=ACCESS_TOKEN";
document.body.appendChild(saScript);
</script>
<!-- END: Roster Order Submission -->Paste the JavaScript just before the closing
</body>tag on the order confirmation page or the page that loads upon a successful conversion.Replace
ACCESS_TOKENwith the Public Access Token from Step 1.Replace the mocked parameter values in the JavaScript with actual code that sets these values at runtime. Refer to our API Documentation for more details.
Ensure that one of the conditions for Roster to attribute an order to an ambassador is met, as outlined in the note.
Step 4: Verify the Installation Process
You're almost done with the integration! Now, it's time to test and verify that everything is set up correctly. Refer to our article on how to test your tracking script installation for detailed steps.
If you encounter any issues during the verification process, please see our Troubleshooting Tips for assistance.
Related Articles
Conclusion
By following these steps, you'll ensure that Roster accurately tracks referral link clicks and referred orders, allowing your brand ambassadors to thrive and your referral program to flourish. If you need further assistance, don't hesitate to contact our support team!