JTL-WAWI API (Cloud) (1.1)

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/

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

info

Operations

worker

Planned

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

Configuration

Planned

Operations

deliverynote

Planned

Operations

appRegistration

Operations

login

Operations

logout

Operations

wms

Operations

Query Pick List

Request

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

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
warehouseIdinteger(int32)required

The id of the wms warehouse that the pick list belong to.

Query
pageNumberinteger(int32)

Number of the page of items to fetch.

pageSizeinteger(int32)

Size of the page that is specified by pageNumber.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/wms/{warehouseId}/picklists?pageNumber=0&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all pick lists for a given wms warehouse that are not completed.

Bodyapplication/json
TotalItemsinteger(int32)required

Gets or sets the total number of items available in the data source.

PageNumberinteger(int32)required

Gets or sets the current page number in the paginated list.

PageSizeinteger(int32)required

Gets or sets the number of items per page in the paginated list.

ItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.WMS.PickList)required

Gets or sets the collection of items contained in the paged list.

Items[].​Idinteger(int32)required

Internal unique id of the pick list. This is not the same as the pick list number.

Example: 123
Items[].​WarehouseIdinteger(int32)required

Id of the Warehouse.

Example: 1
Items[].​PicklistNumberstringrequired

Number of the pick list. This can be resetted in JTL-Wawi, but is always used for printing and showing the pick list in the UI.

Example: "Pcl01234"
Items[].​PickListTemplateIdinteger(int32)required

Id of the pick list template that created the pick list.

Example: 15
Items[].​PickListTemplateNamestringrequired

Name of the pick list template that created the pick list.

Example: "WMS default picklist"
Items[].​Statusinteger(int32)required

Status of the pick list.10=Created | 11=InProgress | 20=Picked | 30=InShippingBox | 40=Completed

Enum1011203040
Example: 10
Items[].​CreatedAtstring(date-time)required

Time when the pick list was created.

Example: "2023-01-15T13:00:00.0000000+00:00"
TotalPagesinteger(int32)read-only

Gets the total number of pages based on the total number of items and the page size.

HasPreviousPagebooleanread-only

Gets a value indicating whether there is a previous page available in the paginated list.

HasNextPagebooleanread-only

Gets a value indicating whether there is a next page available.

NextPageNumberinteger(int32)read-only

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

PreviousPageNumberinteger(int32)read-only

Gets the number of the previous page. If there is no previous page, it returns 1.

Response
application/json
{
  "TotalItems": 0,
  "PageNumber": 0,
  "PageSize": 0,
  "Items": [
    { … }
  ],
  "TotalPages": 0,
  "HasPreviousPage": true,
  "HasNextPage": true,
  "NextPageNumber": 0,
  "PreviousPageNumber": 0
}

Create Pick List

Request

Create a new pick list for a specific wms warehouse

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
warehouseIdinteger(int32)required

The id of the wms warehouse where the pick list should be created.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The relevant information to create a picking list.

PickListTemplateIdinteger(int32)required

Id of the pick list template that created the pick list.

Example: 15
curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/wms/{warehouseId}/picklists' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "PickListTemplateId": 15
  }'

Responses

Returns the created pick list.

Bodyapplication/json
Idinteger(int32)required

Internal unique id of the pick list. This is not the same as the pick list number.

Example: 123
WarehouseIdinteger(int32)required

Id of the Warehouse.

Example: 1
PicklistNumberstringrequired

Number of the pick list. This can be resetted in JTL-Wawi, but is always used for printing and showing the pick list in the UI.

Example: "Pcl01234"
PickListTemplateIdinteger(int32)required

Id of the pick list template that created the pick list.

Example: 15
PickListTemplateNamestringrequired

Name of the pick list template that created the pick list.

Example: "WMS default picklist"
Statusinteger(int32)required

Status of the pick list.10=Created | 11=InProgress | 20=Picked | 30=InShippingBox | 40=Completed

