Skip to content

JTL-WAWI API (OnPrem) (1.1)

JTL-Wawi-Version: 1.11.0.0

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://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.

HTTP Header

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
Languages
Servers
Mock server

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

Local OnPremise Environment

http://127.0.0.1:64110/api/eazybusiness/

odata

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

salesinvoicecorrection

Development

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

Query Invoices

Request

Query all Invoices

Security
Wawi
Query
salesOrderNumberstring

Search for a specific sales order number.

externalOrderNumberstring

Search for a specific external order number.

invoiceNumberstring

Search for a specific invoice number.

kArtikelinteger(int32)
kKundeinteger(int32)
IsExistingboolean
paymentStatusinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentStatus)

Search for a specific payment status.

Enum012
isExternalInvoiceboolean

Search only for external invoices

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/openapi/invoices?salesOrderNumber=string&externalOrderNumber=string&invoiceNumber=string&kArtikel=0&kKunde=0&IsExisting=true&paymentStatus=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'

Responses

Returns all non-pending sales orders.

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.Invoice.Invoice)required

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

Items[].​Idinteger(int32)(JTL.Data.Contracts.Keys.RechnungKey)required
Items[].​Numberstringrequired

The number of the invoice.

Example: "A1004465"
Items[].​ExternalNumberstringrequired

The external number of the sales order.

Example: "D456-64894-132"
Items[].​CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required
Items[].​DepartureCountryobject(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceDepartureCountry)required

Model Class: InvoiceDepartureCountry

Items[].​DepartureCountry.​CountryISOstringrequired

ISO code of the departure country.

Example: "DE"
Items[].​DepartureCountry.​Statestringrequired

Name of the state in the departure country.

Example: "Berlin"
Items[].​DepartureCountry.​CurrencyIsostringrequired

ISO code of the currency of the departure country.

Example: "TODO"
Items[].​DepartureCountry.​CurrencyFactornumber(decimal)required

The currency factor of the departure country.

Example: 1.37
Items[].​CustomerIdinteger(int32)(JTL.Data.Contracts.Keys.KundeKey)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.

Example: "Sportbedarf Sommer"
Items[].​BillingAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
Items[].​BillingAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
Items[].​BillingAddress.​Titlestringrequired

Official title

Example: "Dr."
Items[].​BillingAddress.​FirstNamestringrequired

Customer first name

Example: "John"
Items[].​BillingAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
Items[].​BillingAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
Items[].​BillingAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
Items[].​BillingAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
Items[].​BillingAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
Items[].​BillingAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
Items[].​BillingAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
Items[].​BillingAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
Items[].​BillingAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
Items[].​BillingAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
Items[].​BillingAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
Items[].​BillingAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
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.

Example: "Sportbedarf Sommer"
Items[].​ShipmentAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
Items[].​ShipmentAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
Items[].​ShipmentAddress.​Titlestringrequired

Official title

Example: "Dr."
Items[].​ShipmentAddress.​FirstNamestringrequired

Customer first name

Example: "John"
Items[].​ShipmentAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
Items[].​ShipmentAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
Items[].​ShipmentAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
Items[].​ShipmentAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
Items[].​ShipmentAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
Items[].​ShipmentAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
Items[].​ShipmentAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
Items[].​ShipmentAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
Items[].​ShipmentAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
Items[].​ShipmentAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
Items[].​ShipmentAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
Items[].​ShipmentAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
Items[].​InvoiceDatestring(date-time)required

The date when the invoice was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
Items[].​InvoicePaymentDetailsobject(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentDetail)required

Model Class: InvoicePaymentDetail

Items[].​InvoicePaymentDetails.​PaymentMethodIdinteger(int32)(JTL.Data.Contracts.Keys.ZahlungsartKey)required
Items[].​InvoicePaymentDetails.​PaymentStatusinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentStatus)required

0 = UnPayed, 1 = PartialPayed, 2 = Payed

