TikTok Pixel eCommerce

Before setting up activity tracking on your Odoo website, get a pixel ID by following the steps below.

• 01
  Log in to your TikTok Ads Manager account
• 02
  Go to the Tools — Events Manager — Data Sources menu and click Connect Data Source

• 03
  Select Web as the data source

• 04
  Paste your Odoo website URL into the corresponding field or skip this step

• 05
  Select Manual Setup as the connection method

• 06
  Select TikTok Pixel as the manual connection method


For full server-side integration and tracking visitor activity via API in addition to browser tracking, use the Odoo TikTok Events API module.
• 07
  Name your pixel and skip the remaining setup steps by clicking Next

• 08
  Open the created data source and copy the Pixel ID

After installing the module, go to the website settings and, in the Enhanced Website Tracking section, enable the Activate Tracking option. To test your website tracking and view tracked events in the browser console, also temporarily activate the Debug Logging feature.

The module tracks e-commerce events on an Odoo website using a tracking service. It sends tracking events to TikTok Events Manager and allows you to log them internally in Odoo for website analysis and monitoring. Add and configure the tracking service for your Odoo website.

Adding a Tracking Service

Go to the Website — Configuration — Tracking — Services menu and click New to add a new tracking service for your Odoo website.

Firstly, fill in the following fields:

• Specify a Website (if multiple websites are used)
• Select TikTok Pixel as the service Type
• Paste your Pixel ID into the Key field

Then select the product identifier type and the product category to send to TikTok Ads Manager.

If products have attributes and variants, choose Product Variant ID in the Item Type field; if not, select Product Template ID.

Select the desired Category Type: an eCommerce Public Category or an internal Product Category.

The next option is the Lead Value on the Options tab. Set the monetary value of lead generation according to your estimates.

Tracking Logs

The solution includes an internal logging feature. To activate it, enable Internal Logs on the Options tab of the tracking service.

To view logs, go to the Website – Configuration – Tracking – Logs menu or click the Logs button at the top of the form.

The list of internal tracking events:

Advanced Matching

Advanced Matching helps optimize your advertisements by providing TikTok Ads Manager with additional user data. Open the Advanced Matching tab and click Enable allowed, which enables all available options for this tracking service.

Checking the Hashed checkbox next to the Email and Phone options indicates that customer information is protected using hashing, complying with TikTok requirements.

Customer data source

Use the Sale Order Partner value for the Customer Data Source, as it provides more user details in case you allow guest checkouts without registration.

The module includes additional settings available in Developer Mode.

Product Identifier

The module uses the Product ID field as a unique product identifier. To use a different value, specify another product field containing the desired identifier on the Technical tab:

The specified product field should provide non-empty values and remain unique for each product. Otherwise, the tracking data for this product becomes unusable.

Purchase on Portal

To track portal purchases, enable the Track Purchase on Portal option:

Exclude Delivery

The next available setting for tracking services is Exclude Delivery. When enabled, the service excludes delivery lines from sales orders in tracking data transmissions:

Exclude Rewards

To exclude reward order lines from tracking data, enable the Exclude Reward option:

Add to Cart

By default, the module tracks the actual addition of a product to the cart. To track the event upon clicking the button without waiting for the actual addition to the cart, perform the following steps:

• Navigate to Website — Configuration — Websites
• Open the website on the Enhanced Tracking tab
• Enable the Add to Cart on Click option

Tracking the actual addition might fail if third-party modules modify the logic. In this case, this option allows for event tracking by binding it to button selectors used in native Odoo website templates.

Purchase

To track purchases only after a successful payment transaction, enable the Track Confirmed Purchases only option:

This option only affects the event transmission through the tracking service; the internal log records the event regardless.

If business logic considers an order with a Pending payment status as a purchase, enable the Track Pending Purchases too option as well.

You can test the TikTok Pixel tracking script integration using test events in TikTok Events Manager or via a browser extension.

For testing, log out of Odoo or use a different browser, as website tracking does not work for internal Odoo users.

Testing via Test Events

To verify pixel operation in TikTok Events Manager:

• 01
  Open your data source on the Test Events tab
• 02
  Paste your Odoo website URL into the field and click Open Website

• 03
  Perform several actions on your website, e.g., open a product list or add an item to the cart
• 04
  Return to TikTok Events Manager and check for the logged test events in the list

Testing via Browser Extension

The TikTok Pixel Helper browser extension allows you to verify that the pixel script is properly installed on your website and transmitting tracking events. You can get the extension via the link: https://chromewebstore.google.com/detail/tiktok-pixel-helper/aelgobmabdmlfmiblddjfnjodalhidnn.