Skip to content

JTL-WAWI API (Cloud) (1.2)

JTL-Wawi-Version: 1.12.0-alpha.14636

Introduction

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.

Authentication

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:

  • 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.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://developer.jtl-software.com/

JTL-Software-GmbH

partner@jtl-software.com

Languages
Servers
Mock server

https://developer.jtl-software.com/_mock/products/erpapi/1.2-cloud/openapi/

Production Environment Cloud API Gateway

https://api.jtl-cloud.com/erp/

Beta Environment Cloud API Gateway

https://api.beta.jtl-cloud.com/erp/

worker

Planned

Operations

wms

Query all pick lists for a specific wms warehouse that are not completed.
Operations

warehouse

Query all warehouses
Operations

transactionStatus

Query all transaction status for sales order
Operations

tax

Returns the Taxrate for the given Item
Operations

item

Query all tax classes
Operations

supplier

Query all suppliers
Operations

stock

Query stocks for a specific item, warehouse or storage location
Operations

shippingmethod

Query all shipping methods
Operations

salesorder

Query all sales orders
Operations

cancellationreason

Planned

Operations

saleschannel

Get all sales channels
Operations

return

Create a new return with associated items and packages.
Operations

returnstate

Planned

Operations

returnreason

Planned

Operations

property

Query all properties for items
Operations

printer

Returns all Installed Printers
Operations

paymentmethod

Query all payment methods
Operations

onholdreason

Query all on hold reasons for sales orders
Operations

offer

Execute the printing of a Offer
Operations

Configuration

Planned

Operations

invoice

Planned

Operations

info

Returns the status of the API
Operations

features

Returns the available feature sets with release state and API version
Operations

Extensibility

Planned

Operations

deliverynote

Planned

Operations

customer

Query all customers
Operations

Query Customers

Request

Query all customers

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Query
searchKeyWordstring

All Search Keywords for the customer, like the number and the most important fields from the billing address.

numberstring

Search for a specific customer number.

kKundenGruppeinteger(int32)
kKundenKategorieinteger(int32)
lastChangeFromstring(date-time)

All customers where the last change happened after or equal the given time

lastChangeTostring(date-time)

All customers where the last change happened before or equal the given time

pageNumberinteger(int32)

Number of the page of items to fetch.

pageSizeinteger(int32)

Size of the page that is specified by pageNumber.

Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.2-cloud/openapi/customers?searchKeyWord=string&number=string&kKundenGruppe=0&kKundenKategorie=0&lastChangeFrom=2019-08-24T14%3A15%3A22Z&lastChangeTo=2019-08-24T14%3A15%3A22Z&pageNumber=0&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all customer, can be filtered by searchKeyWord or categoryId.

Bodyapplication/json
totalItemsinteger(int32)required

Gets or sets the total number of items available in the data source.

pageNumberinteger(int32)required

Gets or sets the current page number in the paginated list.

pageSizeinteger(int32)required

Gets or sets the number of items per page in the paginated list.

itemsArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer)required

Gets or sets the collection of items contained in the paged list.

items[].​idinteger(int32)(JTL.Data.Contracts.Keys.KundeKey)required
items[].​numberstringrequired

The customer's number.

items[].​customerGroupIdinteger(int32)(JTL.Data.Contracts.Keys.KundenGruppeKey)required
items[].​billingAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

items[].​billingAddress.​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
items[].​billingAddress.​companystringrequired

Description of the Company.

items[].​billingAddress.​company2stringrequired

Additional company information

items[].​billingAddress.​formOfAddressstringrequired

Customer form of address

items[].​billingAddress.​titlestringrequired

Official title

items[].​billingAddress.​firstNamestringrequired

Customer first name

items[].​billingAddress.​lastNamestringrequired

Customer last name

items[].​billingAddress.​streetstringrequired

Street name in the customer's address

items[].​billingAddress.​address2stringrequired

Additional address information

items[].​billingAddress.​postalCodestringrequired

Postal code of the customer's address

items[].​billingAddress.​citystringrequired

Name of city in the customer's address

items[].​billingAddress.​statestringrequired

Name of state in the customer's address

items[].​billingAddress.​countryIsostringrequired

Country ISO code

items[].​billingAddress.​vatIDstringrequired

Supplier VAT ID number

