Topsort's Catalog Integration by topsortpartnercl

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

Catalog integration

App in VTEX IO designed to listen to broadcaster catalog changes and to notify other apps that want to know the changes.

How it works?

The broadcaster worker listens to the SKU change event in the events system. It receives the id of the SKU that has been indexed, then gets all SKU data and checks if there was any change in the data, it does that by hashing the catalog response and comparing it to the one saved in the database, if the SKU has changed it pushes a new catalog change to Topsort.

It does the same thing for the SKU's product, brand and categories data.

Configuration

First, make sure you have created a Advanced 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

Access the Apps section in your account's admin page and look for the App Store;
Search for Topsort's Catalog Integration, and open it;
Then, click on the Install button;
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;
Click on Save.

Using VTEX IO Toolbelt

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

{"base64":" ","img":{"width":480,"height":268,"type":"webp","mime":"image/webp","wUnits":"px","hUnits":"px","length":48520,"url":"https://media4.giphy.com/media/v1.Y2lkPTc5MGI3NjExcmZjaG44OXF0MWJqYXN2NzlnMWxwcjlsMG82amlwc2RzNmVmZms2ZyZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/MxkjIXxggt02iQSqK5/giphy.webp"}}

Click on Save.

Now Topsort is listening to your catalog changes on VTEX and integrate it accordingly!

Next Steps

See how to automate the auctions and send your ad events

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!