Enum012
Items[].​InvoicePaymentDetails.​TotalGrossAmountnumber(decimal)required

The total gross amount of the invoice.

Example: 19.99
Items[].​InvoicePaymentDetails.​CurrencyIsostringrequired

ISO code of the currency of the invoice.

Example: "TODO"
Items[].​InvoicePaymentDetails.​CurrencyFactornumber(decimal)required

The currency factor for the sales order at the time the sales order has been created.

Example: 1.37
Items[].​InvoicePaymentDetails.​StillToPaynumber(decimal)required

The amount that is left to pay for this invoice.

Example: 0
Items[].​InvoicePaymentDetails.​PaymentTargetinteger(int32)required

The due date for payment of the sales order in days.

Example: 0
Items[].​InvoicePaymentDetails.​CashDiscountnumber(decimal)required

The cash discount of the sales order.

Example: 5
Items[].​InvoicePaymentDetails.​CashDiscountDaysinteger(int32)required

The days that the cash discount is valid.

Example: 2
Items[].​InvoicePaymentDetails.​StopPaymentRequestbooleanrequired

The creation of dunning letters is blocked.

Example: false
Items[].​InvoicePaymentDetails.​DunningLevelinteger(int32)required

The stage at which dunning currently is

Example: 0
Items[].​InvoicePaymentDetails.​NextDueDatestring(date-time)required

The next due date

Example: "2023-02-01T12:45:00.0000000+00:00"
Items[].​ColorcodeIdinteger(int32)(JTL.Data.Contracts.Keys.FarbeKey)required
Items[].​DunningBlockbooleanrequired

The creation of dunning letters is blocked.

Example: false
Items[].​IsExternalInvoicebooleanrequired

Indicates if the invoice of the sales order was created in an external system like Amazon VCS.

Example: false
Items[].​Commentstringrequired

A comment on the sales order.

Example: "an additional order comment"
Items[].​CustomerCommentstringrequired

A customer comment on the sales order.

Example: "an additional customer comment"
Items[].​IsCancelledbooleanrequired

Indicates if the invoice has been cancelled.

Example: false
Items[].​LanguageIsostringrequired

The language of the invoice.

Example: "DE"
Items[].​CancellationDetailsobject(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceCancellationDetails)required

Model Class: InvoiceCancellationDetails

Items[].​CancellationDetails.​CancellationReasonIdinteger(int32)(JTL.Data.Contracts.Keys.RechnungStornogrundKey)required
Items[].​CancellationDetails.​CancellationCommentstringrequired

A comment that adds further information to the cancellation.

Example: "Change of mind (once again); we should consider terminating the customer relationship"
Items[].​CancellationDetails.​Datestring(date-time)required

The DateTime of Cancellation.

Example: "2023-02-01T12:45:00.0000000+00:00"
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 }

Get Invoice

Request

Get a specific invoice

Security
Wawi
Path
invoiceIdstringrequired
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/openapi/invoices/{invoiceId}' \
  -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'

Responses

Returns the invoice for the given ID.

Bodyapplication/json
Idinteger(int32)(JTL.Data.Contracts.Keys.RechnungKey)required
Numberstringrequired

The number of the invoice.

Example: "A1004465"
ExternalNumberstringrequired

The external number of the sales order.

Example: "D456-64894-132"
CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required
DepartureCountryobject(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceDepartureCountry)required

Model Class: InvoiceDepartureCountry

DepartureCountry.​CountryISOstringrequired

ISO code of the departure country.

Example: "DE"
DepartureCountry.​Statestringrequired

Name of the state in the departure country.

Example: "Berlin"
DepartureCountry.​CurrencyIsostringrequired

ISO code of the currency of the departure country.

Example: "TODO"
DepartureCountry.​CurrencyFactornumber(decimal)required

The currency factor of the departure country.

