> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GraphQL API

> Reference for the JTL ERP GraphQL API: every query, mutation, and type, grouped by business area.

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:

```
https://api.jtl-cloud.com/erp/v2/graphql
```

Every request needs:

* An `Authorization: Bearer <token>` header. See [OAuth 2.0 Flow](https://developer.jtl-software.com/cloud/guides/essentials/authentication/oauth2-flow.md).
* 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](https://developer.jtl-software.com/cloud/guides/cloud-apps/using-platform-apis.md#graphql-api).

## 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](https://developer.jtl-software.com/cloud/guides/essentials/common-patterns/graphql-conventions.md) 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](https://developer.jtl-software.com/cloud/guides/essentials/authentication/scopes-permissions.md).

### 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](https://developer.jtl-software.com/cloud/api-reference/graphql-playground.md) 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.

| API version | JTL-Wawi version | Status | Schema |
| - | - | - | - |
| v2.2 | 2.3.x | Pre-release | [Download SDL](https://developer.jtl-software.com/graphql/erp/2.2.graphql.txt) |
| v2.1 | 2.2.x | Latest, recommended | [Download SDL](https://developer.jtl-software.com/graphql/erp/2.1.graphql.txt) |
| v2.0 | 2.1.x | Supported | [Download SDL](https://developer.jtl-software.com/graphql/erp/2.0.graphql.txt) |