Developers
API resources
A map of the ~250 operations by area — what lives where, and which scope it needs.
The map
The /v1 surface mirrors the product. Per area, the scope pattern is
<area>:read / <area>:write; the
Scalar reference documents every
operation.
| Area | Resources |
|---|---|
| Catalog | items (CRUD, resolve, bulk, variants, relationships, putaway suggestions), categories, manufacturers |
| Storage | locations, containers (nested, move, history), vehicles |
| Stock | stock (summary, availability), stock operations (adjustments, movements, issues, consumptions, returns, quarantines, cost corrections) |
| Movements | movements, reversal, correction; receiving receipts and putaways |
| Workflows | transfers (send/receive/cancel), reservations, pick-lists (line pick/short/substitute/skip), counting tasks, cycle-count-rules |
| Assets | serial-units (checkout, check-in, maintenance schedules and records) |
| Manufacturing | boms (revisions, approve, flat, coverage, build/unbuild), projects (BOM links, usage report) |
| Purchasing | purchasing/purchase-orders (send/receive/cancel), reorder-suggestions, suppliers (item links, performance), site reorder-rules, fx-rates |
| Reporting | reports/stock/*, reports/stock-analytics/*, reports/movements/*, reports/purchasing/* (scope reports:read) |
| Data | exports (kinds, jobs, signed downloads), imports (kinds, multipart jobs, row errors) |
| Integration | events (the feed), webhooks (subscriptions, deliveries, replay), audit/events |
| Floor | labels/render, label-templates, barcodes, scans/resolve, search |
| Content | attachments (uploads, download URLs), notes |
| Settings | settings/custom-fields, settings/cycle-count-rules, conditions, reason-codes, tags, units |
Conventions that hold everywhere
- Collections page with opaque cursors; filters and sorts are declared per endpoint.
- Writes require idempotency keys; errors carry
stable
codes and atraceId. - Product capabilities and the acting tenant's permissions apply on top of key scopes — a scope grants no more than the tenant can do.
GET /v1/_auth/probeverifies a key and returns its identity and granted scopes — the cheapest connection check for an integration.