Namespace Reference — Modules
Inventory
Curated JQL namespaces and examples for inventory.
Inventory namespaces cover categories, stores, units of measure, products, variants, prices, stock, requests, transactions, transfers, adjustments, audits, and variant options.
Key namespaces and models
inventory.Categoryinventory.Storeinventory.UnitOfMeasureinventory.Productinventory.ProductVariantinventory.ProductPriceinventory.Stockinventory.Requestinventory.RequestIteminventory.InventoryTransactioninventory.StockTransferinventory.StockAdjustmentinventory.InventoryAuditinventory.VariantOptionCategoryinventory.VariantOptionValue
Common controller intents
inventory.Inventory.getQuickStatsinventory.Inventory.getStockAlertsinventory.Inventory.getMyBadgeCountinventory.Inventory.getCategoryStatsinventory.Inventory.getStoreStats
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
Retrieve example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "inventory.Product",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "inventory.Category",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Hardware",
14 "alias": "hardware"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.