Example: 1.37
CustomerIdinteger(int32)(JTL.Data.Contracts.Keys.KundeKey)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.

Example: "Sportbedarf Sommer"
BillingAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
BillingAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
BillingAddress.​Titlestringrequired

Official title

Example: "Dr."
BillingAddress.​FirstNamestringrequired

Customer first name

Example: "John"
BillingAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
BillingAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
BillingAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
BillingAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
BillingAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
BillingAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
BillingAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
BillingAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
BillingAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
BillingAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
BillingAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
BillingAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
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.

Example: "Sportbedarf Sommer"
ShipmentAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
ShipmentAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
ShipmentAddress.​Titlestringrequired

Official title

Example: "Dr."
ShipmentAddress.​FirstNamestringrequired

Customer first name

Example: "John"
ShipmentAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
ShipmentAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
ShipmentAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
ShipmentAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
ShipmentAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
ShipmentAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
ShipmentAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
ShipmentAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
ShipmentAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
ShipmentAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
ShipmentAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
ShipmentAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
InvoiceDatestring(date-time)required

The date when the invoice was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
InvoicePaymentDetailsobject(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentDetail)required

Model Class: InvoicePaymentDetail

InvoicePaymentDetails.​PaymentMethodIdinteger(int32)(JTL.Data.Contracts.Keys.ZahlungsartKey)required
InvoicePaymentDetails.​PaymentStatusinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentStatus)required

0 = UnPayed, 1 = PartialPayed, 2 = Payed

Enum012
InvoicePaymentDetails.​TotalGrossAmountnumber(decimal)required

The total gross amount of the invoice.

Example: 19.99
InvoicePaymentDetails.​CurrencyIsostringrequired

ISO code of the currency of the invoice.

Example: "TODO"
InvoicePaymentDetails.​CurrencyFactornumber(decimal)required

The currency factor for the sales order at the time the sales order has been created.

Example: 1.37
InvoicePaymentDetails.​StillToPaynumber(decimal)required

The amount that is left to pay for this invoice.

Example: 0
InvoicePaymentDetails.​PaymentTargetinteger(int32)required

The due date for payment of the sales order in days.

Example: 0
InvoicePaymentDetails.​CashDiscountnumber(decimal)required

The cash discount of the sales order.

Example: 5
InvoicePaymentDetails.​CashDiscountDaysinteger(int32)required

The days that the cash discount is valid.

Example: 2
InvoicePaymentDetails.​StopPaymentRequestbooleanrequired

The creation of dunning letters is blocked.

Example: false
InvoicePaymentDetails.​DunningLevelinteger(int32)required

The stage at which dunning currently is

Example: 0
InvoicePaymentDetails.​NextDueDatestring(date-time)required

The next due date

Example: "2023-02-01T12:45:00.0000000+00:00"
ColorcodeIdinteger(int32)(JTL.Data.Contracts.Keys.FarbeKey)required
DunningBlockbooleanrequired

The creation of dunning letters is blocked.

Example: false
IsExternalInvoicebooleanrequired

Indicates if the invoice of the sales order was created in an external system like Amazon VCS.

Example: false
Commentstringrequired

A comment on the sales order.

Example: "an additional order comment"
CustomerCommentstringrequired

A customer comment on the sales order.

Example: "an additional customer comment"
IsCancelledbooleanrequired

Indicates if the invoice has been cancelled.

Example: false
LanguageIsostringrequired

The language of the invoice.

Example: "DE"
CancellationDetailsobject(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceCancellationDetails)required

Model Class: InvoiceCancellationDetails

CancellationDetails.​CancellationReasonIdinteger(int32)(JTL.Data.Contracts.Keys.RechnungStornogrundKey)required
CancellationDetails.​CancellationCommentstringrequired

A comment that adds further information to the cancellation.

Example: "Change of mind (once again); we should consider terminating the customer relationship"
CancellationDetails.​Datestring(date-time)required