items[].​billingAddress.​phoneNumberstringrequired

Landline phone number

items[].​billingAddress.​mobilePhoneNumberstringrequired

Mobile phone number

items[].​billingAddress.​emailAddressstringrequired

Email address

items[].​billingAddress.​faxstringrequired

Fax number

items[].​shipmentaddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

items[].​shipmentaddress.​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
items[].​shipmentaddress.​companystringrequired

Description of the Company.

items[].​shipmentaddress.​company2stringrequired

Additional company information

items[].​shipmentaddress.​formOfAddressstringrequired

Customer form of address

items[].​shipmentaddress.​titlestringrequired

Official title

items[].​shipmentaddress.​firstNamestringrequired

Customer first name

items[].​shipmentaddress.​lastNamestringrequired

Customer last name

items[].​shipmentaddress.​streetstringrequired

Street name in the customer's address

items[].​shipmentaddress.​address2stringrequired

Additional address information

items[].​shipmentaddress.​postalCodestringrequired

Postal code of the customer's address

items[].​shipmentaddress.​citystringrequired

Name of city in the customer's address

items[].​shipmentaddress.​statestringrequired

Name of state in the customer's address

items[].​shipmentaddress.​countryIsostringrequired

Country ISO code

items[].​shipmentaddress.​vatIDstringrequired

Supplier VAT ID number

items[].​shipmentaddress.​phoneNumberstringrequired

Landline phone number

items[].​shipmentaddress.​mobilePhoneNumberstringrequired

Mobile phone number

items[].​shipmentaddress.​emailAddressstringrequired

Email address

items[].​shipmentaddress.​faxstringrequired

Fax number

items[].​customAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

items[].​customAddress.​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
items[].​customAddress.​companystringrequired

Description of the Company.

items[].​customAddress.​company2stringrequired

Additional company information

items[].​customAddress.​formOfAddressstringrequired

Customer form of address

items[].​customAddress.​titlestringrequired

Official title

items[].​customAddress.​firstNamestringrequired

Customer first name

items[].​customAddress.​lastNamestringrequired

Customer last name

items[].​customAddress.​streetstringrequired

Street name in the customer's address

items[].​customAddress.​address2stringrequired

Additional address information

items[].​customAddress.​postalCodestringrequired

Postal code of the customer's address

items[].​customAddress.​citystringrequired

Name of city in the customer's address

items[].​customAddress.​statestringrequired

Name of state in the customer's address

items[].​customAddress.​countryIsostringrequired

Country ISO code

items[].​customAddress.​vatIDstringrequired

Supplier VAT ID number

items[].​customAddress.​phoneNumberstringrequired

Landline phone number

items[].​customAddress.​mobilePhoneNumberstringrequired

Mobile phone number

items[].​customAddress.​emailAddressstringrequired

Email address

items[].​customAddress.​faxstringrequired

Fax number

items[].​otherAddressesobject(JTL.Wawi.Rest.Contracts.Models.V1.Customer.OtherAddresses)required

Model Class: OtherAddresses

items[].​otherAddresses.​otherBillingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

All other non-default billing addresses of the customer.

items[].​otherAddresses.​otherBillingAddresses[].​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
items[].​otherAddresses.​otherBillingAddresses[].​companystringrequired

Description of the Company.

items[].​otherAddresses.​otherBillingAddresses[].​company2stringrequired

Additional company information

items[].​otherAddresses.​otherBillingAddresses[].​formOfAddressstringrequired

Customer form of address

items[].​otherAddresses.​otherBillingAddresses[].​titlestringrequired

Official title

items[].​otherAddresses.​otherBillingAddresses[].​firstNamestringrequired

Customer first name

items[].​otherAddresses.​otherBillingAddresses[].​lastNamestringrequired

Customer last name

items[].​otherAddresses.​otherBillingAddresses[].​streetstringrequired

Street name in the customer's address

items[].​otherAddresses.​otherBillingAddresses[].​address2stringrequired

Additional address information

items[].​otherAddresses.​otherBillingAddresses[].​postalCodestringrequired

Postal code of the customer's address

items[].​otherAddresses.​otherBillingAddresses[].​citystringrequired

Name of city in the customer's address

items[].​otherAddresses.​otherBillingAddresses[].​statestringrequired

Name of state in the customer's address

