Skip to main content

Products & Inventory

Product catalog, variants, pricing, and warehouse management.

Overview​

The Products module provides a complete inventory management system with multi-variant support, warehousing, and merchant configuration.

Core Entities​

Product​

FieldTypeDescription
namestringProduct name
codestringSKU / product code
descriptionstringProduct description
enabledbooleanActive/inactive
categoryIdUUIDProduct category
typeIdUUIDProduct type
imageUrlstringPrimary image
variantsProductVariant[]Size/color variants

Product Variant​

FieldTypeDescription
quantitynumberStock quantity
billingInvoicingPolicyenumOrdered / Delivered
internalReferencestringInternal SKU
enabledbooleanVariant active
pricesVariantPrice[]Multi-currency prices
optionsProductOption[]Variant attributes

Product Category​

Hierarchical categorization:

Electronics
├── Laptops
│ ├── Gaming
│ └── Business
└── Accessories
├── Keyboards
└── Monitors

Warehouse​

FieldTypeDescription
namestringWarehouse name
codestringWarehouse code
activebooleanActive status
contactContactLocation/address
productsWarehouseProduct[]Stocked products

Pricing​

Multi-currency variant pricing:

FieldTypeDescription
unitCostnumberCost price
unitCostCurrencystringCost currency
retailPricenumberRetail price
retailPriceCurrencystringRetail currency

Merchant Configuration​

FieldDescription
nameMerchant/store name
logoStore logo
currencyDefault currency
contactStore contact info
warehousesAssociated warehouses

API Endpoints​

# Products
GET /api/products
POST /api/products
PUT /api/products/:id
DELETE /api/products/:id

# Categories
GET /api/product-categories
POST /api/product-categories

# Variants
GET /api/product-variants
POST /api/product-variants

# Warehouses
GET /api/warehouses
POST /api/warehouses
PUT /api/warehouses/:id