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/deliveryNotes?customerId=0&pageNumber=0&pageSize=0&salesOrderNumber=string&salesOrderNumberId=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 delivery notes.
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 delivery note was created.
All packages that are created with the delivery note.
The date when the package was created.
The tracking Id of the package.
The shipping method of the package.
The date when the package was shipped.
The tracking url of the package.
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'
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/deliveryNotes/{deliveryNoteId}' \
-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 delivery note for the given id.
The date when the delivery note was created.
All packages that are created with the delivery note.
The date when the package was created.
The date when the package was shipped.
The tracking url of the package.
{ "Id": 123, "Number": "A1004465", "DeliveryNoteDate": "2023-02-01T12:45:00.0000000+00:00", "Packages": "" }
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 POST \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/deliveryNotes/{deliveryNoteId}/output/mail?formId=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'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 POST \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/deliveryNotes/{deliveryNoteId}/output/pdf?formId=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'"string"
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 POST \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/deliveryNotes/{deliveryNoteId}/output/print?formId=0&printer=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' \
-H 'x-appid: string' \
-H 'x-appversion: string' \
-H 'x-runas: string'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/deliveryNotes/{deliveryNoteId}/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'Returns the delivery note for the given id.
The date when the package was created.
The date when the package was shipped.
The tracking url of the package.
[ { "Id": 65475, "PackageDate": "2023-02-01T12:45:00.0000000+00:00", "TrackingID": "JJD0099999999", "Weights": 5, "ShippingMethodId": 3, "ShippedDate": "2023-02-01T12:45:00.0000000+00:00", "TrackingUrl": "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999", "Comment": "Shipping Comment" } ]
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 Packages to Create
The date when the package was shipped.
curl -i -X POST \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/deliveryNotes/{deliveryNoteId}/packages' \
-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 '[
{
"ShippedDate": "2023-02-01T12:45:00.0000000+00:00",
"TrackingID": "JJD0099999999",
"Comment": "Shipping Comment"
}
]'Returns All packages that are created for the delivery note.
The date when the package was created.
The date when the package was shipped.
The tracking url of the package.
[ { "Id": 65475, "PackageDate": "2023-02-01T12:45:00.0000000+00:00", "TrackingID": "JJD0099999999", "Weights": 5, "ShippingMethodId": 3, "ShippedDate": "2023-02-01T12:45:00.0000000+00:00", "TrackingUrl": "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999", "Comment": "Shipping Comment" } ]
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 POST \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/deliveryNotes/{deliveryNoteId}/workflow/{workflowEventId}' \
-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'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 Package to update
The date when the package was shipped.
curl -i -X PATCH \
'https://developer.jtl-software.com/_mock/products/erpapi/1.0-cloud/openapi/deliveryNotes/packages/{packageId}' \
-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 '{
"ShippedDate": "2023-02-01T12:45:00.0000000+00:00",
"TrackingID": "JJD0099999999",
"Comment": "Shipping Comment"
}'Returns the package that are created for the delivery note.
The date when the package was created.
The date when the package was shipped.
The tracking url of the package.
{ "Id": 65475, "PackageDate": "2023-02-01T12:45:00.0000000+00:00", "TrackingID": "JJD0099999999", "Weights": 5, "ShippingMethodId": 3, "ShippedDate": "2023-02-01T12:45:00.0000000+00:00", "TrackingUrl": "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999", "Comment": "Shipping Comment" }