This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.
�The integration with TikTok is available only for stores in Brazil.
The TikTok for Business app allows merchants to easily connect their stores to TikTok, using it as a channel to drive sales and market products sold in their ecommerce.
The app includes the following features:
- Connecting TikTok For Business and Ads Manager accounts with your VTEX account.
- Syncing products in your catalog with TikTok.
- Inserting the TikTok Pixel in your store.
- Managing TikTok Ads from the VTEX Admin.
Before you start
Before installing the app, make sure you have read about its compatibility and requirements in the following sections.
Compatibility
TikTok for Business is fully compatible with stores using VTEX IO and partially compatible with stores using Legacy CMS or Headless CMS.
In VTEX IO stores, installing and configuring TikTok for Business causes the TikTok Pixel to be inserted automatically. On the other hand, stores using the Legacy CMS or Headless CMS need to configure the TikTok Pixel manually. Refer to the Manual TikTok Pixel configuration section for more information on this.
Requirements
To be able to configure the TikTok for Business app in your VTEX store, you need to meet the following requirements:
- Having a TikTok Business account.
- Having Admin permission in TikTok Business Center.
- Having a TikTok Ads Manager account linked to your business account.
Installation
You can install TikTok for Business on the VTEX App Store.
After installation, the app settings will be available in the VTEX Admin, under Marketplace > TikTok. For some versions of the VTEX Admin, the page can be found at Apps > My Apps > TikTok.
Configuration
You must configure the TikTok for Business app through the VTEX Admin. Please check out the documentation about the Integration with TikTok for instructions on this process.
In case you are using the Legacy CMS or Headless CMS, you need to configure the TikTok Pixel manually as well. Read the following sections for more information on this.
TikTok Pixel
The TikTok Pixel is a JavaScript code snippet that you can include on your store's website, which allows you to track various actions of your websites visitors and share them with TikTok. These actions are called Pixel events see the Supported Pixel events section to learn more.
In VTEX IO stores, the TikTok Pixel is automatically inserted when you install and configure TikTok for Business. In Legacy CMS or Headless CMS stores, you need to configure it manually. Refer to the Manual TikTok Pixel configuration section for more information on this.
Supported Pixel events
TikTok Pixel supports the following events:
| Event | Description |
|---|---|
| 'ViewContent' | When a visitor views any page in your store. |
| 'AddToCart' | When a visitor adds a product to the cart. |
| 'PlaceAnOrder' | When a visitor places an order. |
For more information on TikTok Pixel events, read TikToks documentation on Standard Events and Parameters.
Manual TikTok Pixel configuration
� This configuration applies only to Legacy CMS and Headless CMS stores. If your store is built with VTEX IO, skip this section.
To insert the TikTok Pixel manually, you must follow the instructions in the TikTok documentation, more specifically in Option 2: Install the pixel using Developer Mode of the Get Started with Google Tag Manager guide.
Disconnecting from TikTok
Merchants can disable the integration between their store and TikTok at any time, by following the instructions on Disconnecting TikTok from your store.
In case their TikTok user access token is revoked (deactivated or invalid), the integration will be disconnected automatically. The access_token is the token that bears the authorization of the TikTok user.
Once disconnected, your integration with TikTok stops completely: the TikTok Pixel and the integration with your store's catalog are deactivated. Therefore, you will no longer be able to send new products to TikTok and update products on the TikTok catalog automatically.
On the other hand, existing products are not deleted from the TikTok catalog by VTEX, which means they continue to appear on TikTok. For this to stop, you need to manually delete the products in TikTok Catalog Manager.
After disconnecting, it is possible to reactivate the integration at any time by repeating the steps described in Configuring the integration with TikTok for Business in the VTEX Admin.
Upcoming documentation: