Introduction
Build on the same API that runs every iotoms screen — catalog, sales, inventory, field operations, accounting and reports.
The iotoms API is a JSON-over-HTTPS REST API. It is the same API the iotoms console and the van-sales app use, so anything you can do on a screen has an endpoint behind it.
Every endpoint is listed in the sidebar, grouped by business area. Each page shows the request, the response, every field, and a playground to try the call live.
Base URL
https://beta.iotoms.comBeta environment
This reference currently points at the beta environment. Use a beta account and test data while you build your integration.
Quick start
1. Understand the setup
Tenants, venues, stores and registers — how an iotoms business is organised.
2. Authenticate
Log in with a user's credentials and get the token every call needs.
3. Learn the conventions
Response envelope, errors, paging, dates, IDs and money fields.
Every request needs two headers
| Header | Value |
|---|---|
X-TenantID | Your merchant's tenant code — see Concepts |
Authorization | Bearer <token> — see Authentication |
The login call is the one exception: it needs X-TenantID but no token yet.