Skip to main content
The JTL ERP GraphQL API provides a single endpoint for querying and modifying JTL-Wawi data. It is available starting with API version v2.0. This reference documents every query, mutation, and type in the schema, organised by business area such as Items, Sales, and Inventory. Each area contains its operations and the types they use. Types shared across multiple areas are documented under Common Types. Use the version selector to switch the reference to the API version your app targets.

​
Endpoint and Authentication

Send all requests as HTTP POST requests to:
Every request needs:
  • An Authorization: Bearer <token> header. See OAuth 2.0 Flow.
  • An x-tenant-id header with the tenant ID of the target JTL-Wawi instance.
For request examples in several languages, see Using Platform APIs.

​
Reading a Reference Page

Each query and mutation reference includes:
  • The operation’s arguments and return type, with links to the types they reference.
  • An example operation, its required variables, and a sample response.
  • Deprecated fields and arguments, including the reason for deprecation when available in the schema.
The schema follows consistent patterns for naming, pagination, and filtering. See GraphQL Conventions for an overview of these patterns and how to use them when querying the API.

​
Scopes

Each operation page lists the scopes your app needs to call it. To learn how to request scopes for your app, see Scopes and Permissions.

​
Release Status

Some operations and fields have a release status such as Beta or Experimental. These are not yet stable and may change between releases. Check the status before using them in production. Operations and fields without a release status are considered stable.

​
Try a Query

Use the GraphQL Playground to write and run queries and mutations against the API. Sign in to execute operations against your own JTL-Wawi instance.

​
Download the Schema

Download the complete schema in GraphQL Schema Definition Language (SDL) format for a specific API version. You can use it to generate typed clients, validate queries, or integrate the schema into your development tools.