API reference
Every endpoint of the Integration API. These pages are generated from the OpenAPI spec, so they always match the running API.
Base URL, authentication, response envelope and errors: Calling the API.
Download the OpenAPI file — Import the spec into Postman, Insomnia or a client-code generator.
Resources
Catalog
| Resource | Endpoints |
|---|---|
| Product | 12 |
| Category | 7 |
| Attribute | 5 |
| Custom field | 2 |
| Tag | 5 |
| Units of measure | 7 |
| Box types | 7 |
| Price | 3 |
| Discount | 7 |
Customers
| Resource | Endpoints |
|---|---|
| Customer | 8 |
| Customer Bulk | 1 |
| Customer category | 6 |
| Person | 3 |
| Balance | 1 |
| Cashback | 1 |
| Cashback settings | 7 |
| Public lead form | 5 |
| Source | 2 |
Sales
| Resource | Endpoints |
|---|---|
| Trade | 11 |
| Sale order | 9 |
| Sale Order Bulk | 2 |
| Open ticket | 5 |
| Booking table | 6 |
| Invoice | 5 |
| Recon act | 3 |
| Task | 8 |
| Task type | 2 |
| Reason | 5 |
| Pipeline action | 6 |
| States | 1 |
| States settings | 5 |
| Sms template | 5 |
Warehouse
| Resource | Endpoints |
|---|---|
| Warehouse | 4 |
| Warehouse settings | 2 |
| Product stock | 2 |
| Product warehouse | 2 |
| Internal transfer | 6 |
| Organizational transfer | 6 |
| Revision | 5 |
| Write off | 4 |
Purchasing
| Resource | Endpoints |
|---|---|
| Purchase | 5 |
| Purchase order | 4 |
| Purchase return | 2 |
| Supplier | 5 |
| Extra cost | 7 |
Finance
| Resource | Endpoints |
|---|---|
| Transaction | 11 |
| Income | 4 |
| Payment method | 7 |
| Payment type | 7 |
| Tax | 8 |
| Cashbox | 1 |
| Cashbox session | 5 |
| Finance settings | 2 |
| Currency | 4 |
Production
| Resource | Endpoints |
|---|---|
| Production operation | 5 |
| Production route sheet | 8 |
| Production tech map | 5 |
| Production group | 5 |
| Production order | 5 |
| Production plan | 6 |
| Production step | 5 |
| Production task | 8 |
Staff
| Resource | Endpoints |
|---|---|
| Employee | 7 |
| Role | 5 |
| Position | 5 |
| Section | 5 |
| Kpi settings | 6 |
| Device | 6 |
Reports
| Resource | Endpoints |
|---|---|
| Report | 7 |
| Report dashboard | 20 |
| Report sales | 12 |
| Report pos | 31 |
| Report finance | 14 |
| Report warehouse | 5 |
| Report production | 4 |
| Report distribution | 4 |
| Report analysis | 3 |
Platform
| Resource | Endpoints |
|---|---|
| Organization | 2 |
| Profile | 1 |
| Sale settings | 2 |
| Marketing settings | 2 |
| Message settings | 2 |
| Reminder settings | 2 |
| File | 3 |
| Export records | 4 |