Enum1011203040
Example: 10
CreatedAtstring(date-time)required

Time when the pick list was created.

Example: "2023-01-15T13:00:00.0000000+00:00"
Response
application/json
{
  "Id": 123,
  "WarehouseId": 1,
  "PicklistNumber": "Pcl01234",
  "PickListTemplateId": 15,
  "PickListTemplateName": "WMS default picklist",
  "Status": 10,
  "CreatedAt": "2023-01-15T13:00:00.0000000+00:00"
}

Query Pick List Position

Request

Query all positions for a given pick list

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
warehouseIdinteger(int32)required

The id of the wms warehouse that the pick list belong to.

picklistIdinteger(int32)required

The id of the pick list.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

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

Responses

Returns all pick lists positions for an given pick list.

Bodyapplication/jsonArray [
Idinteger(int32)required

Id of the pick list position.

Example: 100
WarehouseIdinteger(int32)required

Id of the warehouse.

Example: 1
PicklistIdinteger(int32)required

Id of the pick list.

Example: 123
StorageLocationIdinteger(int32)required

Id of the storage location from where the pick should happen.

Example: 654
ItemIdinteger(int32)required

Id of the item.

Example: 1000
Quantitynumber(decimal)required

Quantity to pick.

Example: 2
Statusinteger(int32)required

Status of the position.10=Created | 11=InProgress | 20=Picked | 30=InShippingBox | 40=Completed

Enum1011203040
Example: 10
Priorityinteger(int32)required

Priority of the position.

Example: 3
SalesOrderLineItemIdinteger(int32)required

Id of the corresponding order position.

Example: 50
CreatedAtstring(date-time)required

Time when the pick list was created.

Example: "2023-01-15T13:00:00.0000000+00:00"
]
Response
application/json
[
  {
    "Id": 100,
    "WarehouseId": 1,
    "PicklistId": 123,
    "StorageLocationId": 654,
    "ItemId": 1000,
    "Quantity": 2,
    "Status": 10,
    "Priority": 3,
    "SalesOrderLineItemId": 50,
    "CreatedAt": "2023-01-15T13:00:00.0000000+00:00"
  }
]

Query Pick List Template

Request

Query all pick list templates. A pick list template is used for creating a new pick list.

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Query
pageNumberinteger(int32)

Number of the page of items to fetch.

pageSizeinteger(int32)

Size of the page that is specified by pageNumber.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

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

Responses

Returns all pick lists templates.

Bodyapplication/json
TotalItemsinteger(int32)required

Gets or sets the total number of items available in the data source.

PageNumberinteger(int32)required

Gets or sets the current page number in the paginated list.

PageSizeinteger(int32)required

Gets or sets the number of items per page in the paginated list.

ItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.WMS.PickListTemplate)required

Gets or sets the collection of items contained in the paged list.

Items[].​PickListTemplateIdinteger(int32)required

Id of the pick list template.

Example: 2
Items[].​Namestringrequired

Name of the pick list template.

Example: "WMS default picklist"
TotalPagesinteger(int32)read-only

Gets the total number of pages based on the total number of items and the page size.

HasPreviousPagebooleanread-only

Gets a value indicating whether there is a previous page available in the paginated list.

HasNextPagebooleanread-only

Gets a value indicating whether there is a next page available.

NextPageNumberinteger(int32)read-only

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

PreviousPageNumberinteger(int32)read-only

Gets the number of the previous page. If there is no previous page, it returns 1.

Response
application/json
{
  "TotalItems": 0,
  "PageNumber": 0,
  "PageSize": 0,
  "Items": [
    { … }
  ],
  "TotalPages": 0,
  "HasPreviousPage": true,
  "HasNextPage": true,
  "NextPageNumber": 0,
  "PreviousPageNumber": 0
}

stock

Operations

accountingData

Planned

Operations

tax

Operations

shipping

Development

offer

Operations

creditnote

Operations