items[].​otherAddresses.​otherBillingAddresses[].​countryIsostringrequired

Country ISO code

items[].​otherAddresses.​otherBillingAddresses[].​vatIDstringrequired

Supplier VAT ID number

items[].​otherAddresses.​otherBillingAddresses[].​phoneNumberstringrequired

Landline phone number

items[].​otherAddresses.​otherBillingAddresses[].​mobilePhoneNumberstringrequired

Mobile phone number

items[].​otherAddresses.​otherBillingAddresses[].​emailAddressstringrequired

Email address

items[].​otherAddresses.​otherBillingAddresses[].​faxstringrequired

Fax number

items[].​otherAddresses.​otherShippingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

All other non-default shipping addresses of the customer.

items[].​otherAddresses.​otherShippingAddresses[].​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
items[].​otherAddresses.​otherShippingAddresses[].​companystringrequired

Description of the Company.

items[].​otherAddresses.​otherShippingAddresses[].​company2stringrequired

Additional company information

items[].​otherAddresses.​otherShippingAddresses[].​formOfAddressstringrequired

Customer form of address

items[].​otherAddresses.​otherShippingAddresses[].​titlestringrequired

Official title

items[].​otherAddresses.​otherShippingAddresses[].​firstNamestringrequired

Customer first name

items[].​otherAddresses.​otherShippingAddresses[].​lastNamestringrequired

Customer last name

items[].​otherAddresses.​otherShippingAddresses[].​streetstringrequired

Street name in the customer's address

items[].​otherAddresses.​otherShippingAddresses[].​address2stringrequired

Additional address information

items[].​otherAddresses.​otherShippingAddresses[].​postalCodestringrequired

Postal code of the customer's address

items[].​otherAddresses.​otherShippingAddresses[].​citystringrequired

Name of city in the customer's address

items[].​otherAddresses.​otherShippingAddresses[].​statestringrequired

Name of state in the customer's address

items[].​otherAddresses.​otherShippingAddresses[].​countryIsostringrequired

Country ISO code

items[].​otherAddresses.​otherShippingAddresses[].​vatIDstringrequired

Supplier VAT ID number

items[].​otherAddresses.​otherShippingAddresses[].​phoneNumberstringrequired

Landline phone number

items[].​otherAddresses.​otherShippingAddresses[].​mobilePhoneNumberstringrequired

Mobile phone number

items[].​otherAddresses.​otherShippingAddresses[].​emailAddressstringrequired

Email address

items[].​otherAddresses.​otherShippingAddresses[].​faxstringrequired

Fax number

items[].​otherAddresses.​otherCustomerAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

All other non-billing and non-shipping addresses of the customer.

items[].​otherAddresses.​otherCustomerAddresses[].​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
items[].​otherAddresses.​otherCustomerAddresses[].​companystringrequired

Description of the Company.

items[].​otherAddresses.​otherCustomerAddresses[].​company2stringrequired

Additional company information

items[].​otherAddresses.​otherCustomerAddresses[].​formOfAddressstringrequired

Customer form of address

items[].​otherAddresses.​otherCustomerAddresses[].​titlestringrequired

Official title

items[].​otherAddresses.​otherCustomerAddresses[].​firstNamestringrequired

Customer first name

items[].​otherAddresses.​otherCustomerAddresses[].​lastNamestringrequired

Customer last name

items[].​otherAddresses.​otherCustomerAddresses[].​streetstringrequired

Street name in the customer's address

items[].​otherAddresses.​otherCustomerAddresses[].​address2stringrequired

Additional address information

items[].​otherAddresses.​otherCustomerAddresses[].​postalCodestringrequired

Postal code of the customer's address

items[].​otherAddresses.​otherCustomerAddresses[].​citystringrequired

Name of city in the customer's address

items[].​otherAddresses.​otherCustomerAddresses[].​statestringrequired

Name of state in the customer's address

items[].​otherAddresses.​otherCustomerAddresses[].​countryIsostringrequired

Country ISO code

items[].​otherAddresses.​otherCustomerAddresses[].​vatIDstringrequired

Supplier VAT ID number

items[].​otherAddresses.​otherCustomerAddresses[].​phoneNumberstringrequired

Landline phone number

items[].​otherAddresses.​otherCustomerAddresses[].​mobilePhoneNumberstringrequired

