Introduction
How to reach the VARIO Cloud REST API — base URL, tenant-specific endpoints, and the OpenAPI specification.
The VARIO Cloud REST API lets you read and write ERP data from your own applications and integrations. It is a standard HTTP API secured with OAuth 2.0 and exposes the same service layer that powers the ERP itself.
Typical uses: synchronising articles, prices and stock with another system; importing orders; creating and transferring documents; reading master data for a report or a portal; and everything a VARIO Cloud App does on the server side.
To call the API you need two things: an access token (see Authentication) and the correct base URL for your tenant. Both come from an App you register — see Create an App.
Where to look for what
Documentation (these pages)
How the platform works — authentication, paging and filtering, webhooks, the query language, concepts you need before the reference makes sense
Every endpoint, generated from the OpenAPI specification: paths, parameters, request and response schemas
One page per integration domain — shops, shipping, banking, accounting, POS
Rule of thumb: come here to understand how something works, go to the API Reference to look up what exactly to send.
Base URL
Every API request goes to your tenant-specific base URL:
https://{subdomain}.vario.cloud/api/varioReplace {subdomain} with your own tenant subdomain — the same one you use to reach your VARIO Cloud installation. For example, if you access your installation at https://mycompany.vario.cloud, your API base URL is:
https://mycompany.vario.cloud/api/varioAll endpoint paths in this documentation and in the API reference are relative to this base URL. For example, executing a VQL query:
POST https://mycompany.vario.cloud/api/vario/cmn/computed-queries/executeUse your own tenant subdomain — not the address shown in the API reference. The server address displayed at the top of the interactive API reference is an internal placeholder and is not reachable from the outside. Always build your base URL from your own tenant subdomain, as shown above.
Tenant-specific OpenAPI specification
The API reference lists every available endpoint. For the exact, tenant-specific server URL and the endpoints enabled for your installation, download the OpenAPI (Swagger) specification directly from your VARIO ERP:
Open your VARIO ERP support mode.
Download the OpenAPI specification for your installation.
The servers entry in that file contains the correct base URL for your tenant. You can also import the file into tools such as Postman, Insomnia, or a code generator to work against your installation directly.
Type definitions
If you build your integration in TypeScript or JavaScript, the @vario-software/types package provides type definitions for the VARIO Cloud platform — including typed API calls and the OpenAPI schemas — giving your editor autocompletion and type checking. See the package page for setup instructions.
The same package also covers Scripting.
Before you start
Authenticate every request with an OAuth 2.0 access token — see Authentication.
Always send a
User-Agentheader. Requests without one are rejected with403 Forbidden.API traffic is subject to rate limiting.
Last updated
Was this helpful?