Description
n8n-nodes-regos
n8n community nodes for the REGOS SaaS ERP — a retail/ERP platform (inventory, documents, POS, CRM, loyalty) used primarily in Uzbekistan.
Full coverage of the REGOS Public API (872 endpoints) plus a webhook trigger for all 297 REGOS events.
Installation
In n8n, go to Settings → Community Nodes → Install, enter the package name:
n8n-nodes-regos
See n8n’s community node installation guide for details.
Credentials
1. In REGOS Online go to Business settings → Integrations and create a Local Integration.
2. REGOS shows a gateway endpoint like https://integration.regos.uz/gateway/out/.
3. In n8n, create a REGOS API credential and paste the part as the Integration Key. Leave Base URL at its default unless REGOS gave you a different gateway host.
The integration key is the only secret — it authenticates every call. Use the credential’s Test button to verify it (it calls CurrentTimeStamp/Get).
Nodes
The package registers one action node and one trigger node, sharing a single credential:
| Node | Covers |
|—|—|
| Regos | The whole REGOS Public API — every resource (items, partners, accounts, warehouses and dictionaries; documents and their line-item operations; POS; CRM and loyalty; reports and dashboards) is a Resource on this node, plus a Batch resource |
| Regos Trigger | Webhook trigger with a selector over all 297 REGOS events |
One node, every REGOS resource. REGOS is a single service with a very large API — 871 operations across 170 resources — so, following n8n’s one-node-per-service convention (the shape used by Notion, HubSpot and Airtable), all of it lives on the single Regos node. Pick a Resource, then an Operation; n8n only renders the fields for the resource you select. The consolidation from an earlier five-node layout is recorded in ADR-0006.
Operations
The Regos node follows n8n’s Resource → Operation pattern, which maps directly onto REGOS API paths:
| REGOS API path | Resource | Operation |
|—|—|—|
| Item/Get | Item | Get Many |
| Item/Add | Item | Add |
| DocPurchase/Perform | Doc Purchase | Perform |
| pos/DocCheque/Close | POS Doc Cheque | Close |
Notes:
- Operations that act on a single record (edit, delete, perform, …) show the record ID as a required field. Everything else lives under Additional Fields.
- List operations support Return All with automatic pagination, or a Limit.
- Date fields accept normal n8n date values and are converted to REGOS’s Unix-epoch-seconds format.
- The Batch resource runs up to 50 REGOS calls in one request, with
${stepKey.result.prop}placeholders passing values between steps.
Example workflows
1. Sync the item catalog on a schedule
Schedule Trigger → Regos (Item → Get Many, Return All) → your destination.
{
"name": "REGOS item sync",
"nodes": [
{
"parameters": { "rule": { "interval": [{ "field": "hours", "hoursInterval": 6 }] } },
"id": "1f6a0f42-0f0f-4f8e-9b5a-1a2b3c4d5e6f",
"name": "Every 6 hours",
"type": "n8n-nodes-base.scheduleTrigger",
"typeVersion": 1.2,
"position": [0, 0]
},
{
"parameters": { "resource": "item", "operation": "get", "returnAll": true, "additionalFields": {} },
"id": "2f6a0f42-0f0f-4f8e-9b5a-1a2b3c4d5e70",
"name": "Regos",
"type": "n8n-nodes-regos.regos",
"typeVersion": 1,
"position": [220, 0],
"credentials": { "regosApi": { "id": "1", "name": "REGOS account" } }
}
],
"connections": { "Every 6 hours": { "main": [[{ "node": "Regos", "type": "main", "index": 0 }]] } }
}
2. React to a retail order status change
Regos Trigger (event DocOrderDeliveryStatusSet, Resolve Data on) → IF → notify.
{
"name": "REGOS order status watcher",
"nodes": [
{
"parameters": { "events": ["DocOrderDeliveryStatusSet"], "options": { "resolveData": true } },
"id": "3f6a0f42-0f0f-4f8e-9b5a-1a2b3c4d5e71",
"name": "Regos Trigger",
"type": "n8n-nodes-regos.regosTrigger",
"typeVersion": 1,
"position": [0, 0],
"webhookId": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"credentials": { "regosApi": { "id": "1", "name": "REGOS account" } }
},
{
"parameters": {
"conditions": {
"options": { "caseSensitive": true, "version": 2 },
"conditions": [
{
"leftValue": "={{ $json.data.status }}",
"rightValue": "Completed",
"operator": { "type": "string", "operation": "equals" }
}
],
"combinator": "and"
}
},
"id": "4f6a0f42-0f0f-4f8e-9b5a-1a2b3c4d5e72",
"name": "Is completed?",
"type": "n8n-nodes-base.if",
"typeVersion": 2.2,
"position": [220, 0]
}
],
"connections": { "Regos Trigger": { "main": [[{ "node": "Is completed?", "type": "main", "index": 0 }]] } }
}
Copy either block and paste it onto an n8n canvas to import it, then select your own credential.
Trigger setup
REGOS webhook registration is manual:
1. Add a Regos Trigger node and select the events you need (or All Events).
2. Copy the trigger’s Production URL.
3. In REGOS Online, edit your Local Integration and add that URL to its webhooks list.
Notes:
?token= to the URL you register in REGOS.Event → Get operation on the Regos node (lasteventid cursor).Behavior details
{ok: false, result: {error, description}} — the nodes surface these as node errors with the REGOS error code.next_offset pagination.REGOS error codes
REGOS reports application errors with HTTP 200 and an error code between 1000 and 9999. The nodes raise these as REGOS error : . The description text comes from the REGOS API and is in Russian.
| Range | Meaning |
|---|---|
| 1000–1999 | Validation, access and business-rule errors (e.g. 1008 invalid input parameters, 1044 record not found, 1007 insufficient privileges) |
| 2000–2999 | Database and third-party integration errors |
| 3000–3999 | Internal application errors |
| 4000–4999 | Loyalty, discount and messaging errors |
| 5000–5999 | Cash register, shift and receipt errors |
| 8213 | Rate limit exceeded — the nodes retry this automatically with backoff |
| 9000–9999 | Authorization errors (e.g. an invalid or revoked integration key) |
The full catalog is in the REGOS documentation (Russian):
Resources
Development
npm install --ignore-scripts # isolated-vm (transitive, unused at dev time) needs native build tools otherwise
npm run generate # regenerate node descriptions from openapi/regosapiswagger.json
npm run lint
npm test
npm run build
Requires Node.js >= 20.19. Node descriptions under nodes/*/generated/ are produced by scripts/generate/ — edit the generator or its overrides/, never the generated files.
docs/reference/ holds read-only snapshots of the vendor's own API documentation (in Russian) kept for development reference. They are not part of the published package, which ships dist/ only.