URL
JTL-Software-GmbH
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.
https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/
https://api.jtl-cloud.com/erp/
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'
https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker
https://api.jtl-cloud.com/erp/worker
curl -i -X GET \
https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker \
-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'The TaxRate for the given Item.
The Unique Identifier of a Sync
The Configurations
The Unique Identifier of a Config
The Display Description of a Setting
[ { "Identifier": "3f54a9ef-f644-4bbb-a6cd-1f57fcae2c85", "SyncName": "Ebay", "SalesChannelName": "Shop", "SalesChannelId": "1-1-1", "Interval": "00:05:00", "ReportProgress": false, "Configurations": [ … ] } ]
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 Information to Control the Sync
https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker/{syncId}
https://api.jtl-cloud.com/erp/worker/{syncId}
curl -i -X PUT \
'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker/{syncId}' \
-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 '{
"Action": 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 relevant Information of the Sync Item
https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker/{syncId}
https://api.jtl-cloud.com/erp/worker/{syncId}
curl -i -X POST \
'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker/{syncId}' \
-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 '{
"Interval": "00:05:00",
"Configs": [
{
"Identifier": "3f54a9ef-f644-4bbb-a6cd-1f57fcae2c85",
"Value": "true"
}
]
}'The changed Worker Configuration
The Unique Identifier of a Sync
The Configurations
The Unique Identifier of a Config
The Display Description of a Setting
{ "Identifier": "3f54a9ef-f644-4bbb-a6cd-1f57fcae2c85", "SyncName": "Ebay", "SalesChannelName": "Shop", "SalesChannelId": "1-1-1", "Interval": "00:05:00", "ReportProgress": false, "Configurations": [ { … } ] }
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'
https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker/status
https://api.jtl-cloud.com/erp/worker/status
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/worker/status?syncId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
-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'The Status Elements of the Worker
The Unique Identifier of a Sync
The current State of Sync0=Suspended | 1=Starting | 2=Running | 3=SuccessfullFinished | 4=SleepingError | 5=Stopping | 6=SleepingErrorGesperrt | 7=Deactivated
[ { "Identifier": "3f54a9ef-f644-4bbb-a6cd-1f57fcae2c85", "State": "Running", "ProgressText": "", "Progress": 0, "LastSync": "2023-02-01T12:45:00.0000000+00:00", "NextSync": "2023-02-01T12:45:00.0000000+00:00" } ]