Direct Integration - Voucher Network & Checkout Benefits
This documentation helps you successfully integrate Sovendus Voucher Network and/or Checkout Benefits into your shop via JavaScript on your order success page.
Overview
What You'll Achieve
💰 Increase Revenue: Offer customers exclusive vouchers and cashback rewards
🔄 Boost Retention: Keep customers engaged with personalized offers
📈 Track Performance: Monitor voucher redemptions and customer engagement
🎁 Enhance Experience: Provide value-added services at checkout
How It Works
The implementation uses JavaScript on your shop's order success page. An iFrame connects to Sovendus servers to:
Retrieve personalized content - Individual reward banners and offers
Embed on your page - Seamlessly integrate with your checkout flow
Your personal banner and/or offer list will be created by Sovendus and made available on our servers.
Need Help?
If you have any questions or encounter issues during the process, please reach out to your Sovendus account manager for assistance.
Implementation Guide
Step 1: Add HTML Container (if required)
Add this HTML markup to your order success/thank you page where you want the Sovendus content to appear:
<!-- Sovendus Container --><divid="sovendus-container-1"><!-- the integration loads the content into this div element --></div>
Container Placement
The position of this container doesn't affect the placement of the Sovendus sticky banner and overlay variants if you're using one.
When is the container required?
The container is only required when one of the following is true for you:
you are using an inline/embedded version of our banner or product list
you are using a SPA (single page app - e.g. react, angular, vue, etc.) as the existence of this container will trigger the sovendus overlay removal process
If you are not using an inline/embedded version and not using a SPA, you can safely ignore this container.
Step 2: Obtain Integration Variables
Before implementing the JavaScript code, obtain these values from your Sovendus Customer Success Manager. These will replace the corresponding placeholders within the script:
Variable
Description
Example
TRAFFIC_SOURCE_NUMBER
Your unique Traffic Source identifier
1234567
TRAFFIC_MEDIUM_NUMBER
Your unique Traffic Medium identifier
123
Step 3: Add JavaScript Integration
Add this script right after the container div above, or if not possible, at the end of the <body> section of your order success/thank you page:
<!--sovendus code begin --><scripttype="text/javascript">window.sovIframes=window.sovIframes||[];
Step 4: Customize Integration Data
Replace the placeholder values (integration data, order data and customer data) in the script with actual data from your order form, database, etc.
Consent Management
In particular, the hasConsent parameter is critical for GDPR and privacy compliance. This parameter allows the user's provided level of consent to easily be transferred to the Sovendus integration. Sovendus will then tailor functionality accordingly, as below
Please Note
This hasConsent parameter is only relevant for partners who have signed a Data Processing Agreement with Sovendus, and who have been enabled for this functionality - if you are unsure, or have any queries, please reach out to your Customer Success Manager
Scenario
Value
Description
✔ Consent has been explicitly provided
hasConsent
=
true
The Sovendus integration loads successfully with full functionality, such as additional analytics, user recognition and personalisation of offers
✘ Consent has not been explicitly provided
hasConsent
=
false
The Sovendus integration loads successfully, but with minimal usage data (anonymised)
The exact method you use to determine/pass this value will depend on your particular Consent Management Platform and processes. In any case, please ensure this is passed as a Boolean (true or false).
Parameter Documentation
For detailed information on all parameters, examples, and requirements, visit: Parameter Documentation
Step 5: Test the Integration
After implementing the code, please follow these comprehensive testing steps.
Testing Requirements
Complete testing is essential to ensure proper data transmission and banner display. Your account manager needs verification screenshots before going live.
Place a Test Order
Complete a real transaction on your website
Use realistic order data (products, quantities, pricing)
Include customer information in the checkout process
Verify Banner Display
Check your order success/thank you page immediately after checkout
Look for the Sovendus banner, overlay, or embedded content
