Shopper documentation
Shopper is an open-source headless e-commerce package for Laravel. Install it, run the store from its admin panel, and build the storefront on its Store API.
Install
composer require shopper/frameworkphp artisan shopper:installPHP 8.3 or higher, Laravel 12 or 13.
Start here
Evaluate
What Shopper covers, and a store running on it.
Install
Add Shopper to a Laravel 12 or 13 application on PHP 8.3 or higher.
Build
Sell from a starter kit, or build your own front end on the Store API.
Browse the documentation
Documentation
Install Shopper, configure it and work with its models, from the catalog to orders.
Storefront
Starter kits, the Store API and the JavaScript SDK for the customer side.
User Guide
Run the store from the admin panel, screen by screen, without writing code.
Extending
Add pages and features to the admin panel and swap the parts Shopper ships.
Add-ons
Build, register and publish add-ons that extend the Shopper admin panel and the Store API.
Reference
Configuration keys, commands, events, permissions and types, one table per kind.
By domain
Each domain in the developer documentation, in the User Guide for the people who run the store, and in the reference tables.
Catalog
Products, variants, attributes, collections, brands and suppliers.
Sales
Customers, carts, orders, payments, refunds and shipments.
Marketing
Campaigns, discounts and abandoned carts.
Store Setup
Store details, zones, locations, currencies, carriers and payment methods.
System
Team and roles, webhooks, notifications, themes, imports and media.
What's new in 3.0
Store API and JavaScript SDK
A JSON:API for the catalog, customer accounts, carts, discount codes, shipping options, checkout, payment and orders, with a typed SDK:
@shopperlabs/shopper-sdk.Promotions
Campaigns with budgets, discounts that apply automatically, and priority and combination rules between discounts.
Carrier tracking
Shipment status follows the carrier through inbound webhooks or scheduled polling, with shipment events. UPS, FedEx and USPS are opt-in packages.
Permissions on every action
Permissions in dot notation, such as
system.settings, checked on every admin action and Livewire update.A new admin shell
Full-width header, breadcrumbs, grouped settings, and an appearance page to theme the admin.
Filament 5 and Laravel 13
Shopper 3 runs on Filament 5, Livewire 4 and Laravel 12 or 13.
php artisan shopper:upgrademoves a 2.x application with Rector rules and a permission migration.
Use with AI
Give an assistant the pages it needs, in Markdown.