guides

Sponsored listings in Search Results

The Auctions Integration is built on top of VTEX’s search resolver, including sponsored products in the search results. After fetching the organic results, it sends them to Topsort’s Auctions API to determine the auction winners. The winning sponsored products are then placed at the top of the search results, followed by the organic results.

Getting Started

Prerequisites

Before you begin, ensure you have the prerequisites

Integration steps

Install the Auction Integration app:
Terminal window
```
vtex install topsortpartnercl.auctions@1.x
```
Confirm the app installation by running:
Terminal window
```
vtex ls
```
You should see topsortpartnercl.auctions listed among the installed apps.
Access the VTEX Admin portal, navigate to Apps > My Apps, and find Topsort’s Auctions Integration.
Click on the app to open its settings.
Enter your Topsort Marketplace API Key.
Optionally, you can also type the Topsort Number of Sponsored Slots
Click on Save.

What’s next?

The VTEX IO apps don’t support automatic updates, so you will need to update the apps manually whenever a new version is released. See the details on how to update the app.

If you have any questions or need assistance with the integration, feel free to contact us at support@topsort.com.