Planned
JTL-WAWI API (OnPrem) (1.2)
JTL-Wawi-Version: 1.12.0-alpha.14636
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"
Download OpenAPI description
Overview
URL
JTL-Software-GmbH
Languages
Servers
Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/
Local OnPremise Environment
http://127.0.0.1:5883/api/eazybusiness/
Headers
Bodyapplication/jsonrequiredThis 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 customer to create.
Model Class: CreateAddress
Model Class: CreateAddress
Model Class: CreateAddress
Model Class: CreateOtherAddresses
Model Class: CreatePaymentSettings
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/customers
- Local OnPremise Environment
http://127.0.0.1:5883/api/eazybusiness/v1/customers
- 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/customers?disableAutomaticWorkflows=true' \
-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 '{
"number": "string",
"customerGroupId": 0,
"billingAddress": {
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "strin",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
},
"shipmentaddress": {
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "strin",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
},
"customAddress": {
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "strin",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
},
"otherAddresses": {
"otherBillingAddresses": [
{
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "strin",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
}
],
"otherShippingAddresses": [
{
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "strin",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
}
],
"otherCustomerAddresses": [
{
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "strin",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
}
]
},
"paymentSettings": {
"paymentMethodId": 0,
"discount": 0,
"paymentTarget": 0,
"creditLimit": 0,
"stopPaymentRequest": true
},
"customerSince": "2019-08-24T14:15:22Z",
"lastChange": "2019-08-24T14:15:22Z",
"languageIso": "string",
"internalCompanyId": 0,
"customerCategoryId": 0,
"taxIdentificationNumber": "string",
"accountsReceivableNumber": 0,
"commercialRegisterNumber": "string",
"website": "string",
"initialContact": "string",
"ebayUsername": "string",
"birthday": "2019-08-24T14:15:22Z",
"isLocked": true,
"isCashRegisterBased": true
}'The created customer.
Model Class: Address
Model Class: Address
Model Class: Address
Model Class: OtherAddresses
otherAddresses.otherBillingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required
All other non-default billing addresses of the customer.
Postal code of the customer's address
otherAddresses.otherShippingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required
All other non-default shipping addresses of the customer.
Postal code of the customer's address
Name of state in the customer's address
Model Class: PaymentSettings
The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.
Response
application/json
{ "id": 0, "number": "string", "customerGroupId": 0, "billingAddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "shipmentaddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "customAddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "otherAddresses": { "otherBillingAddresses": [ … ], "otherShippingAddresses": [ … ], "otherCustomerAddresses": [ … ] }, "paymentSettings": { "paymentMethodId": 0, "discount": 0, "paymentTarget": 0, "creditLimit": 0, "stopPaymentRequest": true }, "customerSince": "2019-08-24T14:15:22Z", "lastChange": "2019-08-24T14:15:22Z", "languageIso": "string", "internalCompanyId": 0, "customerCategoryId": 0, "taxIdentificationNumber": "string", "accountsReceivableNumber": 0, "commercialRegisterNumber": "string", "website": "string", "initialContact": "string", "ebayUsername": "string", "birthday": "2019-08-24T14:15:22Z", "isLocked": true, "isCashRegisterBased": true }
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/customers/{customerId}
- Local OnPremise Environment
http://127.0.0.1:5883/api/eazybusiness/v1/customers/{customerId}
- 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/customers/{customerId}' \
-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 customer for the given id.
Model Class: Address
Model Class: Address
Model Class: Address
Model Class: OtherAddresses
otherAddresses.otherBillingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required
All other non-default billing addresses of the customer.
Postal code of the customer's address
otherAddresses.otherShippingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required
All other non-default shipping addresses of the customer.
Postal code of the customer's address
Name of state in the customer's address
Model Class: PaymentSettings
The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.
Response
application/json
{ "id": 0, "number": "string", "customerGroupId": 0, "billingAddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "shipmentaddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "customAddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "otherAddresses": { "otherBillingAddresses": [ … ], "otherShippingAddresses": [ … ], "otherCustomerAddresses": [ … ] }, "paymentSettings": { "paymentMethodId": 0, "discount": 0, "paymentTarget": 0, "creditLimit": 0, "stopPaymentRequest": true }, "customerSince": "2019-08-24T14:15:22Z", "lastChange": "2019-08-24T14:15:22Z", "languageIso": "string", "internalCompanyId": 0, "customerCategoryId": 0, "taxIdentificationNumber": "string", "accountsReceivableNumber": 0, "commercialRegisterNumber": "string", "website": "string", "initialContact": "string", "ebayUsername": "string", "birthday": "2019-08-24T14:15:22Z", "isLocked": true, "isCashRegisterBased": true }
Headers
Bodyapplication/jsonrequiredThis 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 customer to update.
Model Class: UpdateAddress
Model Class: UpdateAddress
Model Class: UpdateAddress
Model Class: UpdateOtherAddresses
Model Class: UpdatePaymentSettings
- Mock server
https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/customers/{customerId}
- Local OnPremise Environment
http://127.0.0.1:5883/api/eazybusiness/v1/customers/{customerId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/customers/{customerId}?disableAutomaticWorkflows=true' \
-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 '{
"number": "string",
"customerGroupId": 0,
"billingAddress": {
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "string",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
},
"shipmentaddress": {
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "string",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
},
"customAddress": {
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "string",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
},
"otherAddresses": {
"otherBillingAddresses": [
{
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "string",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
}
],
"otherShippingAddresses": [
{
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "string",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
}
],
"otherCustomerAddresses": [
{
"company": "string",
"company2": "string",
"formOfAddress": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"address2": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"countryIso": "string",
"vatID": "string",
"phoneNumber": "string",
"mobilePhoneNumber": "string",
"emailAddress": "string",
"fax": "string"
}
]
},
"paymentSettings": {
"paymentMethodId": 0,
"discount": 0,
"paymentTarget": 0,
"creditLimit": 0,
"stopPaymentRequest": true
},
"customerSince": "2019-08-24T14:15:22Z",
"lastChange": "2019-08-24T14:15:22Z",
"languageIso": "string",
"internalCompanyId": 0,
"customerCategoryId": 0,
"taxIdentificationNumber": "string",
"accountsReceivableNumber": 0,
"commercialRegisterNumber": "string",
"website": "string",
"initialContact": "string",
"ebayUsername": "string",
"birthday": "2019-08-24T14:15:22Z",
"isLocked": true,
"isCashRegisterBased": true
}'The updated customer.
Model Class: Address
Model Class: Address
Model Class: Address
Model Class: OtherAddresses
otherAddresses.otherBillingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required
All other non-default billing addresses of the customer.
Postal code of the customer's address
otherAddresses.otherShippingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required
All other non-default shipping addresses of the customer.
Postal code of the customer's address
Name of state in the customer's address
Model Class: PaymentSettings
The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.
Response
application/json
{ "id": 0, "number": "string", "customerGroupId": 0, "billingAddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "shipmentaddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "customAddress": { "id": 0, "company": "string", "company2": "string", "formOfAddress": "string", "title": "string", "firstName": "string", "lastName": "string", "street": "string", "address2": "string", "postalCode": "string", "city": "string", "state": "string", "countryIso": "string", "vatID": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "fax": "string" }, "otherAddresses": { "otherBillingAddresses": [ … ], "otherShippingAddresses": [ … ], "otherCustomerAddresses": [ … ] }, "paymentSettings": { "paymentMethodId": 0, "discount": 0, "paymentTarget": 0, "creditLimit": 0, "stopPaymentRequest": true }, "customerSince": "2019-08-24T14:15:22Z", "lastChange": "2019-08-24T14:15:22Z", "languageIso": "string", "internalCompanyId": 0, "customerCategoryId": 0, "taxIdentificationNumber": "string", "accountsReceivableNumber": 0, "commercialRegisterNumber": "string", "website": "string", "initialContact": "string", "ebayUsername": "string", "birthday": "2019-08-24T14:15:22Z", "isLocked": true, "isCashRegisterBased": true }