🏷️ Product
Product catalog, categories, variants, units of measure, and pricing attributes.
What's in this scope
The Product scope groups 2 HMX modules that together deliver end-to-end functionality for this area. Each module below focuses on a specific capability — click any card to jump to its documentation.
This scope comprises 2 Django apps under hmx/module/basic/, defining 3 models, 0 API endpoints, and 9 views collectively. Modules share dependencies and can be installed independently. External dependencies: base.
Core Product
Module core_product
Product
Module product
Scope Statistics
2
Modules in scope
3
Data models
0
API endpoints
9
UI views
0
Menu items
4
Actions
Module Relationships
Modules within the Product scope — often used together and share data models.
Getting Started
Install, configure, and enable the Product scope in your HMX instance.
Prerequisites
- Module
basemust be installed
Installation Steps
Step 1: Install core_product
Install the Core Product module via hmx CLI.
Step 2: Install product
Install the Product module via hmx CLI.
Post-install Checks
hmx list-modules and check that their menus are reachable from the HMX UI navigation.Core Product
HMX module: core_product
Overview
HMX module: core_product
core_product. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Core Product
Version
1.0
Category
Core_Product
Depends
1 modules
Dependencies
Data Models 3
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| product | Product | new | 13 | product.py |
| productcategory | ProductCategory | new | 13 | product_category.py |
| uomuom | Uom | new | 7 | uom_uom.py |
product — key fields
| Field | Type |
|---|---|
| TYPE_CHOICES | ? |
| name | CharField |
| sequence | IntegerField |
| description | TextField |
| type | CharField |
| categ | ForeignKey |
| currency | ForeignKey |
| list_price | DecimalField |
| standard_price | DecimalField |
| company | ForeignKey |
| barcode | CharField |
| default_code | CharField |
| is_active | BooleanField |
productcategory — key fields
| Field | Type |
|---|---|
| PRODUCT_TYPE_CHOICES | ? |
| name | CharField |
| complete_name | CharField |
| parent | ForeignKey |
| parent_path | CharField |
| product_count | IntegerField |
| is_active | BooleanField |
| product_type | CharField |
| auto_generate_code | BooleanField |
| code_prefix | CharField |
| code_digits | IntegerField |
| sequence_id | ForeignKey |
| allow_additional_prefix | BooleanField |
uomuom — key fields
| Field | Type |
|---|---|
| UOM_TYPE_CHOICES | ? |
| name | CharField |
| uom_type | CharField |
| factor | DecimalField |
| factor_inv | DecimalField |
| rounding | DecimalField |
| active | BooleanField |
Security & Access
ACL rules: 3 Groups: 0
Product
HMX module: product
Overview
HMX module: product
product. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Product
Version
1.0
Category
product
Depends
1 modules
Dependencies
Security & Access
ACL rules: 1 Groups: 0
Technical Reference
Complete registry of data models and API endpoints across all modules in this scope.
All Data Models 3
| Module | Model | Class | Fields |
|---|---|---|---|
| core_product | product | Product | 13 |
| core_product | productcategory | ProductCategory | 13 |
| core_product | uomuom | Uom | 7 |
All API Endpoints 0
No REST API endpoints registered in this scope.