For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

Contents

Documentation (these pages)

How the platform works — authentication, paging and filtering, webhooks, the query language, concepts you need before the reference makes sense

API Reference

Every endpoint, generated from the OpenAPI specification: paths, parameters, request and response schemas

Cookbook

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/vario

Replace {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/vario

All 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/execute

The base URL is not the same as the authentication URL. Access tokens are requested from the identity server at https://sso.vario.cloud/realms/<TENANT>/protocol/openid-connect/token. Once you have a token, you send your actual API requests to https://{subdomain}.vario.cloud/api/vario. See Authentication.

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:

  1. Open your VARIO ERP support mode.

  2. 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-Agent header. Requests without one are rejected with 403 Forbidden.

  • API traffic is subject to rate limiting.

Let an AI assistant read the contract for you. With the VARIO Cloud MCP server, Claude Code, Cursor or VS Code can search the live OpenAPI specification of your tenant, show the exact payload of an endpoint including custom fields, and test calls against a development tenant. See AI Assistants (MCP).

Last updated

Was this helpful?