Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Topsort's Events Integration
Community extension
Version: 1.1.2
Latest version: 1.1.2

What is Topsort?

Topsort is a retail media platform that enables marketplaces and retailers to offer ad placements to their vendors or sellers. It allows vendors to bid for prime advertising spots on the marketplace, boosting their product visibility and driving sales. Topsort simplifies ad management and optimizes ad performance with a self-serve, auction-based system tailored to eCommerce platforms. Check it out here

Events Integration

This app integrates VTEX's Store with Topsort, to track impressions, clicks and purchases

How it works?

The Pixel app seamlessly tracks user actions within your store, integrating with Topsort’s automated auction tool. It efficiently captures and sends key behavioral data, empowering you to optimize ad performance and drive more effective retail media campaigns.

Configuration

First, make sure you have created a Marketplace API Key in your Topsort's dashboard. Check out how to do it here.

It is possible to install in your store either by using App Store or the VTEX IO Toolbelt.

Using VTEX App Store

  1. Access the Apps section in your account's admin page and look for the App Store.
  2. Search for Topsort's Events Integration, and open it.
  3. Then, click on the Install button.
  4. You'll see a warning message about needing to enter the necessary configurations. Scroll down and type in your Topsort API Key in the topsortAPIKey field.
  5. Configure the Product Mapping settings if needed.
  6. Click on Save.

Using VTEX IO Toolbelt

  1. Install VTEX's CLI. You can confirm that the app has now been installed by running vtex ls again.
  2. Run the command vtex install topsortpartnercl.events@1.x
  3. Go to the App Settings on VTEX's App Management, add your Topsort API Key;
  4. Click on Save.

Product Mapping Configuration

The Product Mapping settings allow you to define how the fields from VTEX's ProductOrder map to Topsort's purchase fields. This mapping is essential for accurate data tracking and ensuring that the Topsort platform correctly interprets the events from your store.

Fields

  • Product ID Field (productIdField):

    • Maps to Topsort's productId.
    • Options:
      • id
      • productRefId
      • sku
      • skuRefId
      • ean
    • Default: id
  • Quantity Field (quantityField):

    • Maps to Topsort's quantity.
    • Options:
      • quantity
    • Default: quantity
  • Unit Price Field (unitPriceField):

    • Maps to Topsort's unitPrice.
    • Options:
      • price
      • sellingPrice
      • originalPrice
    • Default: price

Next Steps

We’re constantly improving and adding new features to help you get the most out of your retail media efforts. Stay tuned for upcoming updates and enhancements!

Follow us on social media to stay updated:

See also
VTEX App Store
VTEX IO Apps