ArtisanPack UI Ecommerce Admin (Livewire) Documentation Home

Welcome to the documentation for the ArtisanPack UI Ecommerce Admin. The package is a Livewire admin for the artisanpack-ui/ecommerce engine: orders, products, customers, promotions, shipping, tax, reports, notifications, webhooks, and store settings, built from artisanpack-ui/livewire-ui-components.

It renders inside the cms-framework admin when that package is installed, and as a standalone admin otherwise. It calls the engine's services in-process and owns no tables of its own.

Table of Contents

• Getting Started

  • Quick Start Guide

• Installation

  • Installation Overview
  • Requirements
  • Configuration
  • Front-End Setup
  • Layouts

• Usage

  • Usage Overview
  • Screens
  • Dashboard
  • Command Palette
  • Real-Time Updates
  • Product CSV Import and Export

• Access

  • Authorization

• Extending

  • Extending Overview
  • Navigation
  • Dashboard Widgets
  • Command Palette Providers
  • Order Panels
  • Product Type Panels
  • Customer Tabs
  • Settings Tabs
  • Config Forms
  • Pickers
  • Resource Tables
  • Layout
  • Blade Components
  • Hooks Reference

• Quality

  • Accessibility
  • Localization

• Advanced

  • Advanced Overview
  • Artisan Commands
  • Browser Tests

• Help

  • FAQ
  • Troubleshooting

Features

• Every store screen: Orders, reviews, products, categories, tags, inventory, digital files, license keys, customers, promotions and coupons, shipping, tax, notification templates, webhooks, order statuses, kanban boards, reports, and settings.
• Order work in one place: Status and sub-status changes, shipments, refunds, order edits with a totals diff, cancellation, notes, and an activity timeline.
• Product form for every type: Simple, variable, digital, grouped, and bundled products, with linked products (upsells, cross-sells, related), featured and catalog position, and a panel registry for satellite types.
• Dashboard: Sales, orders to ship, low stock, and reviews to moderate, each linking to the filtered screen.
• Command palette: Cmd+K search across orders, products, customers, promotions, and coupons, with contextual order actions.
• Real-time updates: Optional live order and stock updates over Laravel Echo (needs rebing/graphql-laravel).
• CSV import and export: Catalog import with column mapping, a dry run, and a queued, resumable apply.
• Authorization on every action: Each screen and each Livewire action checks its engine ability. Default is deny.
• cms-framework integration: The CMS layout, the CMS menu, and RBAC permissions with a shop-manager role.
• Extension points: Registries and filters for navigation, dashboard widgets, palette providers, order panels, product type panels, customer tabs, settings tabs, config forms, pickers, and table columns, filters, and bulk actions.
• Accessible and translated: Targets WCAG 2.2 AA. Ships English, Spanish, French, and German.

Quick Example

// app/Providers/AppServiceProvider.php
use Illuminate\Support\Facades\Gate;

public function boot(): void
{
    Gate::define( 'ecommerce.admin', fn ( $user ) => $user->is_admin );
}

composer require artisanpack-ui/ecommerce-admin-livewire
php artisan ecommerce-admin:install
php artisan ecommerce:seed-demo   # optional demo store

Then open /ecommerce-admin.

Support

For support, please open an issue on the GitHub repository.

License

This package is open-source software licensed under the MIT license.