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'.
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/availabilities
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/availabilities
- 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/availabilities \
-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, "Name": "In Stock" } ]
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/conditions
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/conditions
- 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/conditions \
-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, "Names": [ … ] } ]
A search key word which is using many important item identificators. For more info see documentation or the configuration in the search in items in JTL-Wawi.
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/items
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/items
- 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/items?searchKeyWord=string&kKategorie=0&kHersteller=0&kArtikel=0&changedSince=2019-08-24T14%3A15%3A22Z&isActiveOnSalesChannelId=string&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 items, can be filtered by searchKeyWord and postalCode.
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.
Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically.
List of all the categories for the item.
Name of the item in the default language in JTL-Wawi.
Full textdescription for the item
Short description of the item in the default language in JTL-Wawi.
Model Class: ItemIdentifiers
A list of the item's ASINs.
Components for the item if the item is a bill of material.
Quantity of the component in the bill of material.
IDs of the child items, if the item is a parent item.
Model Class: ItemPrice
The net sales price of the item.
The suggested retail price for the item.
The purchase price of the item.
Default price in new listing templates.
The list of active sales channels of the item. Only online shops and JTL-POS are permitted. Sales channels that are removed from this list will be deactivated for this item.
The sort number of the item, used in some sales channels for ordering items.
The item annotation.
Date when the item was added to the system.
Date of the last change made to the item. Only item data changes are relevant for this field, not changes in stock.
The date when the item was put up for sale.
Model Class: ItemStorageOption
Indicates if inventory management for the item is active, meaning that the item displays stock quantities.
Indicates if the item can be split into quantities less than 1.
Defines the minimum quantity that should always be in stock. For example, when calculating purchasing orders.
The buffer of the item. Used when selling time-delayed across different sales channels, so as not to sell more than is in stock.
Indicates the item's serial number when shipping the sales orders.
Indicates if serial numbers are to be identified during a goods receipt process from a supplier.
Indicates if the item has an expiration date, also known as a best before date.
Indicates whether the item is a batch item or not.
The procurement time indicates how many days it will take for the goods to be ready for shipment if they are currently out of stock. Procurement time is determined automatically on the basis of the supplier’s delivery time. By default, the delivery time of the default supplier is used as the procurement time. If additional processing time (in days) has been specified, this is added to the procurement time.
If this option is set, the procurement time will be calculated from the default supplier's shipment time.
Model Class: Dimensions
Model Class: ItemWeights
This option allows you to sell a higher quantity of the item than is actually in stock.
Model Class: ItemQuantities
The minimum order quantity of the item.
A collection of minimum order quantities for different customer groups.
The permissible order quantity for the item. Indicates the increments in which the item is sold.
Model Class: ItemDangerousGoods
Search terms for the item.
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 }