README

Auction-based advertising made simple

Topsort provides auction-based native ad infrastructure and APIs for the world's top marketplaces and multi-brand retailers to monetize fast and stress-free.

This Magento 2 extension allows a Magento-based marketplace to integrate with Topsort's API hassle free.

System Requirements

Magento >= 2.3.7 <= to 2.4.3.
Composer v2

Installation

1. Install the module with Composer

composer require topsort/module-topsort-integration-magento2

2. Finish the installation by running the required magento commands:

bin/magento module:enable Topsort_Integration
bin/magento setup:upgrade

Configuration

Catalog Service API

The Catalog Service API gives Topsort access to your marketplace product catalog for the creation of advertising campaigns..

Setting up vendors

By default, Magento does not have a notion of vendor or merchant. You may use the default product attribute manufacturer or create your own attribute.

Option 1. Using the existing "manufacturer" attribute

This can be done by navigating to “Product Attributes” page (Menu → Stores → Attributes → Product), then search for the manufacturer attribute code. By filling in the attribute options you can define what vendors products can be assigned to each vendor.

Option 2. Adding a new "Vendor" attribute

By using the standard Magento functionality, we can configure a new vendor product attribute. This can be done by clicking on “Add New Attribute” under the “Product Attributes” page (Menu → Stores → Attributes → Product).

Similar to the configuration or manufacturer attribute, the new attribute should be configured as a “Drop-down” list. By configuring the attribute options you will provide the list of Vendors that will later be shared with the Topsort API.

Please, note that once the list of options is defined and your vendors already got their products and start using the system, you should not remove them from the list of vendors (the option associated with the vendor should not be removed).

Setting up Brands

Topsort Brands are configured in a very similar way to Topsort Vendors. Please, see the previous section on how to configure them. In the simplest setup the same attribute might be representing both: vendors and brands.

Activating the Catalog Service API

The Catalog Service API can be activated and configured in Magento configuration section: (Stores → Configuration → Topsort → Catalog Service APIs)

You'll need:

Access Token: This is a secret key you and Topsort should share to allow the connection.
Topsort Vendor Attribute code: This property is defining the product attribute code used to identify Topsort Vendors
Topsort Brand Attribute code: This property is defining the product attribute code used to identify Topsort Vendors

Configuration for Sponsored Products

The behavior of sponsored products can be configured in Magento configuration under Store → Configuration → Topsort → Sponsored Products.