JTL-Wawi REST API

JTL-WAWI API (OnPrem) (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://wawi-api.jtl-software.com/?#tag/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.

HTTP Header

To make a successful API request, it is essential to include the correct authentication data in the request header. Upper case and lower case is ignored. The header should contain the following information:

X-AppID: This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.
X-AppVersion: This is where the version number of your application is entered, in this case "1.0.0".
X-RunAs: Here, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation).
X-ChallengeCode: You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.
Authorization: The API key. Example: "Wawi 00000000-0000-00000-0000-000000000000"

Download OpenAPI description

openapi.json

openapi.yaml

Overview

URL

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

JTL-Software-GmbH

partner@jtl-software.com

Servers

Mock server

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

Local OnPremise Environment

http://127.0.0.1:64110/api/eazybusiness/

odata

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

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

salesinvoicecorrection

Development

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

Get Number Ranges

Request

Returns all available Number Ranges

Security

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/openapi/configuration/numberRanges \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The available Number Ranges

Bodyapplication/jsonArray [

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

]

Response

application/json

[
  {
    "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
    "Name": "Rechnung",
    "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
    "Prefix": "RE<j><M>",
    "CurrentNumber": 70,
    "Suffix": "-1",
    "MaxLength": 100,
    "CompanyId": 0,
    "ExampleNumber": "RE2025470-1",
    "IsDeletable": false
  }
]

Get Number Range

Request

