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 the Afiliados endpoint. Please get in touch with your Topsort representative for assistance with the setup.
  1. Remove the native VTEX Search Resolver app. Topsort uses a fork of VTEX’s latest Search Resolver under the hood—same base behavior, but augmented with Topsort’s auction logic. If not uninstalled, the apps will conflict:
vtex uninstall vtex.search-resolver
  1. Install the Auction Integration app:
vtex install topsortpartnercl.auctions
  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
Access the VTEX Admin portal, navigate to Apps > My Apps, and find Topsort’s Events Integration.
Agustin - Integrations Team MemberAmelia - Integrations Team MemberBernardita - Integrations Team MemberBorumy - Integrations Team MemberFelipe - Integrations Team MemberGui - Integrations Team MemberJaviera - Integrations Team MemberLinn - Integrations Team MemberMarcio - Integrations Team MemberMateus - Integrations Team MemberMax - Integrations Team MemberRodrigo - Integrations Team Member

Need help with your Topsort integration?

Talk to us, the integrations engineering team.Reach us via your dedicated messaging channel or at support@topsort.com.If you're not a customer yet, book a demo with our sales team instead.