Mobile phone number

items[].​otherAddresses.​otherCustomerAddresses[].​emailAddressstringrequired

Email address

items[].​otherAddresses.​otherCustomerAddresses[].​faxstringrequired

Fax number

items[].​paymentSettingsobject(JTL.Wawi.Rest.Contracts.Models.V1.Customer.PaymentSettings)required

Model Class: PaymentSettings

items[].​paymentSettings.​paymentMethodIdinteger(int32)(JTL.Data.Contracts.Keys.ZahlungsartKey)required
items[].​paymentSettings.​discountnumber(decimal)required

The indicated discount, if any.

items[].​paymentSettings.​paymentTargetinteger(int32)required

The payment target in days.

items[].​paymentSettings.​creditLimitinteger(int32)required

The customer's credit limit.

items[].​paymentSettings.​stopPaymentRequestbooleanrequired

Option to stop payment requests.

items[].​customerSincestring(date-time)required

Date since they have been a customer.

items[].​lastChangestring(date-time)required

Date of the last customer's data change.

items[].​languageIsostringrequired

The customer's language.

items[].​internalCompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required
items[].​customerCategoryIdinteger(int32)(JTL.Data.Contracts.Keys.KundenKategorieKey)required
items[].​taxIdentificationNumberstringrequired

The customer's tax identification number.

items[].​accountsReceivableNumberinteger(int32)required

The customer's accounts receivable number.

items[].​commercialRegisterNumberstringrequired

The customer's commercial register number.

items[].​websitestringrequired

The customer's website.

items[].​initialContactstringrequired

The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.

items[].​ebayUsernamestringrequired

The customer's eBay username.

items[].​birthdaystring(date-time)required

The customer's date of birth.

items[].​isLockedbooleanrequired

The customer's locked status for online shop sales channels.

items[].​isCashRegisterBasedbooleanrequired

States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example.

totalPagesinteger(int32)read-only

Gets the total number of pages based on the total number of items and the page size.

hasPreviousPagebooleanread-only

Gets a value indicating whether there is a previous page available in the paginated list.

hasNextPagebooleanread-only

Gets a value indicating whether there is a next page available.

nextPageNumberinteger(int32)read-only

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

previousPageNumberinteger(int32)read-only

Gets the number of the previous page. If there is no previous page, it returns 1.

Response
application/json
{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "items": [
    { … }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Create Customer

Request

Create a new customer

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Query
disableAutomaticWorkflowsboolean

If true, the workflows do not trigger automatic.

Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

Bodyapplication/jsonrequired

The customer to create.

numberstring
customerGroupIdinteger(int32)(JTL.Data.Contracts.Keys.KundenGruppeKey)required
billingAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress)required

Model Class: CreateAddress

billingAddress.​companystring
billingAddress.​company2string
billingAddress.​formOfAddressstring
billingAddress.​titlestring
billingAddress.​firstNamestring
billingAddress.​lastNamestring
billingAddress.​streetstring
billingAddress.​address2string
billingAddress.​postalCodestring
billingAddress.​citystring<= 255 charactersrequired

Name of city in the customer's address

billingAddress.​statestring
billingAddress.​countryIsostring<= 5 charactersrequired

Country ISO code

billingAddress.​vatIDstring
billingAddress.​phoneNumberstring
billingAddress.​mobilePhoneNumberstring
billingAddress.​emailAddressstring
billingAddress.​faxstring
shipmentaddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress)

Model Class: CreateAddress

customAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress)

Model Class: CreateAddress

otherAddressesobject(JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateOtherAddresses)

Model Class: CreateOtherAddresses

paymentSettingsobject(JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreatePaymentSettings)

Model Class: CreatePaymentSettings

customerSincestring(date-time)
lastChangestring(date-time)
languageIsostringrequired

The customer's language.

internalCompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required
customerCategoryIdinteger(int32)(JTL.Data.Contracts.Keys.KundenKategorieKey)
taxIdentificationNumberstring
accountsReceivableNumberinteger(int32)
commercialRegisterNumberstring
websitestring
initialContactstring
ebayUsernamestring
birthdaystring(date-time)
isLockedboolean
isCashRegisterBasedboolean
curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.2-cloud/openapi/customers?disableAutomaticWorkflows=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -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
  }'