The DateTime of Cancellation.

Example: "2023-02-01T12:45:00.0000000+00:00"
Response
application/json
{ "Id": 0, "Number": "A1004465", "ExternalNumber": "D456-64894-132", "CompanyId": 0, "DepartureCountry": { "CountryISO": "DE", "State": "Berlin", "CurrencyIso": "TODO", "CurrencyFactor": 1.37 }, "CustomerId": 0, "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" }, "InvoiceDate": "2023-02-01T12:45:00.0000000+00:00", "InvoicePaymentDetails": { "PaymentMethodId": 0, "PaymentStatus": 0, "TotalGrossAmount": 19.99, "CurrencyIso": "TODO", "CurrencyFactor": 1.37, "StillToPay": 0, "PaymentTarget": 0, "CashDiscount": 5, "CashDiscountDays": 2, "StopPaymentRequest": false, "DunningLevel": 0, "NextDueDate": "2023-02-01T12:45:00.0000000+00:00" }, "ColorcodeId": 0, "DunningBlock": false, "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" } }

Query Invoice Line Items

Request

Query all line items for a specific invoice

Security
Wawi
Path
invoiceIdstringrequired
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/openapi/invoices/{invoiceId}/lineitems' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The requested line items.

Bodyapplication/jsonArray [
Idinteger(int32)(JTL.Data.Contracts.Keys.RechnungPositionKey)required
InvoiceIdinteger(int32)(JTL.Data.Contracts.Keys.RechnungKey)required
SalesOrderIdinteger(int32)(JTL.Data.Contracts.Keys.VerkaufAuftragKey)required
SalesOrderLineItemIdinteger(int32)(JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey)required
ItemIdinteger(int32)(JTL.Data.Contracts.Keys.ArtikelKey)required
Namestringrequired

Name of the item.

Example: "Awesome Binoculars"
SKUstringrequired

SKU of the sales invoice item.

Example: "ART2394871"
Typeinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceLineItemType)required

0 = CustomLineItem, 1 = Item, 2 = Shipping, 3 = Coupon, 4 = Voucher, 5 = Payment, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDelivery, 9 = ShippingSurchargeItem, 10 = GiftWrapping, 11 = GiftForFree, 12 = TrustedShops, 13 = InterestPremium, 14 = ProcessingFee, 15 = Carton, 16 = ReturnDelivery, 17 = MultiPurposeVoucher, 18 = MultiPurposeVoucherDigital, 19 = SinglePurposeVoucher, 20 = SinglePurposeVoucherDigital, 21 = SinglePurposeVoucherRedemption

Enum0123456789
Quantitynumber(decimal)required

The quantity of the line item.

Example: 2
SalesUnitstringrequired

The measurement unit in which the line item is sold.

Example: "stk"
SalesPriceNetnumber(decimal)required

The net sales price of the line item.

Example: 16.8
SalesPriceGrossnumber(decimal)required

The gross sales price of the line item.

Example: 19.99
Discountnumber(decimal)required

The discount applied to the line item.

Example: 5
PurchasePriceNetnumber(decimal)required

The price for which the merchant has bought the item.

Example: 13.46
TaxRatenumber(decimal)required

The tax rate of the line item.

Example: 19
]
Response
application/json
[ { "Id": 0, "InvoiceId": 0, "SalesOrderId": 0, "SalesOrderLineItemId": 0, "ItemId": 0, "Name": "Awesome Binoculars", "SKU": "ART2394871", "Type": 0, "Quantity": 2, "SalesUnit": "stk", "SalesPriceNet": 16.8, "SalesPriceGross": 19.99, "Discount": 5, "PurchasePriceNet": 13.46, "TaxRate": 19 } ]

info

Returns the status of the API
Operations

features

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

Extensibility

Planned

Operations

shipping

Development

deliverynote

Planned

Operations

customer

Query all customers
Operations

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