Skip to content

Installation

  • CS-Cart or CS-Cart Multi-Vendor 4.17.2 – 4.21.x (tested on CS-Cart Ultimate 4.17.2 with PHP 8.1, Multi-Vendor 4.17.2 with PHP 8.1 and Multi-Vendor 4.21.2 with PHP 8.3).
  • PHP 7.2.5 – 8.3 (as supported by your CS-Cart version).
  • MySQL/MariaDB with InnoDB (the add-on tables use row locks for safe bidding).
  • A cron job is recommended so auctions close exactly at their end time (see below).
  1. Go to Add-ons → Manage add-ons, click the + (upload) button and upload kv_auction_bidding-1.0.0.zip.
  2. Find Auctions & Bidding in the list and click Install. The add-on is active after the installation.
  3. Open Add-ons → Manage add-ons → Auctions & Bidding → Settings and review the settings (see Configuration), especially the Bidder terms.
  4. Enter your license key in Settings → License (or the CS-Cart Marketplace license number in Add-ons > Manage add-ons).
  5. Create your first auction in Products → Auctions → +.

Auctions close at their end time when someone opens the auction page, when an administrator uses the admin panel (at most every 5 minutes) and, recommended, by cron. Add this line (every 5 minutes) to the crontab of the web server user; the exact command for your store is shown in the settings (Closing auctions):

*/5 * * * * php /home/yourstore/public_html/admin.php --dispatch=kv_auction_bidding.cron

If you cannot run console commands, call the cron URL shown in the settings (it contains the access key from Settings → Security settings) with any cron service.

Closing is idempotent: running cron more often, or at the same time as a page view, never closes an auction twice or creates two winners.

The add-on adds the privileges View auctions and Manage auctions (group Auctions) for administrators with restricted access. On Multi-Vendor, vendors get access to their own auctions when Vendors manage auctions is on.

Upload the new package over the installed add-on (or use the Upgrade Center). Settings, auctions, bids and winners are kept; missing tables, settings and texts are added automatically on the next admin page view.

Uninstall removes the add-on tables (auctions, bids, bidders, winners), its settings, texts and e-mail templates. Export what you need (CSV) first. Orders placed for won auctions stay in your store as normal orders.