PHPackages topsort/module-topsort-integration-magento2 - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. topsort/module-topsort-integration-magento2 ActiveMagento2-module[Utility & Helpers](/categories/utility) topsort/module-topsort-integration-magento2 =========================================== Topsort e-commerce promotions for Magento 2 0.1.6(4y ago)18osl-3.0PHP Since Nov 5Pushed 2y ago13 watchersCompare [ Source](https://github.com/Topsort/magento-topsort)[ Packagist](https://packagist.org/packages/topsort/module-topsort-integration-magento2)[ RSS](/packages/topsort-module-topsort-integration-magento2/feed)WikiDiscussions master Synced today READMEChangelog (3)Dependencies (2)Versions (11)Used By (0) Topsort Magento Extension ========================= [](#topsort-magento-extension) [![Latest Stable Version](https://camo.githubusercontent.com/f03d53e301bd3a3f23d14345a84a807bae78686fc3617214f7c6b4e919a52d60/687474703a2f2f706f7365722e707567782e6f72672f746f70736f72742f6d6f64756c652d746f70736f72742d696e746567726174696f6e2d6d6167656e746f322f76)](https://packagist.org/packages/topsort/module-topsort-integration-magento2) [![License](https://camo.githubusercontent.com/902818a2fcfac0c7cd7b45c2f1cf68d640d46ec7b75aa9945d9e23b757473985/687474703a2f2f706f7365722e707567782e6f72672f746f70736f72742f6d6f64756c652d746f70736f72742d696e746567726174696f6e2d6d6167656e746f322f6c6963656e7365)](https://packagist.org/packages/topsort/module-topsort-integration-magento2) Auction-based advertising *made simple* --------------------------------------- [](#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 ------------------- [](#system-requirements) - Magento >= 2.3.7 <= to 2.4.3. - Composer v2 Installation ------------ [](#installation) ### 1. Install the module with Composer [](#1-install-the-module-with-composer) ``` composer require topsort/module-topsort-integration-magento2 ``` ### 2. Finish the installation by running the required magento commands: [](#2-finish-the-installation-by-running-the-required-magento-commands) ``` bin/magento module:enable Topsort_Integration bin/magento setup:upgrade ``` Configuration ------------- [](#configuration) ### Catalog Service API [](#catalog-service-api) The Catalog Service API gives Topsort access to your marketplace product catalog for the creation of advertising campaigns.. #### Setting up vendors [](#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 [](#setting-up-brands) Topsort Brands are configured in a very similar way to Topsort Vendors. Please, see the [previous section](#setting-up-vendors) on how to configure them. In the simplest setup the same attribute might be representing both: vendors and brands. #### Activating the Catalog Service API [](#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 [](#configuration-for-sponsored-products) The behavior of sponsored products can be configured in Magento configuration under Store → Configuration → Topsort → Sponsored Products. You'll need: - **Topsort API Key**: API key required to authenticate with Topsort. - **Topsort API URL**: The base URL for the Topsort API endpoints. - **Currency sub-unit multiplier**: The multiplier used to convert the amount expressed in currency sub-units into its main unit (e.g. is 100 for US Dollar since 1 Dollar has 100 Cents). - **Enabled sponsored products in catalog/search**: Set to *Yes* in order to start running auction with sponsored products in catalog and search views of the site. - **Amount of sponsored products to render**: Specifies the maximum amount of sponsored products that might be displayed on the page. - **Add sponsored products if amount of products greater than**: You may avoid displaying sponsored products if the catalog or search result pages have too few items on it. - **Sponsored product label text**: The text for the label that will be displayed on top of sponsored products in the list of products. Limitations ----------- [](#limitations) The full-page cache on category pages needs to be disabled for sponsored products to render. Promoted products will increase the number of products displayed on the first page in the product lists: in search results and on the catalog pages. ### Health Score 22 — LowBetter than 21% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community12 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 82.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~38 days Recently: every ~53 days Total 7 Last Release 1469d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/7608cff4b78e815e135a3c6a08d7f3215c85dd8d12d40d053a23033d16e72137?d=identicon)[PabloReszczynski](/maintainers/PabloReszczynski) --- Top Contributors [![kirill533](https://avatars.githubusercontent.com/u/6292292?v=4)](https://github.com/kirill533 "kirill533 (70 commits)")[![PabloReszczynski](https://avatars.githubusercontent.com/u/7925564?v=4)](https://github.com/PabloReszczynski "PabloReszczynski (15 commits)") --- Tags advertisingmagento2 ### Embed Badge ![Health badge](/badges/topsort-module-topsort-integration-magento2/health.svg) ``` [![Health](https://phpackages.com/badges/topsort-module-topsort-integration-magento2/health.svg)](https://phpackages.com/packages/topsort-module-topsort-integration-magento2) ``` ### Alternatives [elgentos/regenerate-catalog-urls Regenerate Catalog URL Rewrites (products, categories, cms pages) 2842.6M](/packages/elgentos-regenerate-catalog-urls)[nosto/module-nostotagging Increase your conversion rate and average order value by delivering your customers personalized product recommendations throughout their shopping journey. 27703.7k4](/packages/nosto-module-nostotagging)[tig/postnl-magento2 TIG Magento 2 PostNL extension 59570.5k5](/packages/tig-postnl-magento2)[myparcelnl/magento A Magento 2 module that creates MyParcel labels 1860.2k](/packages/myparcelnl-magento)[loki/magento2-components Core module for defining Alpine.js components with advanced AJAX features 1011.8k24](/packages/loki-magento2-components)[angeo/module-llms-txt Magento 2 module for AI Engine Optimization (AEO). Generates spec-compliant llms.txt and llms-full.txt per llmstxt.org standard, plus streaming JSONL for vector indexing. Multi-store, multi-website, CLI, cron, async admin UI, Page Builder-aware sanitization, customer-group pricing, atomic writes, ETag/Cache-Control, .md mirrors. 111.1k](/packages/angeo-module-llms-txt) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)