Documentation

Requirements

• PHP 8.4+ with common extensions (mbstring, xml, curl, sqlite3/mysql)
• Composer 2.x
• Node.js 20+ & npm
• SQLite (development) or MySQL 8+ (production)
• Flux UI Pro v2 license — purchase at fluxui.dev

Quick Start

Automatic Processing

When you upload product images, WirePulse automatically:

• Resizes to max 1200×1500px (maintaining aspect ratio)
• Converts to WebP format (25-35% smaller than JPEG)
• Compresses at 85% quality (virtually invisible loss)

Upload JPEG, PNG, GIF, or WebP — the system converts everything to WebP automatically.

Creating a Product

Product Editor Tabs

Data Quality Score

The header badge shows how complete your product data is across 12 data points. Click to see missing fields.

Pricing

Each variant has three price fields:

Collections appear in storefront navigation and can be nested — e.g., "Electronics > Laptops > Gaming Laptops". Products can belong to multiple collections. Create them at Collections → Create Collection.

Stock is deducted when payment is confirmed, not when the order is created — abandoned checkouts don't lock inventory. Each order has a unique reference code (e.g., WP-A3K9M2X1). Click any order to see line items, addresses, payment info, and tax breakdown.

Creating a Draft Order

Multiple rules can stack — e.g., "10% off over 500 kr" and "Free shipping over 499 kr" both trigger on the same order. Configure at Settings → Discount Rules with optional date ranges and priority ordering.

How It Works

Stock is tracked per variant per location. The storefront shows the aggregate total. Configure at Settings → Locations. When an order is paid, stock is allocated from available locations — split across multiple fulfillments if needed.

On Order Details, create fulfillments manually or let the system auto-allocate. Ship with optional tracking number/URL. Mark as delivered when the customer receives the package. Uses fulfillment.created and fulfillment.shipped webhook events.

Customer Flow

Customer opens a completed order in their portal → clicks "Request Return" → selects items, quantities, and reason → submits. Tracks status at /app/returns.

Admin Flow

Review at Sales → Returns → Approve/Reject → Mark as Received → Process Refund (gift card automatic or original method manual). Inventory is restocked on refund.

Webhook Events

The dashboard analyzes sales over the past 30 days and predicts when each variant will run out. Alerts appear in the amber panel if less than 30 days of stock remain.

Custom Segments

Build conditions with: Total Spent, Order Count, Last Order Days Ago, Avg Order Total, Registered Days Ago, Customer Group. Use Match ALL or Match ANY logic. Preview matches before saving.

How It Works

Create at Marketing → Product Feeds. Each feed gets a public URL at /feeds/{slug}.xml or .json. Submit the URL to the ad platform. Feeds regenerate automatically every 4 hours.

A nightly command (recommendations:generate) analyzes 90 days of orders. Products frequently bought together get a co-purchase score. On product pages, recommendations are shown in priority order:

Customers subscribe from a completed order → choose frequency → system auto-generates orders on schedule. B2B customers get instant processing with invoices. B2C customers receive a Stripe payment link.

Customer Self-Service

At /app/subscriptions: change frequency, update quantities, pause, resume, or cancel. Admins manage all subscriptions at Sales → Subscriptions.

Webhook Events

Approved companies with payment terms and sufficient credit see "Pay on Account" at checkout. Order is placed immediately, invoice generated with due date. Stock decremented and fulfillments created. Overdue invoices flagged daily.

Enable in 4 Steps

Architecture

Powered by Laravel AI SDK with tool-calling. Three tools: SearchProducts, GetProductDetails, TrackOrder. Uses the cheapest model for cost efficiency. Conversation stored in session (up to 20 messages).

Editor Layout

E-Commerce Modules

E-commerce modules pull live data from your catalog. Data is cached for 5 minutes.

Charts

Revenue Over Time (line), Orders Over Time (bar), AOV (line), Customer Acquisition (dual-line with B2B highlight), Cart Recovery (stacked bar). All interactive with hover tooltips.

Authentication

Create tokens at Settings → API Tokens. Include header: Authorization: Bearer YOUR_TOKEN. Rate limit: 60 req/min.

Endpoints

GET/POST   /api/v1/products       GET/POST  /api/v1/orders
GET/POST   /api/v1/customers      GET/POST  /api/v1/collections
GET/POST   /api/v1/brands         GET/POST  /api/v1/tags
GET/POST   /api/v1/discounts      GET       /api/v1/currencies
GET        /api/v1/channels       GET       /api/v1/dashboard/stats
GET        /api/v1/inventory

Filtering & Includes

GET /api/v1/products?filter[status]=published
GET /api/v1/products?include=variants,brand,media
GET /api/v1/orders?filter[status]=processing

Token Abilities (Scopes)

Setup

Settings → Webhooks → "Add Webhook" → enter endpoint URL → select events → Test → Save. Retries: 3 attempts with backoff (10s, 1m, 5m).

Available Events (21)

Signature Verification

Each payload is signed with HMAC-SHA256. Verify the X-WirePulse-Signature header against your webhook secret.

$payload = file_get_contents('php://input');
$expected = hash_hmac('sha256', $payload, $secret);
if (hash_equals($expected, $signature)) {
    // Webhook is authentic
}

Plugin Structure

plugins/my-plugin/
├── manifest.json                    # Plugin metadata
└── src/
    └── MyPluginServiceProvider.php  # Registration logic

Extension Points (Hooks)

Example Registration

$manager = app(PluginManager::class);
$manager->registerHook('admin.sidebar.items', fn () => [
    'label' => 'My Feature',
    'icon'  => 'star',
    'route' => '/wirepulse/my-feature',
]);

Environment Variables

# Your license key from wirepulse.org
WIREPULSE_LICENSE_KEY=

# License server URL (default: https://wirepulse.org)
WIREPULSE_LICENSE_SERVER=https://wirepulse.org

# Cache TTL in hours (default: 24)
WIREPULSE_LICENSE_CACHE_TTL=24

Daily Verification

A scheduled command (license:verify) runs daily and contacts the license server at POST /api/v1/verify. The server validates the key and returns the tier (free/pro/enterprise) and expiry date. Results are cached locally.

Manual Verification

php artisan license:verify

# Output (valid):
# License valid — Tier: pro, Expires: 2027-03-30

# Output (no key):
# License invalid or not configured — running in free/community mode.

Graceful Degradation

Admin Banner

A small banner at the top of the admin panel indicates your license status:

Managing Your Subscription

Log in at wirepulse.org/app to view your license key, manage your subscription via Stripe (upgrade, downgrade, cancel), and download invoices. Tier changes take effect on the next license verification.