Reference
API Reference
These endpoints power the OneAce app. They are NOT a public-stable customer API yet — names and shapes may change. If you're integrating, please contact support for SLA guarantees.
Quick facts
- • 52 endpoints across 10 categories
- • Authentication: session-based (for now). Open a session via /api/auth/[...all]
- • Webhooks: POST endpoints for QB, Shopify, and custom inbound events
- • Rate limits: applied per-user on sensitive operations (revoke, etc.)
- • Base URL:
https://oneace.app/api
Authentication & Sessions
| Endpoint | Methods | Description |
|---|---|---|
/api/account/sessions | GET | List active sessions for the authenticated user. |
/api/account/sessions/{id}/revoke | POST | Revoke a specific session (log out a device). |
/api/account/sessions/revoke-all | POST | Revoke all sessions except the current one. |
/api/auth/two-factor/verify | POST | Verify a two-factor authentication code. |
/api/account/delete | POST | Delete your account and all associated data. |
/api/account/export | GET | Export your personal data (GDPR compliance). |
Integrations
| Endpoint | Methods | Description |
|---|---|---|
/api/integrations/quickbooks/callback | GET | OAuth callback handler for QuickBooks Online. |
/api/integrations/quickbooks/webhooks | GETPOST | Receive webhook events from QuickBooks. |
/api/integrations/shopify/connect | GET | Start Shopify OAuth flow. |
/api/integrations/shopify/callback | GET | OAuth callback handler for Shopify. |
/api/integrations/shopify/webhooks | POST | Receive webhook events from Shopify. |
Reports & Analytics
| Endpoint | Methods | Description |
|---|---|---|
/api/reports/abc-analysis | POST | Generate ABC analysis (classify items by value). |
/api/reports/count-comparison | GETPOST | Compare physical counts with book inventory. |
/api/reports/count-comparison/pdf | POST | Export count comparison report as PDF. |
/api/reports/low-stock/pdf | GET | Generate low stock alert report. |
/api/reports/stock-value/pdf | GET | Generate inventory value report. |
/api/reports/bin-inventory/pdf | GET | Generate bin-level inventory report. |
/api/reports/movements/pdf | GET | Generate stock movement history report. |
/api/reports/department-variance | GETPOST | Analyze variance by department. |
/api/reports/variance-trend | GETPOST | Track variance trends over time. |
Migrations & Data Import
| Endpoint | Methods | Description |
|---|---|---|
/api/migrations | GETPOST | List migrations or create a new migration. |
/api/migrations/{id} | GETDELETE | Get migration details or delete a migration. |
/api/migrations/{id}/detect | POST | Detect schema from uploaded CSV. |
/api/migrations/{id}/mapping | PUT | Configure column mapping for import. |
/api/migrations/{id}/validate | POST | Validate the import data. |
/api/migrations/{id}/start | POST | Start the migration process. |
/api/migrations/{id}/status | GET | Check migration progress. |
/api/migrations/{id}/cancel | POST | Cancel an in-progress migration. |
/api/migrations/{id}/rollback | POST | Rollback a completed migration. |
/api/migrations/{id}/upload | POST | Upload CSV file for migration. |
Onboarding
| Endpoint | Methods | Description |
|---|---|---|
/api/onboarding/organization | POSTPATCH | Create or update organization during setup. |
/api/onboarding/migration-start | POST | Start a data migration from onboarding flow. |
Labels & Printing
| Endpoint | Methods | Description |
|---|---|---|
/api/labels/bin-labels/pdf | GET | Generate bin label sheet as PDF. |
/api/labels/custom/pdf | POST | Generate custom labels from template. |
Billing & Payments
| Endpoint | Methods | Description |
|---|---|---|
/api/billing/checkout | POST | Initiate a checkout session. |
/api/billing/portal | POST | Access billing portal for subscription management. |
/api/billing/webhook | POST | Receive payment provider webhooks. |
Webhooks & Events
| Endpoint | Methods | Description |
|---|---|---|
/api/webhooks/inbound | POST | Receive inbound webhooks from external systems. |
/api/webhooks/resend | POST | Retry failed webhook deliveries. |
Uploads & Media
| Endpoint | Methods | Description |
|---|---|---|
/api/upload/image | POST | Upload product images or documents. |
System Health
| Endpoint | Methods | Description |
|---|---|---|
/api/health | GET | Health check with database and schema validation. |
/api/debug-dashboard | GET | Debug endpoint (requires OWNER role + opt-in). |
Cron & Background Jobs
| Endpoint | Methods | Description |
|---|---|---|
/api/cron/keep-alive | GET | Keep the application warm in serverless environments. |
/api/cron/integration-tasks | GET | Process background integration sync tasks. |
/api/cron/process-imports | GET | Process queued data imports. |
/api/cron/cleanup-audit-events | GET | Cleanup old audit logs. |
/api/cron/cleanup-notifications | GET | Cleanup old notifications. |
/api/cron/cleanup-migration-files | GET | Cleanup migration temp files. |
/api/cron/stock-count-triggers | GET | Trigger scheduled stock count reminders. |
/api/cron/notifications/{frequency} | GET | Send digest notifications (daily/weekly). |
/api/cron/platform-quota-health | GET | Monitor build minutes quota. |
/api/cron/platform-webhook-health | GET | Verify webhook delivery health. |
For detailed endpoint documentation, schema definitions, and code examples, see the docs/openapi.yaml file in the GitHub repository. Need help? Reach out to support@oneace.app.