Skip to content
item
/
Query Product Groups

JTL-WAWI API (Cloud) (1.1)

JTL-Wawi-Version: 1.11.0.0

Introduction

Welcome to the JTL-WAWI technical API documentation. This guide is here to help developers understand how our REST API works and how it can be integrated into your existing systems. We'll delve into the details of authentication and data manipulation processes, providing clear examples along the way. Whether you're a developer or an IT professional, this documentation aims to give you a practical understanding, laying the groundwork for effectively using the JTL-WAWI API to enhance your processes.

Authentication

You register your application with the API by sending a POST request with the required information and corresponding keys. You can find the exact request details at https://developer.jtl-software.com/products/erp/swagger/appregistration. This information has to include the following:

  • AppId
  • DisplayName
  • Description
  • Version
  • ProviderName
  • ProviderWebsite
  • MandatoryApiScopes

This data is crucial for identifying and registering your application with the API. The API uses it to generate a temporary authentication ID that allows your application to access the necessary resources. After successful validation of this information, you will receive the API key required for future authentication and API requests.

Before you can begin the registration process, you must open JTL-Wawi (new interface) and start the registration process under 'Admin->App registration'. Only at this point are you authorised to send the first API call. This step in JTL-Wawi ensures that your application is properly registered and has permission to use the API.

The API will send you an authentication ID in the form of a token. Once you have received this token and successfully completed the registration in JTL-Wawi, you will send another request to the API by including this authentication ID in the URL path.

After successful validation of this second request by the API and confirmation of the correct information, you will be provided with the actual API key. It is important to note that this API key will not be displayed again!

This API key will be used in the future to authenticate requests to the API. It is of utmost importance that you securely store the API key upon receipt, as it cannot be retrieved from any other location in the system.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://developer.jtl-software.com/

JTL-Software-GmbH

partner@jtl-software.com

Languages
Servers
Mock server

https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/

Production Environment Cloud API Gateway

https://api.jtl-cloud.com/erp/

Beta Environment Cloud API Gateway

https://api.beta.jtl-cloud.com/erp/

worker

Planned

Operations

wms

Query all pick lists for a specific wms warehouse that are not completed.
Operations

warehouse

Query all warehouses
Operations

transactionStatus

Query all transaction status for sales order
Operations

tax

Returns the Taxrate for the given Item
Operations

item

Query all tax classes
Operations

Query Manufacturers

Request

Query all manufacturers

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/manufacturers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all manufacturers.

Bodyapplication/jsonArray [
Idinteger(int32)(JTL.Data.Contracts.Keys.HerstellerKey)required
Namestringrequired

Name of the manufacturer.

Example: "Awesome Manufacturer"
Descriptionstringrequired

Manufacturer description.

Example: "Some info about the manufacturer"
Homepagestringrequired

Homepage of the manufacturer.

Example: "https://awsome-manufacturer.com"
SortNumberinteger(int32)required

Sorting number of the manufacturer.

Example: 1
MetaTitlestringrequired

Meta title of the manufacturer.

Example: "Awesome Manufacturer"
MetaKeywordsstringrequired

Meta keywords of the manufacturer.

Example: "Products, fast delivery"
MetaDescriptionstringrequired

Meta description of the manufacturer.

Example: "Awesome Manufacturer"
]
Response
application/json
[
  {
    "Id": 0,
    "Name": "Awesome Manufacturer",
    "Description": "Some info about the manufacturer",
    "Homepage": "https://awsome-manufacturer.com",
    "SortNumber": 1,
    "MetaTitle": "Awesome Manufacturer",
    "MetaKeywords": "Products, fast delivery",
    "MetaDescription": "Awesome Manufacturer"
  }
]

Query Product Groups

Request

Query all product groups

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/productGroups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all product groups.

Bodyapplication/jsonArray [
Idinteger(int32)(JTL.Data.Contracts.Keys.WarengruppeKey)required
Namestringrequired

The name of the item group.

Example: "Standard items"
]
Response
application/json
[
  {
    "Id": 0,
    "Name": "Standard items"
  }
]

Query Responsible Persons

Request

Query all ResponsiblePerson

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/responsiblePersons \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all ResponsiblePerson.

Bodyapplication/jsonArray [
Idinteger(int32)(JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ContactKey)required
Numberstringrequired

Unique Number of the ResponsiblePerson.

Example: "AB31313"
Descriptionstringrequired

Manufacturer description.

Example: "Some info about the ResponsiblePerson"
Addressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

Address.​Idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
Address.​Companystringrequired

Description of the Company.

Example: "Sportbedarf Sommer"
Address.​Company2stringrequired

Additional company information

Example: "Innovation Division"
Address.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
Address.​Titlestringrequired

Official title

Example: "Dr."
Address.​FirstNamestringrequired

Customer first name

Example: "John"
Address.​LastNamestringrequired

Customer last name

Example: "Doe"
Address.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
Address.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
Address.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
Address.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
Address.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
Address.​CountryIsostringrequired

Country ISO code

Example: "DE"
Address.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
Address.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
Address.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
Address.​EmailAddressstringrequired

Email address

Example: "example@email.com"
Address.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
Createdstring(date-time)required

The DateTime of Creation.

Example: "1985-01-01T00-00-00"
LastChangedstring(date-time)required

The DateTime of the Lastchange.

Example: "1985-01-01T00-00-00"
IsActivebooleanrequired

The ResponsiblePerson is active

Example: true
LanguageKeyinteger(int32)(JTL.Data.Contracts.Keys.SpracheKey)required
]
Response
application/json
[
  {
    "Id": 0,
    "Number": "AB31313",
    "Description": "Some info about the ResponsiblePerson",
    "Address": { … },
    "Created": "1985-01-01T00-00-00",
    "LastChanged": "1985-01-01T00-00-00",
    "IsActive": true,
    "LanguageKey": 0
  }
]

supplier

Query all suppliers
Operations

stock

Query stocks for a specific item, warehouse or storage location
Operations

shippingmethod

Query all shipping methods
Operations

salesorder

Query all sales orders
Operations

cancellationreason

Planned

Operations

saleschannel

Get all sales channels
Operations

return

Create a new return with associated items and packages.
Operations

returnstate

Planned

Operations

returnreason

Planned

Operations

property

Query all properties for items
Operations

printer

Returns all Installed Printers
Operations

paymentmethod

Query all payment methods
Operations

onholdreason

Query all on hold reasons for sales orders
Operations

offer

Execute the printing of a Offer
Operations

Configuration

Planned

Operations

invoice

Planned

Operations

info

Returns the status of the API
Operations

features

Returns the available feature sets with release state and API version
Operations

Extensibility

Planned

Operations

deliverynote

Planned

Operations

customer

Query all customers
Operations

customerGroup

Query all customer groups
Operations

customerCategory

Query all customer categories
Operations

creditnote

Execute the printing of a CreditNote
Operations

company

Query all companies
Operations

colorcodes

Query all color codes for sales orders
Operations

category

Query all categories
Operations

appRegistration

Send a registration request for an (external) application
Operations

login

Sends a request to log in the user / dynamically assign the WAWI user. Only use this request if your API uses SSL.
Operations

logout

Sends a request to log out the user
Operations

accountingData

Planned

Operations