Returns the requested NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

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/openapi/configuration/numberRanges/{numberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The requested Numberrange

Bodyapplication/json

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

Response

application/json

{
  "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
  "Name": "Rechnung",
  "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
  "Prefix": "RE<j><M>",
  "CurrentNumber": 70,
  "Suffix": "-1",
  "MaxLength": 100,
  "CompanyId": 0,
  "ExampleNumber": "RE2025470-1",
  "IsDeletable": false
}

Update Number Range

Request

Updates an Existing NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

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.

Bodyapplication/jsonrequired

The relevant Information of the NumberRange

Prefixstring

Example: "RE<j><M>"

CurrentNumberinteger(int32)

Example: 70

Suffixstring

Example: "-1"

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

curl -i -X PUT \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/configuration/numberRanges/{numberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Prefix": "RE<j><M>",
    "CurrentNumber": 70,
    "Suffix": "-1",
    "CompanyId": 0
  }'

Responses

The changed NumberRange

Bodyapplication/json

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

Response

application/json

{
  "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
  "Name": "Rechnung",
  "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
  "Prefix": "RE<j><M>",
  "CurrentNumber": 70,
  "Suffix": "-1",
  "MaxLength": 100,
  "CompanyId": 0,
  "ExampleNumber": "RE2025470-1",
  "IsDeletable": false
}

Delete Number Range

Request

Delete a NumberRange, but only Deletable Numberranges

Security

Wawi

Path

numberRangeIdstringrequired

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 DELETE \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/configuration/numberRanges/{numberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The NumberRange is deleted

Bodyapplication/json

Response

application/json

null

Number Range Increment

Request

Increment and returns the Next Number for the given NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

Query

kFirmainteger(int32)

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 POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/configuration/numberRanges/{numberRangeId}/increment?kFirma=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The resulting Next Number for the given Item.

Bodyapplication/json

NextNumberstringrequired

The Next Number of the NumberRange

Example: "RE2025470-1"

IsPreviewbooleanrequired

Can the Number is only a Preview Number

Example: false

Response

application/json

{
  "NextNumber": "RE2025470-1",
  "IsPreview": false
}

Number Range Preview

Request

Returns a Preview of the Next Number for the given NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

Query

kFirmainteger(int32)

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/openapi/configuration/numberRanges/{numberRangeId}/preview?kFirma=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The resulting Next Number for the given Item.

Bodyapplication/json

NextNumberstringrequired

The Next Number of the NumberRange

Example: "RE2025470-1"

IsPreviewbooleanrequired

Can the Number is only a Preview Number

Example: false

Response

application/json

{
  "NextNumber": "RE2025470-1",
  "IsPreview": false
}

Create Number Range

Request

Create a new NumberRange based on the given NumberRange

Security

Wawi

Path

parentNumberRangeIdstringrequired

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.

Bodyapplication/jsonrequired

The relevant Information of the NumberRange

Prefixstring

Example: "RE<j><M>"

CurrentNumberinteger(int32)

Example: 70

Suffixstring

Example: "-1"

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/configuration/numberRanges/{parentNumberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Prefix": "RE<j><M>",
    "CurrentNumber": 70,
    "Suffix": "-1",
    "CompanyId": 0
  }'

Responses

The new Created NumberRange

Bodyapplication/json

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

Response

application/json

{
  "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
  "Name": "Rechnung",
  "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
  "Prefix": "RE<j><M>",
  "CurrentNumber": 70,
  "Suffix": "-1",
  "MaxLength": 100,
  "CompanyId": 0,
  "ExampleNumber": "RE2025470-1",
  "IsDeletable": false
}

Get Number RangesDeprecated

Request

DEPRECATED: Use Versioning with Header Returns all available Number Ranges

Security

Wawi

Headers

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/openapi/v1/configuration/numberRanges \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The available Number Ranges

Bodyapplication/jsonArray [

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

]

Response

application/json

[
  {
    "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
    "Name": "Rechnung",
    "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
    "Prefix": "RE<j><M>",
    "CurrentNumber": 70,
    "Suffix": "-1",
    "MaxLength": 100,
    "CompanyId": 0,
    "ExampleNumber": "RE2025470-1",
    "IsDeletable": false
  }
]

Get Number RangeDeprecated

Request

DEPRECATED: Use Versioning with Header Returns the requested NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

Headers

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/openapi/v1/configuration/numberRanges/{numberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The requested Numberrange

Bodyapplication/json

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

Response

application/json

{
  "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
  "Name": "Rechnung",
  "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
  "Prefix": "RE<j><M>",
  "CurrentNumber": 70,
  "Suffix": "-1",
  "MaxLength": 100,
  "CompanyId": 0,
  "ExampleNumber": "RE2025470-1",
  "IsDeletable": false
}

Update Number RangeDeprecated

Request

DEPRECATED: Use Versioning with Header Updates an Existing NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

Headers

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.

Bodyapplication/jsonrequired

The relevant Information of the NumberRange

Prefixstring

Example: "RE<j><M>"

CurrentNumberinteger(int32)

Example: 70

Suffixstring

Example: "-1"

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

curl -i -X PUT \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/configuration/numberRanges/{numberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Prefix": "RE<j><M>",
    "CurrentNumber": 70,
    "Suffix": "-1",
    "CompanyId": 0
  }'

Responses

The changed NumberRange

Bodyapplication/json

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

Response

application/json

{
  "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
  "Name": "Rechnung",
  "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
  "Prefix": "RE<j><M>",
  "CurrentNumber": 70,
  "Suffix": "-1",
  "MaxLength": 100,
  "CompanyId": 0,
  "ExampleNumber": "RE2025470-1",
  "IsDeletable": false
}

Delete Number RangeDeprecated

Request

DEPRECATED: Use Versioning with Header Delete a NumberRange, but only Deletable Numberranges

Security

Wawi

Path

numberRangeIdstringrequired

Headers

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 DELETE \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/configuration/numberRanges/{numberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The NumberRange is deleted

Bodyapplication/json

Response

application/json

null

Number Range IncrementDeprecated

Request

DEPRECATED: Use Versioning with Header Increment and returns the Next Number for the given NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

Query

kFirmainteger(int32)

Headers

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 POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/configuration/numberRanges/{numberRangeId}/increment?kFirma=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The resulting Next Number for the given Item.

Bodyapplication/json

NextNumberstringrequired

The Next Number of the NumberRange

Example: "RE2025470-1"

IsPreviewbooleanrequired

Can the Number is only a Preview Number

Example: false

Response

application/json

{
  "NextNumber": "RE2025470-1",
  "IsPreview": false
}

Number Range PreviewDeprecated

Request

DEPRECATED: Use Versioning with Header Returns a Preview of the Next Number for the given NumberRange

Security

Wawi

Path

numberRangeIdstringrequired

Query

kFirmainteger(int32)

Headers

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/openapi/v1/configuration/numberRanges/{numberRangeId}/preview?kFirma=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The resulting Next Number for the given Item.

Bodyapplication/json

NextNumberstringrequired

The Next Number of the NumberRange

Example: "RE2025470-1"

IsPreviewbooleanrequired

Can the Number is only a Preview Number

Example: false

Response

application/json

{
  "NextNumber": "RE2025470-1",
  "IsPreview": false
}

Create Number RangeDeprecated

Request

DEPRECATED: Use Versioning with Header Create a new NumberRange based on the given NumberRange

Security

Wawi

Path

parentNumberRangeIdstringrequired

Headers

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.

Bodyapplication/jsonrequired

The relevant Information of the NumberRange

Prefixstring

Example: "RE<j><M>"

CurrentNumberinteger(int32)

Example: 70

Suffixstring

Example: "-1"

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/configuration/numberRanges/{parentNumberRangeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Prefix": "RE<j><M>",
    "CurrentNumber": 70,
    "Suffix": "-1",
    "CompanyId": 0
  }'

Responses

The new Created NumberRange

Bodyapplication/json

Identifierstring(uuid)(JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey)required

Namestringrequired

The Name of the Number Range

Example: "Rechnung"

Descriptionstringrequired

The Name of the Number Range

Example: "Hierbei handelt es sich um den Nummernkreis für Rechnungen"

Prefixstringrequired

The Number Prefix for the NumberRange

Example: "RE<j><M>"

CurrentNumberinteger(int32)required

The Current Number of the NumberRange

Example: 70

Suffixstringrequired

The Number Suffix for the NumberRange

Example: "-1"

MaxLengthinteger(int32)required

The Max Length of an Number Range

Example: 100

CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)

ExampleNumberstringrequired

The Example of a Number

Example: "RE2025470-1"

IsDeletablebooleanrequired

Can the Number Range be deleted

Example: false

Response

application/json

{
  "Identifier": "dc09e22f-b260-41c0-a633-8ab98e262653",
  "Name": "Rechnung",
  "Description": "Hierbei handelt es sich um den Nummernkreis für Rechnungen",
  "Prefix": "RE<j><M>",
  "CurrentNumber": 70,
  "Suffix": "-1",
  "MaxLength": 100,
  "CompanyId": 0,
  "ExampleNumber": "RE2025470-1",
  "IsDeletable": false
}

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

shipping

Development

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

appRegistration

Send a registration request for an (external) application

Operations

logout

Sends a request to log out the user

Operations

accountingData

Planned

Operations

JTL-WAWI API (OnPrem) (1.1)

Introduction

Authentication

HTTP Header

odata

worker

wms

warehouse

transactionStatus

tax

item

supplier

stock

shippingmethod

salesorder

cancellationreason

salesinvoicecorrection

saleschannel

return

returnstate

returnreason

property

printer

paymentmethod

onholdreason

offer

Configuration

Get Number Ranges

Request

Responses

Was this helpful?

Get Number Range

Request

Responses

Was this helpful?

Update Number Range

Request

Responses

Was this helpful?

Delete Number Range

Request

Responses

Was this helpful?

Number Range Increment

Request

Responses

Was this helpful?

Number Range Preview

Request

Responses

Was this helpful?

Create Number Range

Request

Responses

Was this helpful?

Get Number RangesDeprecated

Request

Responses

Was this helpful?

Get Number RangeDeprecated

Request

Responses

Was this helpful?

Update Number RangeDeprecated

Request

Responses

Was this helpful?

Delete Number RangeDeprecated

Request

Responses

Was this helpful?

Number Range IncrementDeprecated

Request

Responses

Was this helpful?

Number Range PreviewDeprecated

Request

Responses

Was this helpful?

Create Number RangeDeprecated