Responses

The created customer.

Bodyapplication/json
idinteger(int32)(JTL.Data.Contracts.Keys.KundeKey)required
numberstringrequired

The customer's number.

customerGroupIdinteger(int32)(JTL.Data.Contracts.Keys.KundenGruppeKey)required
billingAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

billingAddress.​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
billingAddress.​companystringrequired

Description of the Company.

billingAddress.​company2stringrequired

Additional company information

billingAddress.​formOfAddressstringrequired

Customer form of address

billingAddress.​titlestringrequired

Official title

billingAddress.​firstNamestringrequired

Customer first name

billingAddress.​lastNamestringrequired

Customer last name

billingAddress.​streetstringrequired

Street name in the customer's address

billingAddress.​address2stringrequired

Additional address information

billingAddress.​postalCodestringrequired

Postal code of the customer's address

billingAddress.​citystringrequired

Name of city in the customer's address

billingAddress.​statestringrequired

Name of state in the customer's address

billingAddress.​countryIsostringrequired

Country ISO code

billingAddress.​vatIDstringrequired

Supplier VAT ID number

billingAddress.​phoneNumberstringrequired

Landline phone number

billingAddress.​mobilePhoneNumberstringrequired

Mobile phone number

billingAddress.​emailAddressstringrequired

Email address

billingAddress.​faxstringrequired

Fax number

shipmentaddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

shipmentaddress.​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
shipmentaddress.​companystringrequired

Description of the Company.

shipmentaddress.​company2stringrequired

Additional company information

shipmentaddress.​formOfAddressstringrequired

Customer form of address

shipmentaddress.​titlestringrequired

Official title

shipmentaddress.​firstNamestringrequired

Customer first name

shipmentaddress.​lastNamestringrequired

Customer last name

shipmentaddress.​streetstringrequired

Street name in the customer's address

shipmentaddress.​address2stringrequired

Additional address information

shipmentaddress.​postalCodestringrequired

Postal code of the customer's address

shipmentaddress.​citystringrequired

Name of city in the customer's address

shipmentaddress.​statestringrequired

Name of state in the customer's address

shipmentaddress.​countryIsostringrequired

Country ISO code

shipmentaddress.​vatIDstringrequired

Supplier VAT ID number

shipmentaddress.​phoneNumberstringrequired

Landline phone number

shipmentaddress.​mobilePhoneNumberstringrequired

Mobile phone number

shipmentaddress.​emailAddressstringrequired

Email address

shipmentaddress.​faxstringrequired

Fax number

customAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

customAddress.​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
customAddress.​companystringrequired

Description of the Company.

customAddress.​company2stringrequired

Additional company information

customAddress.​formOfAddressstringrequired

Customer form of address

customAddress.​titlestringrequired

Official title

customAddress.​firstNamestringrequired

Customer first name

customAddress.​lastNamestringrequired

Customer last name

customAddress.​streetstringrequired

Street name in the customer's address

customAddress.​address2stringrequired

Additional address information

customAddress.​postalCodestringrequired

Postal code of the customer's address

customAddress.​citystringrequired

Name of city in the customer's address

customAddress.​statestringrequired

Name of state in the customer's address

customAddress.​countryIsostringrequired

Country ISO code

customAddress.​vatIDstringrequired

Supplier VAT ID number

customAddress.​phoneNumberstringrequired

Landline phone number

customAddress.​mobilePhoneNumberstringrequired

Mobile phone number

customAddress.​emailAddressstringrequired

Email address

customAddress.​faxstringrequired

Fax number

otherAddressesobject(JTL.Wawi.Rest.Contracts.Models.V1.Customer.OtherAddresses)required

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.

otherAddresses.​otherBillingAddresses[].​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
otherAddresses.​otherBillingAddresses[].​companystringrequired

Description of the Company.

otherAddresses.​otherBillingAddresses[].​company2stringrequired

Additional company information

otherAddresses.​otherBillingAddresses[].​formOfAddressstringrequired

Customer form of address

otherAddresses.​otherBillingAddresses[].​titlestringrequired

Official title

otherAddresses.​otherBillingAddresses[].​firstNamestringrequired

Customer first name

otherAddresses.​otherBillingAddresses[].​lastNamestringrequired

