JTL-WAWI API (OnPrem) (1.1)
JTL-Wawi-Version: 1.11.0.0
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://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.
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"
https://developer.jtl-software.com/_mock/products/erpapi/openapi/
http://127.0.0.1:64110/api/eazybusiness/
Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.
This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, e.g. "1.0.0".
The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.
The details of the return to create.
List of items included in the return.
The quantity of the line item.
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/returns
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns \
-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 '{
"ReturnDate": "2023-02-01T12:45:00.0000000+00:00",
"ExternalNumber": "EX-12345",
"CompanyId": 0,
"SalesOrderId": 0,
"WarehouseId": 0,
"ExternalComment": "a replacement is needed",
"InternalComment": "handle with care",
"Contact": "Mr. Robinson",
"Items": [
{
"Quantity": 2,
"ReturnReasonId": 0,
"ReturnReasonComment": "too small",
"SalesOrderLineItemId": 0,
"DeliveryNoteLineItemId": 0
}
],
"Packages": [
{
"TrackingID": "JJD0099999999",
"ShippingMethodId": 0,
"ShippingMethodCustom": "DHL"
}
]
}'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.
0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI
The external comment of the sales order.
{ "Id": 0, "Number": "A1004465", "ReturnDate": "2023-02-01T12:45:00.0000000+00:00", "CustomerId": 0, "ExternalNumber": "EX-12345", "Origin": 0, "CompanyId": 0, "SalesOrderId": 0, "StateId": 0, "WarehouseId": 0, "ExternalComment": "a replacement is needed", "InternalComment": "handle with care", "Contact": "Mr. Robinson" }
Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.
This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, e.g. "1.0.0".
The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/returns
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns?returnNumber=string&kKunde=0&IsExisting=true&kAuftrag=0&kRMStatus=0&pageNumber=0&pageSize=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'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.
0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI
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 }
Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.
This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, e.g. "1.0.0".
The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns/{returnId}
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/returns/{returnId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns/{returnId}' \
-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'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.
0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI
The external comment of the sales order.
{ "Id": 0, "Number": "A1004465", "ReturnDate": "2023-02-01T12:45:00.0000000+00:00", "CustomerId": 0, "ExternalNumber": "EX-12345", "Origin": 0, "CompanyId": 0, "SalesOrderId": 0, "StateId": 0, "WarehouseId": 0, "ExternalComment": "a replacement is needed", "InternalComment": "handle with care", "Contact": "Mr. Robinson" }
Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.
This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, e.g. "1.0.0".
The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns/{returnId}/lineitems
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/returns/{returnId}/lineitems
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns/{returnId}/lineitems' \
-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'[ { "Id": 0, "ReturnId": 0, "StateId": 0, "ItemId": 0, "Name": "Awesome Binoculars", "SKU": "ART2394871", "Quantity": 2, "ReturnReasonId": 0, "ReturnReasonComment": "too small", "ConditionId": 0, "ConditionComment": "broken", "SalesOrderId": 0, "SalesOrderLineItemId": 0, "DeliveryNoteLineItemId": 0 } ]
Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.
This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, e.g. "1.0.0".
The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns/{returnId}/packages
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/returns/{returnId}/packages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/returns/{returnId}/packages' \
-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'[ { "Id": 0, "ReturnId": 0, "TrackingID": "JJD0099999999", "ShippingMethodId": 0, "ShippingMethodCustom": "DHL" } ]
This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.
This is where the version number of your application is entered, e.g. "1.0.0".
The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.
The details of the return to create.
List of items included in the return.
The quantity of the line item.
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/v1/returns
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns \
-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 '{
"ReturnDate": "2023-02-01T12:45:00.0000000+00:00",
"ExternalNumber": "EX-12345",
"CompanyId": 0,
"SalesOrderId": 0,
"WarehouseId": 0,
"ExternalComment": "a replacement is needed",
"InternalComment": "handle with care",
"Contact": "Mr. Robinson",
"Items": [
{
"Quantity": 2,
"ReturnReasonId": 0,
"ReturnReasonComment": "too small",
"SalesOrderLineItemId": 0,
"DeliveryNoteLineItemId": 0
}
],
"Packages": [
{
"TrackingID": "JJD0099999999",
"ShippingMethodId": 0,
"ShippingMethodCustom": "DHL"
}
]
}'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.
0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI
The external comment of the sales order.
{ "Id": 0, "Number": "A1004465", "ReturnDate": "2023-02-01T12:45:00.0000000+00:00", "CustomerId": 0, "ExternalNumber": "EX-12345", "Origin": 0, "CompanyId": 0, "SalesOrderId": 0, "StateId": 0, "WarehouseId": 0, "ExternalComment": "a replacement is needed", "InternalComment": "handle with care", "Contact": "Mr. Robinson" }
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/v1/returns
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns?returnNumber=string&kKunde=0&IsExisting=true&kAuftrag=0&kRMStatus=0&pageNumber=0&pageSize=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'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.
0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI
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 }
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns/{returnId}
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/v1/returns/{returnId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns/{returnId}' \
-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'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.
0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI
The external comment of the sales order.
{ "Id": 0, "Number": "A1004465", "ReturnDate": "2023-02-01T12:45:00.0000000+00:00", "CustomerId": 0, "ExternalNumber": "EX-12345", "Origin": 0, "CompanyId": 0, "SalesOrderId": 0, "StateId": 0, "WarehouseId": 0, "ExternalComment": "a replacement is needed", "InternalComment": "handle with care", "Contact": "Mr. Robinson" }
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns/{returnId}/lineitems
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/v1/returns/{returnId}/lineitems
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns/{returnId}/lineitems' \
-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'[ { "Id": 0, "ReturnId": 0, "StateId": 0, "ItemId": 0, "Name": "Awesome Binoculars", "SKU": "ART2394871", "Quantity": 2, "ReturnReasonId": 0, "ReturnReasonComment": "too small", "ConditionId": 0, "ConditionComment": "broken", "SalesOrderId": 0, "SalesOrderLineItemId": 0, "DeliveryNoteLineItemId": 0 } ]
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns/{returnId}/packages
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/v1/returns/{returnId}/packages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/returns/{returnId}/packages' \
-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'[ { "Id": 0, "ReturnId": 0, "TrackingID": "JJD0099999999", "ShippingMethodId": 0, "ShippingMethodCustom": "DHL" } ]