Quick reference

20. Quick Reference

Endpoints Overview

All Endpoints

Authentication:

• POST /auth/register - Register new admin user
• POST /auth/login - Login and create session
• POST /auth/logout - Logout and destroy session
• GET /auth/me - Get current user (requires auth)

Products:

• GET /products - List products (with pagination, search, filters)
• POST /products - Create product
• GET /products/:id - Get product details
• PUT /products/:id - Update product
• DELETE /products/:id - Delete product
• POST /products/import - Import products from CSV
• GET /products/export - Export products to CSV

Categories:

• GET /categories - List all categories
• POST /categories - Create category
• GET /categories/:id - Get category (with children/parent)
• PUT /categories/:id - Update category
• DELETE /categories/:id - Delete category

Brands:

• GET /brands - List all brands
• POST /brands - Create brand
• GET /brands/:id - Get brand
• PUT /brands/:id - Update brand
• DELETE /brands/:id - Delete brand

Orders:

• GET /orders - List orders (with pagination, filters)
• POST /orders - Create order
• POST /orders/batch - Batch create orders (up to 100)
• GET /orders/:id - Get order details
• PUT /orders/:id/status - Update order status
• PATCH /orders/:id/payment-status - Update payment status
• DELETE /orders/:id - Delete order

Customers:

• GET /customers - List customers
• GET /customers/:id - Get customer details
• GET /customers/:id/loyalty - Get loyalty balance & ledger
• POST /customers/:id/notes - Add customer note

Branches:

• GET /branches - List branches
• POST /branches - Create branch
• GET /branches/:id - Get branch
• PUT /branches/:id - Update branch
• DELETE /branches/:id - Delete branch
• GET /branches/:id/integrations - List branch integrations
• PUT /branches/:id/integrations/:key - Update branch integration

Shipping:

• GET /shipping/zones - List shipping zones
• POST /shipping/zones - Create shipping zone
• GET /shipping/shipments - List shipments
• POST /shipping/external/calculate - Calculate shipping rates (API key auth)

Webhooks:

• GET /webhooks - List webhooks
• POST /webhooks - Create webhook
• GET /webhooks/:id - Get webhook
• PUT /webhooks/:id - Update webhook
• DELETE /webhooks/:id - Delete webhook
• GET /webhooks/:id/deliveries - Get webhook delivery logs

Marketing — Overview:

• GET /marketing - Marketing overview (aggregate counts + loyalty stats)
• POST /marketing/subscribe - Newsletter subscription (public, no auth)

Marketing — Contacts:

• GET /marketing/contacts - List contacts (paginated, searchable)
• GET /marketing/contacts/stats - Contact statistics
• POST /marketing/contacts - Create contact
• PUT /marketing/contacts/:id - Update contact
• DELETE /marketing/contacts/:id - Delete contact

Marketing — Coupons:

• GET /marketing/coupons - List coupons (paginated, searchable)
• GET /marketing/coupons/stats - Coupon statistics
• POST /marketing/coupons - Create coupon
• GET /marketing/coupons/:id - Get coupon
• PUT /marketing/coupons/:id - Update coupon
• DELETE /marketing/coupons/:id - Delete coupon
• GET /marketing/coupons/:id/usage - Coupon usage history
• POST /marketing/coupons/:id/validate - Validate coupon (with discount preview)

Marketing — Loyalty:

• GET /marketing/loyalty/config - Loyalty program configuration
• GET /marketing/loyalty/stats - Loyalty statistics
• GET /marketing/loyalty/balances - List customer balances (paginated, searchable)
• GET /marketing/loyalty/balances/:customer_id - Single customer balance
• POST /marketing/loyalty/adjust - Adjust loyalty points
• GET /marketing/loyalty/ledger - Points ledger (filtered, paginated)
• GET /marketing/loyalty/registrations - List registrations
• PUT /marketing/loyalty/registrations/:id - Approve/reject registration

Marketing — Abandoned Carts:

• GET /marketing/abandoned-carts - List abandoned carts
• GET /marketing/abandoned-carts/count/unviewed - Unviewed count
• PATCH /marketing/abandoned-carts/:id/view - Mark as viewed
• DELETE /marketing/abandoned-carts/:id - Delete cart
• POST /marketing/abandoned-carts/:id/trigger-automation - Trigger recovery

Marketing — Automation:

• GET /marketing/automation/status - Addon status
• GET /marketing/automation/campaigns - List campaigns
• GET /marketing/automation/campaigns/:type - Get campaign
• PUT /marketing/automation/campaigns/:type - Update campaign
• GET /marketing/automation/runs - Automation run history
• GET /marketing/automation/template-variables - Template variables
• POST /marketing/automation/templates/enhance - AI-enhance template

Settings:

• GET /settings - Get all settings
• PUT /settings/:key - Update setting
• GET /settings/emails - Get email templates
• PUT /settings/emails/:id - Update email template
• GET /settings/payment-gateways - Get payment gateways
• PUT /settings/payment-gateways/:id - Update payment gateway

Plugins:

• GET /plugins - List plugins
• GET /plugins/:id - Get plugin
• POST /plugins/:id/enable - Enable plugin
• POST /plugins/:id/disable - Disable plugin
• PUT /plugins/:id/config - Update plugin configuration

API Keys:

• GET /api-keys - List API keys (for current user)
• POST /api-keys - Create API key
• DELETE /api-keys/:id - Delete API key

Response Format

Success:

{
  "status": "success",
  "data": { ... }
}

Error:

{
  "status": "error",
  "message": "Error message"
}

Interactive Documentation

Visit /api-docs when the server is running for interactive Swagger documentation.

Last updated: April 2026