Customer last name

otherAddresses.​otherBillingAddresses[].​streetstringrequired

Street name in the customer's address

otherAddresses.​otherBillingAddresses[].​address2stringrequired

Additional address information

otherAddresses.​otherBillingAddresses[].​postalCodestringrequired

Postal code of the customer's address

otherAddresses.​otherBillingAddresses[].​citystringrequired

Name of city in the customer's address

otherAddresses.​otherBillingAddresses[].​statestringrequired

Name of state in the customer's address

otherAddresses.​otherBillingAddresses[].​countryIsostringrequired

Country ISO code

otherAddresses.​otherBillingAddresses[].​vatIDstringrequired

Supplier VAT ID number

otherAddresses.​otherBillingAddresses[].​phoneNumberstringrequired

Landline phone number

otherAddresses.​otherBillingAddresses[].​mobilePhoneNumberstringrequired

Mobile phone number

otherAddresses.​otherBillingAddresses[].​emailAddressstringrequired

Email address

otherAddresses.​otherBillingAddresses[].​faxstringrequired

Fax number

otherAddresses.​otherShippingAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

All other non-default shipping addresses of the customer.

otherAddresses.​otherShippingAddresses[].​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
otherAddresses.​otherShippingAddresses[].​companystringrequired

Description of the Company.

otherAddresses.​otherShippingAddresses[].​company2stringrequired

Additional company information

otherAddresses.​otherShippingAddresses[].​formOfAddressstringrequired

Customer form of address

otherAddresses.​otherShippingAddresses[].​titlestringrequired

Official title

otherAddresses.​otherShippingAddresses[].​firstNamestringrequired

Customer first name

otherAddresses.​otherShippingAddresses[].​lastNamestringrequired

Customer last name

otherAddresses.​otherShippingAddresses[].​streetstringrequired

Street name in the customer's address

otherAddresses.​otherShippingAddresses[].​address2stringrequired

Additional address information

otherAddresses.​otherShippingAddresses[].​postalCodestringrequired

Postal code of the customer's address

otherAddresses.​otherShippingAddresses[].​citystringrequired

Name of city in the customer's address

otherAddresses.​otherShippingAddresses[].​statestringrequired

Name of state in the customer's address

otherAddresses.​otherShippingAddresses[].​countryIsostringrequired

Country ISO code

otherAddresses.​otherShippingAddresses[].​vatIDstringrequired

Supplier VAT ID number

otherAddresses.​otherShippingAddresses[].​phoneNumberstringrequired

Landline phone number

otherAddresses.​otherShippingAddresses[].​mobilePhoneNumberstringrequired

Mobile phone number

otherAddresses.​otherShippingAddresses[].​emailAddressstringrequired

Email address

otherAddresses.​otherShippingAddresses[].​faxstringrequired

Fax number

otherAddresses.​otherCustomerAddressesArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

All other non-billing and non-shipping addresses of the customer.

otherAddresses.​otherCustomerAddresses[].​idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
otherAddresses.​otherCustomerAddresses[].​companystringrequired

Description of the Company.

otherAddresses.​otherCustomerAddresses[].​company2stringrequired

Additional company information

otherAddresses.​otherCustomerAddresses[].​formOfAddressstringrequired

Customer form of address

otherAddresses.​otherCustomerAddresses[].​titlestringrequired

Official title

otherAddresses.​otherCustomerAddresses[].​firstNamestringrequired

Customer first name

otherAddresses.​otherCustomerAddresses[].​lastNamestringrequired

Customer last name

otherAddresses.​otherCustomerAddresses[].​streetstringrequired

Street name in the customer's address

otherAddresses.​otherCustomerAddresses[].​address2stringrequired

Additional address information

otherAddresses.​otherCustomerAddresses[].​postalCodestringrequired

Postal code of the customer's address

otherAddresses.​otherCustomerAddresses[].​citystringrequired

Name of city in the customer's address

otherAddresses.​otherCustomerAddresses[].​statestringrequired

Name of state in the customer's address

otherAddresses.​otherCustomerAddresses[].​countryIsostringrequired

Country ISO code

otherAddresses.​otherCustomerAddresses[].​vatIDstringrequired

Supplier VAT ID number

otherAddresses.​otherCustomerAddresses[].​phoneNumberstringrequired

