Misc
Login
Authenticates a user and returns a Bearer token.
Logout
Revokes the current Bearer token.
List Users
Returns all users for the account.
List Integration Instances
Returns all integration instances (connections to external platforms like Shopify, Amazon, Xero, etc.).
List Table Views
Returns saved table views (column layouts and filter presets) for a given datatable.
Create Table View
Creates a new saved table view.
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.).
Update Note
Updates a note.
Delete Note
Deletes a note.
Global Search
Performs a global search across multiple entity types.
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 Enums
Returns all application enum values used by the frontend for dropdowns and validation.
List Constants
Returns application constants used for frontend configuration.
List Sales Channels
Returns all sales channels (Shopify stores, Amazon marketplaces, etc.).
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.
Update Table View
Update an existing table view's name, content, or settings.
Delete Table View
Delete a saved table view.
Change Password
Changes the current user's password.
Get Low Stock Items
Returns products that are at or below their reorder point.
Inventory Management Settings
Returns inventory management configuration settings.
Show Discount Code
Returns a single discount code.
Update Discount Code
Updates a discount code.
Delete Discount Code
Deletes a discount code.
Update Custom Field
Updates a custom field definition.
Delete Custom Field
Deletes a custom field definition.
Update Custom Field Values
Sets custom field values for a specific entity instance.
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.
List FIFO Layers
Returns a paginated list of FIFO inventory layers. Supports GroupedFilterSupport filter trees and sorting.
Show FIFO Layer
Returns a single FIFO layer with product, warehouse, and link relations loaded.
FIFO Layer Allocations
Returns sales order line allocations for this FIFO layer — which sales orders have reserved quantity from this layer.
FIFO Layer Inventory Movements
Returns inventory movements associated with this FIFO layer.
Archive FIFO Layer
Archives a single FIFO layer. Only fully utilized layers (available_quantity = 0) can be archived.
Unarchive FIFO Layer
Unarchives a previously archived FIFO layer.
Bulk Archive FIFO Layers
Archives multiple FIFO layers. Only fully utilized layers (available_quantity = 0) can be archived. Use apply_to_all with filters to archive all matching layers.
Bulk Unarchive FIFO Layers
Unarchives multiple FIFO layers.
Upload Data Import
Uploads mapped CSV data for import and kicks off background validation. Returns the data import ID and a tracked job log ID to poll for validation progress.
Get Data Import Summary
Returns the summary for a data import including status, row counts, and validation/import summaries.
Get Validation Results
Returns paginated validation results for a data import. Optionally filter by result type.
Execute Data Import
Executes a validated data import. Kicks off the background import job and returns a tracked job log ID to monitor progress.
Get Import Results
Returns the import results after execution has completed.
Operational KPIs
Returns operational KPI metrics for the dashboard.
Dashboard Summary
Returns aggregated summary data for the dashboard.
List Customers
Returns a paginated list of customers.
Show Customer
Returns a single customer.
List Settings
Returns all application settings.
Bulk Update Settings
Updates multiple settings at once.
Show Setting
Returns a single setting by slug.
Update Setting
Updates a single setting by slug.
List Tracked Job Logs
Returns a paginated DataTable list of tracked job logs. Tracked jobs represent background queue jobs visible in the job progress tray.
List Active Tracked Job Logs
Returns all currently active (running or pending) tracked job logs. Used by the job progress tray to poll for running jobs.
Cancel Tracked Job
Requests cancellation of a running tracked job. The job will stop at the next cancellation checkpoint.
Retry Tracked Job
Retries a failed tracked job.
List Suppliers
Returns a paginated list of suppliers.
Show Supplier
Returns a single supplier.
List Warehouses
Returns all warehouses.
Show Warehouse
Returns a single warehouse.
List Attribute Groups
Returns all attribute groups.
List Attributes
Returns all product attributes.
List Brands
Returns all product brands.
List Categories
Returns all product categories.
List CSV Templates
Returns all CSV import/export templates.
List Data Feeds
Returns all data feeds.
List Financial Alerts
Returns a paginated list of financial alerts (low margin or loss alerts on sales order lines). Uses Spatie QueryBuilder for filtering and sorting.
List Financial Line Types
Returns all financial line types for the organization.
List Incoterms
Returns a paginated list of incoterms (International Commercial Terms). Supports search, pagination, and archive filtering.
List Nominal Codes
Returns all nominal codes (accounting chart of accounts codes).
List Payment Terms
Returns a paginated list of payment terms.
List Payment Types
List all payment types. Returns a flat collection (not paginated).
List Product Pricing Tiers
Returns all product pricing tiers.
List Return Reasons
Returns all return reasons.
List Shipping Methods
Returns all shipping methods.
List Stores
Returns all stores (sales channel store integrations).
List Supplier Pricing Tiers
Returns all supplier pricing tiers.
List Tags
Returns all tags.
List Tax Rates
Returns all tax rates.
List Users
Returns all users for the account.
List Inventory Adjustments
Returns a paginated list of inventory adjustments.
Export Inventory Adjustments
Exports inventory adjustments as a CSV file.
Show Inventory Adjustment
Returns a single inventory adjustment.
List Inventory Movements
Returns a paginated list of inventory movements.
List Listings
Returns a paginated list of channel listings (products listed on sales channels).
Listings Summary
Returns summary counts for listings by status.
Bulk Archive Listings
Archives multiple listings.
Bulk Unarchive Listings
Unarchives multiple listings.
List Sales Credits
Returns a paginated list of sales credits.
Sales Credits Filter Options
Returns available filter options (distinct values) for sales credits filtering.
Sales Credit Activity Log
Returns the activity log for a sales credit.
Daily Financial Summary
Returns daily financial summary data for reporting.
Sales Order Line Financials
Returns paginated financial data at the sales order line level.
Ship By Schedule
Returns ship-by schedule report data showing orders that need to be shipped by specific dates.
Show Product Listing
Returns a single product listing (V2 endpoint with enhanced resource).
Update Product Listing
Updates a product listing.