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/
Search for a specific payment status.
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/salesOrders
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/salesOrders
- 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/salesOrders?salesOrderNumber=string&externalOrderNumber=string&billingNumber=string&kArtikel=0&kKunde=0&IsExisting=true&paymentStatus=0&kZahlungsart=0&deliveryCompleteStatus=0&kBenutzer=0&kFirma=0&salesChannelId=string&createdSince=2019-08-24T14%3A15%3A22Z&createdUntil=2019-08-24T14%3A15%3A22Z&kFarbe=0&ebayUsername=string&kVersandart=0&deliveredDate=2019-08-24T14%3A15%3A22Z&isCancelled=true&kRueckhalteGrund=0&isExternalInvoice=true&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 sales orders.
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 external number of the sales order.
Model Class: DepartureCountry
Name of the state in the departure country.
ISO code of the currency of the departure country.
Model Class: Address
Description of the Company.
Additional company information
Street name in the customer's address
Additional address information
Postal code of the customer's address
Name of city in the customer's address
Name of state in the customer's address
Landline phone number
Mobile phone number
Model Class: Address
Description of the Company.
Additional company information
Street name in the customer's address
Additional address information
Postal code of the customer's address
Name of city in the customer's address
Name of state in the customer's address
Landline phone number
Mobile phone number
The date when the order was created.
Model Class: SalesOrderPaymentDetail
0 = UnPayed, 1 = PartialPayed, 2 = Payed
The total gross amount of the sales order.
ISO code of the currency of the sales order.
The currency factor in the order at the time the order is created.
Date of payment that paid off the sales order.
The amount that is left to pay for this sales order.
The payment target of the sales order in days.
The cash discount of the sales order.
Model Class: SalesOrderShippingDetail
0 = DeliveryNotComplete, 1 = DeliveryComplete, 2 = DeliveryCompleteWithoutNote
The shipping priority of the sales order.
The notified shipping date of the sales order.
The estimated delivery date of the sales order.
The date when the sales order was delivered.
Indicates if the invoice of the order was created in an external system, like Amazon VCS.
A customer comment on the sales order.
Indicates if the order has been cancelled. There is a special endpoint for cancelling sales orders.
Model Class: SalesOrderCancellationDetails
A comment that adds further information to the cancellation.
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'.
The sales order to create.
Model Class: CreateDepartureCountry
Model Class: CreateAddress
Model Class: CreateAddress
Model Class: CreateSalesOrderPaymentDetail
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/salesOrders
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/salesOrders
- 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/salesOrders?renameSalesOrderNumberWhenAlreadyExists=true&disableAutomaticWorkflows=true' \
-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 '{
"Number": "A1004465",
"ExternalNumber": "D456-64894-132",
"BillingNumber": "RE-202404-10000",
"CompanyId": 0,
"DepartureCountry": {
"CountryISO": "DE",
"State": "Berlin",
"CurrencyIso": "EUR",
"CurrencyFactor": 1
},
"CustomerId": 0,
"CustomerVatID": "DE12345",
"BillingAddress": {
"Company": "Sportbedarf Sommer",
"Company2": "Innovation Division",
"FormOfAddress": "Mr.",
"Title": "Dr.",
"FirstName": "John",
"LastName": "Doe",
"Street": "Main St. 123",
"Address2": "Floor 5, Apt 302",
"PostalCode": "12345",
"City": "Example City",
"State": "Example State",
"CountryIso": "DE",
"VatID": "DE123456789",
"PhoneNumber": "+49 1234 445556661",
"MobilePhoneNumber": "+49 160 123 4567",
"EmailAddress": "example@email.com",
"Fax": "+49 1234 4455566615"
},
"Shipmentaddress": {
"Company": "Sportbedarf Sommer",
"Company2": "Innovation Division",
"FormOfAddress": "Mr.",
"Title": "Dr.",
"FirstName": "John",
"LastName": "Doe",
"Street": "Main St. 123",
"Address2": "Floor 5, Apt 302",
"PostalCode": "12345",
"City": "Example City",
"State": "Example State",
"CountryIso": "DE",
"VatID": "DE123456789",
"PhoneNumber": "+49 1234 445556661",
"MobilePhoneNumber": "+49 160 123 4567",
"EmailAddress": "example@email.com",
"Fax": "+49 1234 4455566615"
},
"SalesOrderDate": "2023-02-01T12:45:00.0000000+00:00",
"SalesOrderPaymentDetails": {
"PaymentMethodId": 0,
"CurrencyIso": "EUR",
"CurrencyFactor": 1,
"PaymentTarget": 0,
"CashDiscount": 5,
"CashDiscountDays": 2
},
"SalesOrderShippingDetail": {
"ShippingMethodId": 0,
"ShippingPriority": 5,
"ShippingDate": "2023-01-15T13:00:00.0000000+00:00",
"EstimatedDeliveryDate": "2023-01-16T13:00:00.0000000+00:00",
"OnHoldReasonId": 0,
"ExtraWeight": 0.1
},
"ColorcodeId": 0,
"Comment": "an additional order comment",
"CustomerComment": "an additional customer comment",
"LanguageIso": "DE"
}'The created sales order.
Model Class: DepartureCountry
ISO code of the currency of the departure country.
Model Class: Address
Model Class: Address
Additional company information
Name of state in the customer's address
The date when the order was created.
Model Class: SalesOrderPaymentDetail
0 = UnPayed, 1 = PartialPayed, 2 = Payed
The total gross amount of the sales order.
ISO code of the currency of the sales order.
The currency factor in the order at the time the order is created.
Date of payment that paid off the sales order.
The amount that is left to pay for this sales order.
The payment target of the sales order in days.
The cash discount of the sales order.
Model Class: SalesOrderShippingDetail
0 = DeliveryNotComplete, 1 = DeliveryComplete, 2 = DeliveryCompleteWithoutNote
The shipping priority of the sales order.
The notified shipping date of the sales order.
The estimated delivery date of the sales order.
The date when the sales order was delivered.
Indicates if the invoice of the order was created in an external system, like Amazon VCS.
A customer comment on the sales order.
Indicates if the order has been cancelled. There is a special endpoint for cancelling sales orders.
Model Class: SalesOrderCancellationDetails
A comment that adds further information to the cancellation.
{ "Id": 0, "Number": "A1004465", "ExternalNumber": "D456-64894-132", "BillingNumber": "RE-202404-10000", "CompanyId": 0, "DepartureCountry": { "CountryISO": "DE", "State": "Berlin", "CurrencyIso": "EUR", "CurrencyFactor": 1 }, "CustomerId": 0, "CustomerVatID": "DE12345", "MerchantVatID": "DE12345", "BillingAddress": { "Id": 0, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "Shipmentaddress": { "Id": 0, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "SalesOrderDate": "2023-02-01T12:45:00.0000000+00:00", "SalesOrderPaymentDetails": { "PaymentMethodId": 0, "PaymentStatus": 0, "TotalGrossAmount": 19.99, "CurrencyIso": "EUR", "CurrencyFactor": 1, "DateOfPayment": "2023-01-15T13:00:00.0000000+00:00", "StillToPay": 0, "PaymentTarget": 0, "CashDiscount": 5, "CashDiscountDays": 2 }, "SalesOrderShippingDetail": { "ShippingMethodId": 0, "DeliveryCompleteStatus": 0, "ShippingPriority": 5, "ShippingDate": "2023-01-15T13:00:00.0000000+00:00", "EstimatedDeliveryDate": "2023-01-16T13:00:00.0000000+00:00", "DeliveredDate": "2023-01-15T13:00:00.0000000+00:00", "OnHoldReasonId": 0, "ExtraWeight": 0.1 }, "ColorcodeId": 0, "IsExternalInvoice": false, "Comment": "an additional order comment", "CustomerComment": "an additional customer comment", "IsCancelled": false, "LanguageIso": "DE", "CancellationDetails": { "CancellationReasonId": 0, "CancellationComment": "Change of mind (once again); we should consider terminating the customer relationship", "Date": "2023-02-01T12:45:00.0000000+00:00" }, "SalesChannelId": "1-1-1", "UserCreatedId": 0, "UserId": 0, "TransactionStatusId": 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/salesOrders/{salesOrderId}
- Local OnPremise Environment
http://127.0.0.1:64110/api/eazybusiness/salesOrders/{salesOrderId}
- 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/salesOrders/{salesOrderId}' \
-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 sales order for the given id.
Model Class: DepartureCountry
ISO code of the currency of the departure country.
Model Class: Address
Model Class: Address
Additional company information
Name of state in the customer's address
The date when the order was created.
Model Class: SalesOrderPaymentDetail
0 = UnPayed, 1 = PartialPayed, 2 = Payed
The total gross amount of the sales order.
ISO code of the currency of the sales order.
The currency factor in the order at the time the order is created.
Date of payment that paid off the sales order.
The amount that is left to pay for this sales order.
The payment target of the sales order in days.
The cash discount of the sales order.
Model Class: SalesOrderShippingDetail
0 = DeliveryNotComplete, 1 = DeliveryComplete, 2 = DeliveryCompleteWithoutNote
The shipping priority of the sales order.
The notified shipping date of the sales order.
The estimated delivery date of the sales order.
The date when the sales order was delivered.
Indicates if the invoice of the order was created in an external system, like Amazon VCS.
A customer comment on the sales order.
Indicates if the order has been cancelled. There is a special endpoint for cancelling sales orders.
Model Class: SalesOrderCancellationDetails
A comment that adds further information to the cancellation.
{ "Id": 0, "Number": "A1004465", "ExternalNumber": "D456-64894-132", "BillingNumber": "RE-202404-10000", "CompanyId": 0, "DepartureCountry": { "CountryISO": "DE", "State": "Berlin", "CurrencyIso": "EUR", "CurrencyFactor": 1 }, "CustomerId": 0, "CustomerVatID": "DE12345", "MerchantVatID": "DE12345", "BillingAddress": { "Id": 0, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "Shipmentaddress": { "Id": 0, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "SalesOrderDate": "2023-02-01T12:45:00.0000000+00:00", "SalesOrderPaymentDetails": { "PaymentMethodId": 0, "PaymentStatus": 0, "TotalGrossAmount": 19.99, "CurrencyIso": "EUR", "CurrencyFactor": 1, "DateOfPayment": "2023-01-15T13:00:00.0000000+00:00", "StillToPay": 0, "PaymentTarget": 0, "CashDiscount": 5, "CashDiscountDays": 2 }, "SalesOrderShippingDetail": { "ShippingMethodId": 0, "DeliveryCompleteStatus": 0, "ShippingPriority": 5, "ShippingDate": "2023-01-15T13:00:00.0000000+00:00", "EstimatedDeliveryDate": "2023-01-16T13:00:00.0000000+00:00", "DeliveredDate": "2023-01-15T13:00:00.0000000+00:00", "OnHoldReasonId": 0, "ExtraWeight": 0.1 }, "ColorcodeId": 0, "IsExternalInvoice": false, "Comment": "an additional order comment", "CustomerComment": "an additional customer comment", "IsCancelled": false, "LanguageIso": "DE", "CancellationDetails": { "CancellationReasonId": 0, "CancellationComment": "Change of mind (once again); we should consider terminating the customer relationship", "Date": "2023-02-01T12:45:00.0000000+00:00" }, "SalesChannelId": "1-1-1", "UserCreatedId": 0, "UserId": 0, "TransactionStatusId": 0 }