Landline phone number

otherAddresses.​otherCustomerAddresses[].​mobilePhoneNumberstringrequired

Mobile phone number

otherAddresses.​otherCustomerAddresses[].​emailAddressstringrequired

Email address

otherAddresses.​otherCustomerAddresses[].​faxstringrequired

Fax number

paymentSettingsobject(JTL.Wawi.Rest.Contracts.Models.V1.Customer.PaymentSettings)required

Model Class: PaymentSettings

paymentSettings.​paymentMethodIdinteger(int32)(JTL.Data.Contracts.Keys.ZahlungsartKey)required
paymentSettings.​discountnumber(decimal)required

The indicated discount, if any.

paymentSettings.​paymentTargetinteger(int32)required

The payment target in days.

paymentSettings.​creditLimitinteger(int32)required

The customer's credit limit.

paymentSettings.​stopPaymentRequestbooleanrequired

Option to stop payment requests.

customerSincestring(date-time)required

Date since they have been a customer.

lastChangestring(date-time)required

Date of the last customer's data change.

languageIsostringrequired

The customer's language.

internalCompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required
customerCategoryIdinteger(int32)(JTL.Data.Contracts.Keys.KundenKategorieKey)required
taxIdentificationNumberstringrequired

The customer's tax identification number.

accountsReceivableNumberinteger(int32)required

The customer's accounts receivable number.

commercialRegisterNumberstringrequired

The customer's commercial register number.

websitestringrequired

The customer's website.

initialContactstringrequired

The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.

ebayUsernamestringrequired

The customer's eBay username.

birthdaystring(date-time)required

The customer's date of birth.

isLockedbooleanrequired

The customer's locked status for online shop sales channels.

isCashRegisterBasedbooleanrequired

States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example.

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
}

Query Customer Bank Accounts

Request

Query all bank accounts for a specific customer

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Query
customerIdinteger(int32)

The id of the customer that the bank accounts belong to.

$selectstring

Limits the properties returned in the result.

$expandstring

Indicates the related entities to be represented inline. The maximum depth is 5.

$filterstring

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderbystring

Specifies the order in which items are returned. The maximum number of expressions is 5.

$topinteger(int32)

Limits the number of items returned from a collection. The maximum value is 500.

$skipinteger(int32)

Excludes the specified number of items of the queried collection from the result.

$countboolean

Indicates whether the total count of items within a collection are returned in the result.

Default false
Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.2-cloud/openapi/customers({customerId})/bankaccounts?customerId=0&%24select=string&%24expand=string&%24filter=string&%24orderby=string&%24top=0&%24skip=0&%24count=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

OK

Bodyapplication/json
@odata.contextstring

OData context URI that describes the metadata of the returned data set.

valueArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.OData.CustomerBankAccount)

The array of entities returned by the query.

@odata.countinteger or null(int32)

The total number of items available across all pages. Returned when the $count query option is used.

@odata.nextLinkstring or null

The URL to retrieve the next page of results when server-side paging is enabled.

Response
application/json
{
  "@odata.context": "string",
  "value": [
    { … }
  ],
  "@odata.count": 0,
  "@odata.nextLink": "string"
}

customerGroup

Query all customer groups
Operations

customerCategory

Query all customer categories
Operations

creditnote

Execute the printing of a CreditNote
Operations

company

Query all companies
Operations

colorcodes

Query all color codes for sales orders
Operations

category

Query all categories
Operations

appRegistration

Send a registration request for an (external) application
Operations

login

Sends a request to log in the user / dynamically assign the WAWI user. Only use this request if your API uses SSL.
Operations

logout

Sends a request to log out the user
Operations

accountingData

Planned

Operations

Customer

Operations

Retrieves a specific customer by their unique identifier.

Request

Fetches the customer details along with associated bank account information. Throws an HTTP 404 error if the customer is not found.

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Query
idinteger(int32)

The unique identifier of the customer to retrieve.

$selectstring

Limits the properties returned in the result.

$expandstring

Indicates the related entities to be represented inline. The maximum depth is 5.

Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.2-cloud/openapi/customers({id})?id=0&%24select=string&%24expand=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

OK

Bodyapplication/json
queryableArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.OData.Customer)
Response
application/json
{
  "queryable": [
    { … }
  ]
}