JTL-WAWI API (Cloud) (1.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
Languages
Servers
Mock server
https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/
https://api.jtl-cloud.com/erp/

info

Operations

features

Operations

printer

Operations

company

Operations

supplier

Operations

colorcodes

Operations

item

Operations

property

Operations

returnstate

Planned

Operations

onholdreason

Operations

returnreason

Planned

Operations

saleschannel

Operations

customerGroup

Operations

paymentmethod

Operations

odata

Operations

shippingmethod

Operations

warehouse

Operations

customerCategory

Operations

return

Operations

cancellationreason

Operations

transactionStatus

Operations

invoice

Planned

Operations

customer

Operations

category

Operations

salesorder

Operations

deliverynote

Planned

Operations

appRegistration

Operations

wms

Operations

stock

Operations

accountingData

Planned

Operations

tax

Operations

Get Tax For Item

Request

Returns the Taxrate for the given Item

Path
itemIdinteger(int32)required

The id of the Item to return.

companyIdinteger(int32)required

The id of the Company to return.

departureCountryISOstringrequired

Country ISO code of the source Country.

shipmentCountryISOstringrequired

Country ISO code of the target Country.

Query
taxNumberstring

The taxNumber of the Customer

invoiceCountryISOstring

The Country ISO Code of the Invoice

invoiceCountryStateISOstring

The State in the Country of the Invoice

shipmentCountryStateISOstring

The State in the target Country

Headers
api-versionstring

The requested API version

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/tax/item/{itemId}/{companyId}/{departureCountryISO}/{shipmentCountryISO}?invoiceCountryISO=string&invoiceCountryStateISO=string&shipmentCountryStateISO=string&taxNumber=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The TaxRate for the given Item.

Bodyapplication/json
Ratenumber(decimal)required

The given Rate

Example: 19
TaxClassIdinteger(int32)required

The ID of the tax class.

Example: 3
DepartureCountryISOstringrequired

Country ISO code of the address.

Example: "DE"
ShipmentCountryISOstringrequired

Country ISO code of the address.

Example: "DE"
Response
application/json
{ "Rate": 19, "TaxClassId": 3, "DepartureCountryISO": "DE", "ShipmentCountryISO": "DE" }

Get Tax For Tax Class

Request

Returns the Taxrate for the given Item

Path
taxClassIdinteger(int32)required

The id of the TaxClass to return.

companyIdinteger(int32)required

The id of the Company to return.

departureCountryISOstringrequired

Country ISO code of the source Country.

shipmentCountryISOstringrequired

Country ISO code of the target Country.

Query
taxNumberstring

The taxNumber of the Customer

invoiceCountryISOstring

The Country ISO Code of the Invoice

invoiceCountryStateISOstring

The State in the Country of the Invoice

shipmentCountryStateISOstring

The State in the target Country

Headers
api-versionstring

The requested API version

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/tax/taxclass/{taxClassId}/{companyId}/{departureCountryISO}/{shipmentCountryISO}?invoiceCountryISO=string&invoiceCountryStateISO=string&shipmentCountryStateISO=string&taxNumber=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The TaxRate for the given TaxClassId.

Bodyapplication/json
Ratenumber(decimal)required

The given Rate

Example: 19
TaxClassIdinteger(int32)required

The ID of the tax class.

Example: 3
DepartureCountryISOstringrequired

Country ISO code of the address.

Example: "DE"
ShipmentCountryISOstringrequired

Country ISO code of the address.

Example: "DE"
Response
application/json
{ "Rate": 19, "TaxClassId": 3, "DepartureCountryISO": "DE", "ShipmentCountryISO": "DE" }

offer

Operations

creditnote

Operations