JTL-WAWI API (Cloud) (1.1)

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.1-cloud/openapi/

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

info

Operations

worker

Planned

Operations

features

Operations

printer

Operations

company

Operations

supplier

Operations

colorcodes

Operations

item

Operations

property

Operations

returnstate

Planned

Operations

onholdreason

Operations

returnreason

Planned

Operations

saleschannel

Operations

customerGroup

Operations

paymentmethod

Operations

odata

Operations

shippingmethod

Operations

warehouse

Operations

customerCategory

Operations

return

Operations

cancellationreason

Operations

transactionStatus

Operations

invoice

Planned

Operations

customer

Operations

category

Operations

salesorder

Operations

Configuration

Planned

Operations

deliverynote

Planned

Operations

Query Delivery Notes

Request

Query all delivery notes

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

Search for a specific sales order number.

salesOrderNumberIdinteger(int32)

Search for a specific sales order.

customerIdinteger(int32)

Search for a specific customer Id.

pageNumberinteger(int32)

Number of the page of items to fetch.

pageSizeinteger(int32)

Size of the page that is specified by pageNumber.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes?customerId=0&pageNumber=0&pageSize=0&salesOrderNumber=string&salesOrderNumberId=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all non-pending delivery notes.

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

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

Items[].​Idinteger(int32)required

Unique ID to identify a delivery note.

Example: 123
Items[].​Numberstringrequired

The number of the delivery note.

Example: "A1004465"
Items[].​DeliveryNoteDatestring(date-time)required

The date when the delivery note was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
Items[].​PackagesArray of objects(JTL.Wawi.Rest.Contracts.Models.DeliveryNote.DeliveryNotePackage)required

All packages that are created with the delivery note.

Items[].​Packages[].​Idinteger(int32)required

The id of the package.

Example: 65475
Items[].​Packages[].​PackageDatestring(date-time)required

The date when the package was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
Items[].​Packages[].​TrackingIDstringrequired

The tracking Id of the package.

Example: "JJD0099999999"
Items[].​Packages[].​Weightsnumber(decimal)required

The weight of the package.

Example: 5
Items[].​Packages[].​ShippingMethodIdinteger(int32)required

The shipping method of the package.

Example: 3
Items[].​Packages[].​ShippedDatestring(date-time)required

The date when the package was shipped.

Example: "2023-02-01T12:45:00.0000000+00:00"
Items[].​Packages[].​TrackingUrlstringrequired

The tracking url of the package.

Example: "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999"
Items[].​Packages[].​Commentstringrequired

The comment of the package.

Example: "Shipping Comment"
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 Delivery Note

Request

Get a specific delivery note

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
deliveryNoteIdinteger(int32)required

