URL https://developer.jtl-software.com/
JTL-Software-GmbH partner@jtl-software.com
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.
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:
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.
This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, in this case "1.0.0".
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'
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/returns?customerId=0&pageNumber=0&pageSize=0&returnNumber=string&returnStateId=0&salesOrderId=0' \
-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' \
-H 'x-appid: string' \
-H 'x-appversion: string' \
-H 'x-runas: string'Returns all non-pending returns.
Gets or sets the total number of items available in the data source.
Gets or sets the collection of items contained in the paged list.
The date when the return was created.
An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward.
Indicates the origin of the return, specifying where or how the return was initiated.0=None | 1=Email | 2=Manual | 3=Phone | 4=Fax | 5=FFN | 6=SCX | 7=RestAPI
The id of the sales order if the return has exactly on corresponding sales order.
The external comment of the sales order.
The internal comment of the sales order.
Gets the total number of pages based on the total number of items and the page size.
Gets a value indicating whether there is a previous page available in the paginated list.
Gets the number of the next page if there is one; otherwise, returns the total number of pages.
{ "TotalItems": 0, "PageNumber": 0, "PageSize": 0, "Items": [ { … } ], "TotalPages": 0, "HasPreviousPage": true, "HasNextPage": true, "NextPageNumber": 0, "PreviousPageNumber": 0 }
This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, in this case "1.0.0".
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'
The details of the return to create.
The date when the return was created.
An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward.
The id of the sales order if the return has exactly on corresponding sales order.
List of items included in the return.
The comment corresponding to the return line item reason.
curl -i -X POST \
https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/returns \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-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 '{
"ReturnDate": "2023-02-01T12:45:00.0000000+00:00",
"ExternalNumber": "EX-12345",
"CompanyId": 1,
"SalesOrderId": 1643,
"WarehouseId": 1,
"ExternalComment": "a replacement is needed",
"InternalComment": "handle with care",
"Contact": "Mr. Robinson",
"Items": "",
"Packages": ""
}'The created return.
The date when the return was created.
An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward.
Indicates the origin of the return, specifying where or how the return was initiated.0=None | 1=Email | 2=Manual | 3=Phone | 4=Fax | 5=FFN | 6=SCX | 7=RestAPI
The id of the sales order if the return has exactly on corresponding sales order.
The external comment of the sales order.
{ "Id": 123, "Number": "A1004465", "ReturnDate": "2023-02-01T12:45:00.0000000+00:00", "CustomerId": 1005, "ExternalNumber": "EX-12345", "Origin": 1, "CompanyId": 1, "SalesOrderId": 1643, "StateId": 1005, "WarehouseId": 1, "ExternalComment": "a replacement is needed", "InternalComment": "handle with care", "Contact": "Mr. Robinson" }
This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, in this case "1.0.0".
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'
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/returns/{returnId}' \
-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' \
-H 'x-appid: string' \
-H 'x-appversion: string' \
-H 'x-runas: string'Returns the return for the given id.
The date when the return was created.
An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward.
Indicates the origin of the return, specifying where or how the return was initiated.0=None | 1=Email | 2=Manual | 3=Phone | 4=Fax | 5=FFN | 6=SCX | 7=RestAPI
The id of the sales order if the return has exactly on corresponding sales order.
The external comment of the sales order.
{ "Id": 123, "Number": "A1004465", "ReturnDate": "2023-02-01T12:45:00.0000000+00:00", "CustomerId": 1005, "ExternalNumber": "EX-12345", "Origin": 1, "CompanyId": 1, "SalesOrderId": 1643, "StateId": 1005, "WarehouseId": 1, "ExternalComment": "a replacement is needed", "InternalComment": "handle with care", "Contact": "Mr. Robinson" }
This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, in this case "1.0.0".
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'
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/returns/{returnId}/lineitems' \
-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' \
-H 'x-appid: string' \
-H 'x-appversion: string' \
-H 'x-runas: string'[ { "Id": 1123, "ReturnId": 12, "StateId": 1005, "ItemId": 1000, "Name": "Awesome Binoculars", "SKU": "ART2394871", "Quantity": 2, "ReturnReasonId": 13, "ReturnReasonComment": "too small", "ConditionId": 13, "ConditionComment": "broken", "SalesOrderId": 123, "SalesOrderLineItemId": 12, "DeliveryNoteLineItemId": 12 } ]
This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, in this case "1.0.0".
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'
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/returns/{returnId}/packages' \
-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' \
-H 'x-appid: string' \
-H 'x-appversion: string' \
-H 'x-runas: string'[ { "Id": 1123, "ReturnId": 12, "TrackingID": "JJD0099999999", "ShippingMethodId": 3, "ShippingMethodCustom": "DHL" } ]