Use when building e-commerce features in Stacks — the commerce namespace with 13 sub-modules (products, orders, customers, coupons, payments, shipping, tax, gift cards, waitlists, devices, receipts, restaurant), 20+ commerce models, default commerce functions, or the commerce configuration. Covers @stacksjs/commerce.
Comprehensive e-commerce module with 13 sub-modules and 20+ models.
storage/framework/core/commerce/src/storage/framework/defaults/functions/commerce/storage/framework/defaults/models/commerce/import { commerce } from '@stacksjs/commerce'
// 13 sub-modules
commerce.products // Product CRUD
commerce.coupons // Coupon management
commerce.customers // Customer management
commerce.errors // Error tracking
commerce.giftCards // Gift card management
commerce.orders // Order management
commerce.payments // Payment processing
commerce.restaurant // Restaurant features
commerce.shippings // Shipping management
commerce.tax // Tax rate management
commerce.waitlists // Waitlist management
commerce.devices // Print device management
commerce.receipts // Receipt management
Each sub-module typically provides:
index() — list allfetch(id) — get onestore(data) — createupdate(id, data) — updatedestroy(id) — delete| Model | Key Fields | Relationships |
|---|---|---|
| Product | name, price, inventoryCount, allergens(JSON) | belongsTo: Category, Manufacturer; hasMany: Review, ProductUnit, ProductVariant |
| ProductVariant | SKU, options, pricing | belongsTo: Product |
| ProductUnit | unit pricing | belongsTo: Product |
| Category | name, slug, isActive, displayOrder | hasMany: Product |
| Cart | status, total, currency(USD), expiresAt | hasMany: CartItem; belongsTo: Customer |
| CartItem | quantity, unitPrice, totalPrice | belongsTo: Cart |
| Order | status, totalAmount, orderType, deliveryAddress | hasMany: OrderItem, Payment; belongsTo: Customer |
| OrderItem | quantity, price | belongsTo: Order, Product |
| Coupon | code(unique), discountType, discountValue, usageLimit | hasMany: Order |
| GiftCard | code(unique), initialBalance, currentBalance, isReloadable | belongsTo: Customer |
| Customer | name, email, totalSpent, status | hasMany: Order, GiftCard, Review, Payment |
| Manufacturer | manufacturer info | hasMany: Product |
| Review | rating(1-5), content, isVerifiedPurchase, helpfulVotes | belongsTo: Product, Customer |
| ShippingRate | weightFrom, weightTo, rate | belongsTo: ShippingMethod, ShippingZone |
| DeliveryRoute | stops, totalDistance | belongsTo: Driver |
| TaxRate | name, rate(0-100), type(VAT/GST/Sales Tax) | |
| LicenseKey | key(XXXX-XXXX-XXXX-XXXX-XXXX), template, status | belongsTo: Customer, Product, Order |
| DigitalDelivery | downloadLimit, expiryDays, automaticDelivery | |
| WaitlistProduct | product waitlist tracking | |
| Receipt | receipt records |
Commerce works with @stacksjs/payments for Stripe integration:
import { Payment } from '@stacksjs/payments'
await Payment.charge(customer, order.totalAmount, paymentMethodId)
All commerce models have dashboard views at /dashboard/commerce/*.
buddy make:migration when changing commerce schemasobserve: true emits events on create/update/deleteexpiresAt fieldfixed_amount or percentagedashboard: { highlight: true })