Namespace Reference — Modules
Sales
Curated JQL namespaces and examples for sales.
Sales namespaces cover sales orders, order items, tenant sales settings, store settings, revenue breakdowns, fulfilment metrics, and status statistics.
Key namespaces and models
sales.SalesOrdersales.SalesOrderItemsales.SalesTenantSettingssales.SalesStoreSettings
Common controller intents
sales.SalesOrder.getQuickStatssales.SalesOrder.getRevenueBreakdownsales.SalesOrder.getFulfillmentMetricssales.SalesOrder.getStatusCountStats
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": "sales.SalesOrder",
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": "sales.SalesStoreSettings",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Main store",
14 "alias": "main-store"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.