Move 39 documentation files from top-level docs/ into each module's docs/ folder, accessible via symlinks from docs/modules/. Create data-model.md files for 10 modules with full schema documentation. Replace originals with redirect stubs. Remove empty guide stubs. Modules migrated: tenancy, billing, loyalty, marketplace, orders, messaging, cms, catalog, inventory, hosting, prospecting. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
# Order Management
|
|
|
|
Order processing, fulfillment tracking, customer checkout, invoicing, and bulk order operations. Uses the payments module for checkout.
|
|
|
|
## Overview
|
|
|
|
| Aspect | Detail |
|
|
|--------|--------|
|
|
| Code | `orders` |
|
|
| Classification | Optional |
|
|
| Dependencies | `payments`, `catalog`, `inventory`, `marketplace` |
|
|
| Status | Active |
|
|
|
|
## Features
|
|
|
|
- `order_management` — Order CRUD and status management
|
|
- `order_bulk_actions` — Bulk order operations
|
|
- `order_export` — Order data export
|
|
- `automation_rules` — Order processing automation
|
|
- `fulfillment_tracking` — Shipment and fulfillment tracking
|
|
- `shipping_management` — Shipping method configuration
|
|
- `order_exceptions` — Order item exception handling
|
|
- `customer_checkout` — Customer-facing checkout
|
|
- `invoice_generation` — Automatic invoice creation
|
|
- `invoice_pdf` — PDF invoice generation
|
|
|
|
## Permissions
|
|
|
|
| Permission | Description |
|
|
|------------|-------------|
|
|
| `orders.view` | View orders |
|
|
| `orders.edit` | Edit orders |
|
|
| `orders.cancel` | Cancel orders |
|
|
| `orders.refund` | Process refunds |
|
|
|
|
## Data Model
|
|
|
|
See [Data Model](data-model.md) for full entity relationships and schema.
|
|
|
|
- **Order** — Unified order model for direct and marketplace channels
|
|
- **OrderItem** — Line items with product snapshots and shipment tracking
|
|
- **OrderItemException** — Unmatched GTIN resolution for marketplace imports
|
|
- **Invoice** — Invoice records with seller/buyer snapshots
|
|
- **StoreInvoiceSettings** — Per-store invoice configuration and VAT settings
|
|
- **CustomerOrderStats** — Aggregated per-customer order statistics
|
|
|
|
## API Endpoints
|
|
|
|
| Method | Path | Description |
|
|
|--------|------|-------------|
|
|
| `*` | `/api/v1/admin/orders/*` | Admin order management |
|
|
| `*` | `/api/v1/admin/order-exceptions/*` | Exception management |
|
|
| `*` | `/api/v1/store/customer-orders/*` | Store customer order views |
|
|
|
|
## Configuration
|
|
|
|
No module-specific configuration.
|
|
|
|
## Additional Documentation
|
|
|
|
- [Data Model](data-model.md) — Entity relationships and database schema
|
|
- [Architecture](architecture.md) — Consumer-agnostic customer architecture
|
|
- [Unified Order View](unified-order-view.md) — Unified order schema with snapshots
|
|
- [Order Item Exceptions](exceptions.md) — Exception system for unmatched products
|
|
- [OMS Feature Plan](oms-features.md) — Order management system roadmap
|
|
- [VAT Invoicing](vat-invoicing.md) — VAT decision tree and invoice generation
|
|
- [Stock Integration](stock-integration.md) — Order-inventory synchronization
|