Contents x
    Opencart
    • 28 Jan 2025
    • Dark
      Light
    Contents

    Opencart

    • Updated on 28 Jan 2025
    • Dark
      Light
    Article summary

    Compatibility Notice

    The Awin module has only been validated with standard Opencart themes. We provide no guarantee that the module will be compatible with other themes.

    Supported Tracking Types & Features

    Method and feature support notes are based on the latest available module version. If a feature is not present on your shop, please ensure you have updated the Awin module.

    Each of these tracking methods is required for compliance with our Tracking Policy. To review the Awin Tracking Policy, please reach out to your Awin point-of-contact.

    ✅ Mastertag

    ✅ Conversion Tag

    ✅ Fall-back Conversion Pixel

    ✅ Server-to-Server (S2S)

    ✅ Product Level Tracking (PLT)

    ✅ Deduplication

    Installation and Configuration

    Current Module Version: compatible with Opencart 4.x.x.x versions.

    The most efficient way to integrate Awin’s tracking with your site is to use our provided Opencart module, available in the Opencart Marketplace.

    After you’ve installed the module, you’ll need to set your Advertiser ID. If you’re unsure, you should have received this ID from your assigned integrator or you can find it in the Awin UI > Account > Overview.

    The Awin module for Opencart stores includes our Hybrid tracking solution with its benefits. The module will trigger the tracking tags on order confirmation pages and the tracking tags will include all aspects of tracking, including the Awin Mastertag on all pages, client-side conversion tags, fallback image pixel and server-to-server tracking.

    Installation

    Step One: In a new web browser window, log in to your Opencart account, then access the Opencart admin panel.

    Step Two:  Go to the Opencart Marketplace and click Download, then select the download version that corresponds to your shop.

    Step Three: In the Opencart admin panel, click Extensions → Installer, and upload the module.

    Step Four: To install the app, in the admin panel, select Extensions → Extensions, then click the corresponding green plus ( + ) icon.

    Step Five: After you install the app, edit the app and provide your Awin advertiser ID.

    Step Six: Change Status to Enabled.

    Tracking Features

    The module utilizes the source query parameter from the landing page URL and passes this value along to the channel parameter of our tracking request for deduplication purposes.

    It is important to note that only the source query parameter will be used for deduplication, not the more commonly used utm_source parameter. You should ensure that the source parameter is correctly configured for your program. Your Awin point of contact can assist you with changes to this configuration.

    To implement this on Awin’s side, a source=aw query parameter will be appended as standard with Opencart module setups under Default Query String Append in the Tracking Settings.

    Additionally, the module creates a cookie named source to store the value of the source parameter. This value will update accordingly each time the value of this parameter changes in the URL.

    If you are configuring other channels, please ensure that they’re reporting to the source parameter with the proper value. (e.g. source=email, source=fb, source=na, etc.)

    Product Level Tracking (PLT) information is sent via the module’s tracking tags and follows the default format of an Awin PLT dataset:

    AW:P|{{advertiserId}}|{{orderReference}}|{{productId}}|{{productName}}|{{productItemPrice}}|{{productQuantity}}|{{productSku}}|{{commissionGroupCode}}|{{productCategory}}

    Usage of Awin Consent Signals is one of the six core elements of Awin’s Tracking Policy. The Opencart module does currently not support native consent handling using Awin Consent Signals.

    The preferred method of consent handling is an advertiser led decision, but we strongly recommend using Awin Consent Signals, and please also see more information on Consent Framework.

    Testing your Tracking

    Please see our article on testing your Integration for further instruction.

    FAQ

    I am using a customized success page, will the Opencart module still work?

    When a different success page, rather than the common /success controller is used,  unfortunately the module might not work as expected and the tracking might be affected by this. Please get in touch with your Awin technical point of contact for more information.

    Was this article helpful?
    What's Next

    © 2024, AWIN Ltd. All rights reserved. Awin is part of Axel Springer Group. No part of this publication may be reproduced, translated, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior permission of the copyright owner.