The id of the delivery note.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/{deliveryNoteId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns the delivery note for the given id.

Bodyapplication/json
Idinteger(int32)required

Unique ID to identify a delivery note.

Example: 123
Numberstringrequired

The number of the delivery note.

Example: "A1004465"
DeliveryNoteDatestring(date-time)required

The date when the delivery note was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
PackagesArray of objects(JTL.Wawi.Rest.Contracts.Models.DeliveryNote.DeliveryNotePackage)required

All packages that are created with the delivery note.

Packages[].​Idinteger(int32)required

The id of the package.

Example: 65475
Packages[].​PackageDatestring(date-time)required

The date when the package was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
Packages[].​TrackingIDstringrequired

The tracking Id of the package.

Example: "JJD0099999999"
Packages[].​Weightsnumber(decimal)required

The weight of the package.

Example: 5
Packages[].​ShippingMethodIdinteger(int32)required

The shipping method of the package.

Example: 3
Packages[].​ShippedDatestring(date-time)required

The date when the package was shipped.

Example: "2023-02-01T12:45:00.0000000+00:00"
Packages[].​TrackingUrlstringrequired

The tracking url of the package.

Example: "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999"
Packages[].​Commentstringrequired

The comment of the package.

Example: "Shipping Comment"
Response
application/json
{
  "Id": 123,
  "Number": "A1004465",
  "DeliveryNoteDate": "2023-02-01T12:45:00.0000000+00:00",
  "Packages": [
    { … }
  ]
}

Mail Delivery Note

Request

Execute the mailing of a DeliveryNote

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
deliveryNoteIdinteger(int32)required

The id of the sales order for that the mail to start.

Query
formIdinteger(int32)

The optional key of a Form to mail.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/{deliveryNoteId}/output/mail?formId=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The MailJob is created

Bodyapplication/json
Response
application/json
null

Pdf Delivery Note

Request

Execute the pdf creation of a DeliveryNote

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
deliveryNoteIdinteger(int32)required

The id of the sales order for that the creation of a pdf to start.

Query
formIdinteger(int32)

The optional key of a Form to creat pdf.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/{deliveryNoteId}/output/pdf?formId=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The Filestream of the Created PDF

Bodyapplication/json
string(binary)
Response
application/json
"string"

Print Delivery Note

Request

Execute the printing of a DeliveryNote

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
deliveryNoteIdinteger(int32)required

The id of the sales order for that the print to start.

Query
formIdinteger(int32)

The optional key of a Form to Print.

printerstring

The target printer to print. The printer is Mandatory, if no User with Own Printer Configuration Available.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/{deliveryNoteId}/output/print?formId=0&printer=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The Printjob is created

Bodyapplication/json
Response
application/json
null

Get Delivery Note Packages

Request

Get all packages for a specific delivery note

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
deliveryNoteIdinteger(int32)required

The id of the delivery note.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/{deliveryNoteId}/packages' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns the delivery note for the given id.

Bodyapplication/jsonArray [
Idinteger(int32)required

The id of the package.

Example: 65475
PackageDatestring(date-time)required

The date when the package was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingIDstringrequired

The tracking Id of the package.

Example: "JJD0099999999"
Weightsnumber(decimal)required

The weight of the package.

Example: 5
ShippingMethodIdinteger(int32)required

The shipping method of the package.

Example: 3
ShippedDatestring(date-time)required

The date when the package was shipped.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingUrlstringrequired

The tracking url of the package.

Example: "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999"
Commentstringrequired

The comment of the package.

Example: "Shipping Comment"
]
Response
application/json
[
  {
    "Id": 65475,
    "PackageDate": "2023-02-01T12:45:00.0000000+00:00",
    "TrackingID": "JJD0099999999",
    "Weights": 5,
    "ShippingMethodId": 3,
    "ShippedDate": "2023-02-01T12:45:00.0000000+00:00",
    "TrackingUrl": "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999",
    "Comment": "Shipping Comment"
  }
]

Post Package Data For Delivery Note

Request

Transmit Package Data

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
deliveryNoteIdinteger(int32)required

The id of the delivery note.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The Packages to Create

Array [
ShippedDatestring(date-time)

The date when the package was shipped.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingIDstringrequired

The tracking Id of the package.

Example: "JJD0099999999"
Commentstring

The comment of the package.

Example: "Shipping Comment"
]
curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/{deliveryNoteId}/packages' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '[
    {
      "ShippedDate": "2023-02-01T12:45:00.0000000+00:00",
      "TrackingID": "JJD0099999999",
      "Comment": "Shipping Comment"
    }
  ]'

Responses

Returns All packages that are created for the delivery note.

Bodyapplication/jsonArray [
Idinteger(int32)required

The id of the package.

Example: 65475
PackageDatestring(date-time)required

The date when the package was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingIDstringrequired

The tracking Id of the package.

Example: "JJD0099999999"
Weightsnumber(decimal)required

The weight of the package.

Example: 5
ShippingMethodIdinteger(int32)required

The shipping method of the package.

Example: 3
ShippedDatestring(date-time)required

The date when the package was shipped.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingUrlstringrequired

The tracking url of the package.

Example: "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999"
Commentstringrequired

The comment of the package.

Example: "Shipping Comment"
]
Response
application/json
[
  {
    "Id": 65475,
    "PackageDate": "2023-02-01T12:45:00.0000000+00:00",
    "TrackingID": "JJD0099999999",
    "Weights": 5,
    "ShippingMethodId": 3,
    "ShippedDate": "2023-02-01T12:45:00.0000000+00:00",
    "TrackingUrl": "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999",
    "Comment": "Shipping Comment"
  }
]

Trigger Delivery Note Workflow

Request

Trigger a specific workflow event for a given delivery Note

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
deliveryNoteIdinteger(int32)required

The id of the delivery Note for that the manual workflow event should be started.

workflowEventIdinteger(int32)required

The id of the Event for that the manual workflow event should be started.1=Created | 2=Deleted | 3=Shipped

Enum123
Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/{deliveryNoteId}/workflow/{workflowEventId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Bodyapplication/json
Response
application/json
null

Patch Package Data

Request

Transmit Package Data

Security
(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)
Path
packageIdinteger(int32)required

The id of the package.

Headers
api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The Package to update

ShippedDatestring(date-time)

The date when the package was shipped.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingIDstringrequired

The tracking Id of the package.

Example: "JJD0099999999"
Commentstring

The comment of the package.

Example: "Shipping Comment"
curl -i -X PATCH \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/deliveryNotes/packages/{packageId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "ShippedDate": "2023-02-01T12:45:00.0000000+00:00",
    "TrackingID": "JJD0099999999",
    "Comment": "Shipping Comment"
  }'

Responses

Returns the package that are created for the delivery note.

Bodyapplication/json
Idinteger(int32)required

The id of the package.

Example: 65475
PackageDatestring(date-time)required

The date when the package was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingIDstringrequired

The tracking Id of the package.

Example: "JJD0099999999"
Weightsnumber(decimal)required

The weight of the package.

Example: 5
ShippingMethodIdinteger(int32)required

The shipping method of the package.

Example: 3
ShippedDatestring(date-time)required

The date when the package was shipped.

Example: "2023-02-01T12:45:00.0000000+00:00"
TrackingUrlstringrequired

The tracking url of the package.

Example: "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999"
Commentstringrequired

The comment of the package.

Example: "Shipping Comment"
Response
application/json
{
  "Id": 65475,
  "PackageDate": "2023-02-01T12:45:00.0000000+00:00",
  "TrackingID": "JJD0099999999",
  "Weights": 5,
  "ShippingMethodId": 3,
  "ShippedDate": "2023-02-01T12:45:00.0000000+00:00",
  "TrackingUrl": "https://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc=JJD0099999999",
  "Comment": "Shipping Comment"
}

appRegistration

Operations

login

Operations

logout

Operations

wms

Operations

stock

Operations

accountingData

Planned

Operations

tax

Operations

shipping

Development

offer

Operations

creditnote

Operations