Misc
Login
Authenticates a user and returns a Bearer token.
Logout
Revokes the current Bearer token.
List Integration Instances
Returns all integration instances (connections to external platforms like Shopify, Amazon, Xero, etc.).
Get Authenticated User
Returns the currently authenticated user's profile. The `features` object reports per-tenant feature flags (e.g. `features.granular_permissions` — whether granular role/permission enforcement is enabled for the tenant; `false` when the flag is off or unset).
Account Setup
Completes initial account setup after registration.
Get Company Profile
Returns the company profile settings.
Update Company Profile
Updates the company profile.
App Settings
Returns global application settings (feature flags, configuration) for the frontend.
List Activity
Returns a paginated activity/audit log across all entities.
Update Address
Updates an address record.
Delete Address
Deletes an address record.
Check If Address Is Deletable
Checks whether an address can be safely deleted (not referenced by active records).
Check If Address Is Locked
Checks whether an address is locked (read-only due to being used in finalized orders).
List Alert Preferences
Returns the current user's alert notification preferences.
Bulk Update Alert Preferences
Updates multiple alert preferences at once.
Create Note
Creates a note on a noteable entity (SalesOrder, PurchaseOrder, etc.).
Delete Note
Deletes a note.
Update Note
Updates a note.
Global Search
Performs a global search across multiple entity types.
List Enums
Returns all application enum values used by the frontend for dropdowns and validation.
List User API Keys
Returns all API keys for the current user.
Create API Key
Creates a new API key for the current user. The token is only shown once in the response.
Delete API Key
Revokes an API key.
Get Low Stock Items
Returns products that are at or below their reorder point.
Export Low Stock Items
Exports low-stock items as a downloadable CSV or XLSX file.
Inventory Management Settings
Returns inventory management configuration settings.
Get Inventory Valuation
Returns the total value of on-hand and in-transit inventory across all warehouses, broken down by inventory status. Each status carries both a quantity and a valuation, plus an overall average unit cost. Use it to power an inventory valuation summary. Optionally scope the figures to a single warehouse or to an as-of cut-off date.
Get Inventory Valuation by Product
Returns a flat, per-product breakdown of inventory value. Every product row includes quantities and valuations split by status (active, reserved, in-transit, inbound, on-hand) together with average unit costs, and the response ends with a totals block summing all products. Use it to build a detailed inventory valuation report.
Get Low Stock Metrics
Returns summary counts for the low-stock report: how many products are low on stock, how many are critically low (below the configured days-of-supply threshold), how many are out of stock, and how many have no minimum stock level configured, along with the threshold in days. Accepts the same filters as the low-stock list so the metrics match the filtered view.
Update Custom Field Values
Sets custom field values for a specific entity instance.
Delete Sales Rep
Deletes a sales rep.
Lookup
Generic autocomplete lookup endpoint used by select/dropdown inputs throughout the UI. Returns a list of matching records for a given entity type.
List Constants
Returns application constants used for frontend configuration.
List Sales Channels
Returns all sales channels (Shopify stores, Amazon marketplaces, etc.).
Change Password
Changes the current user's password.
Request Password Reset Email
Sends a password-reset link to the supplied email address if an account exists for it. This is a public, unauthenticated endpoint. Returns a confirmation message on success, or a validation error if the email is missing/invalid or no account matches.
Reset Password
Completes a password reset using the token from the reset email. Provide the token, the account email, and the new password with its confirmation. This is a public, unauthenticated endpoint. On success the password is updated (and an invited-but-unactivated account is activated); on failure a validation error is returned.
List Webhooks
Returns all configured outbound webhooks.
Create Webhook
Creates a new outbound webhook.
Show Webhook
Returns a single webhook.
Update Webhook
Updates a webhook.
Delete Webhook
Deletes a webhook.