Skip to main content
If you use VTEX as your e-commerce platform, you can integrate Topsort directly into your VTEX store to offer ad placements to your vendors. This integration is composed by the following apps:
  • Catalog Integration
  • Auctions Integration (Sponsored Listings)
  • Events Integration
These apps work together to synchronize your catalog with Topsort, display sponsored products in search results, and track user interactions for reporting and optimization.

​
Prerequisites

  • A VTEX account with administrative access.
  • The VTEX IO Toolbelt installed and configured.
  • A Topsort account with a Marketplace API Key and an Advanced API Key.
Log in to your VTEX account: 
vtex login {YOUR_ACCOUNT_NAME}

​
Setting up Your API Key

Install the Topsort Services Settings app: 
vtex install topsortpartnercl.services
Then configure the API Key:
  1. Go to the admin of your VTEX Workspace.
  2. Go to App > App Management and find the services app.
  3. Click on settings and add the API Key, then click on Save.
Verify the installation by going to {{workspace__url}}/_v/ts/settings.

​
Importing Catalog into Topsort

You can integrate your VTEX catalog with Topsort using XML feed templates. Setup Steps:
  1. Navigate to Store Settings > Channels > XML Integration in your VTEX Admin
  2. Create a new XML template with required product fields:
    • Product ID, title/name, Brand, Image URL, Price (all required)
    • Description, Category path, SKU reference code, EAN/barcode (optional)
  3. Configure XML Structure: 
<?xml version="1.0" encoding="UTF-8"?>
<feed>
  <entry>
    <id>product-id</id>
    <title>Product Name</title>
    <description>Product description</description>
    <productType>Category &gt; Subcategory</productType>
    <brand>Brand Name</brand>
    <link>https://store.com/product-url</link>
    <imageLink>https://store.com/image.jpg</imageLink>
    <price>99.99</price>
  </entry>
</feed>
  1. Generate and test the feed URL: https://{your-workspace-name}.vtexcommercestable.com.br/XMLData/{name-of-the-xml}.xml
  2. Contact your Topsort representative to set up the XML feed integration.
  1. Remove the native vtex search resolver app:
vtex uninstall vtex.search-resolver
  1. Install the Auction Integration app:
vtex install topsortpartnercl.auctions@3.x
  1. Access the VTEX Admin portal, navigate to Apps > My Apps, and find Topsort’s Auctions Integration.
  2. Configure the number of sponsored slots and click Save.

​
Tracking Events

The Events Integration app tracks impressions, clicks, and purchases. 
vtex install topsortpartnercl.events@1.1.2
Access the VTEX Admin portal, navigate to Apps > My Apps, and find Topsort’s Events Integration.