inventory — module reference
Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.
| Module id | inventory |
| Name | Inventory |
| Version | 1.0.0 |
| Ships from | @endora-commerce/mod-inventory |
| Licence | MIT |
Activation
An operator switches this module on and off on /platform/modules. The choice is the setting inventory.enabled, and it defaults to on.
Dependencies
| Module | Binding | What it means |
|---|---|---|
audit_logs | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
auth | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
catalog | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
customer_accounts | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
dictionaries | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
email | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
orders | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
organizations | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
sales_channels | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
settings | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
transactional_emails | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
prompt_actions | no | contributes-to promptActionToolRegistry |
Permissions
| Code | Label | Also needs |
|---|---|---|
inventory:read | View stock and warehouses | — |
inventory:write | Manage stock and warehouses | — |
Command palette
| Action | Opens | Permission |
|---|---|---|
open-inventory | /inventory | inventory:read |
Settings
| Code | Name | Type |
|---|---|---|
inventory.allow_negative_stock | Allow ordering below stock (negative stock) | boolean |
inventory.display_mode | Storefront stock display mode | string |
inventory.enabled | Inventory enabled | boolean |
inventory.fulfilment_strategy | Order fulfilment strategy | string |
inventory.fulfilment_strategy_warehouse_order | Warehouse order (for "defined_order" strategy) | json |
inventory.global_threshold_high | Global high-stock threshold | number |
inventory.global_threshold_low | Global low-stock threshold | number |
inventory.global_threshold_medium | Global medium-stock threshold | number |
inventory.low_stock_alert_recipient_email | Low-stock alert recipient email | string |
Translations
Bundles at i18n inside the module, one file per shipped language.
Operator commands
None.