> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Delivers order data for a specific package
> Delivers order data for a specific package
## OpenAPI
````yaml /openapi/2.1.json get /v2/packages/{packageId}/order-data
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.2.0-alpha.9492+Sha.4c8d5d1\r\n# Introduction\r\n\r\nWelcome 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.\r\n\r\n# Authentication\r\n\r\nYou 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:\r\n\r\n* AppId\r\n* DisplayName\r\n* Description\r\n* Version\r\n* ProviderName\r\n* ProviderWebsite\r\n* MandatoryApiScopes\r\n\r\nThis 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.\r\n\r\nBefore 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.\r\n\r\nThe 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.\r\n\r\nAfter 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!\r\n\r\nThis 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."
contact:
name: JTL-Software-GmbH
url: https://developer.jtl-software.com/
email: partner@jtl-software.com
version: '2.1'
x-application-version: 2.2.0.0
servers:
- url: https://api.jtl-cloud.com/erp
description: Production Environment Cloud API Gateway
security: []
tags:
- name: WMS
description: >-
Query all pick
lists for a specific wms warehouse that are not completed.
- name: Wawi App
description: >-
Get a
specific customer
- name: Warehouses
description: >-
Queries all
storage locations for a given warehouse.
- name: Units
description: Development
- name: Transaction Status
description: >-
Queries all transaction statuses for a sales
order.
- name: Tax
description: >-
Returns the tax
rate for the given item.
- name: Inventory
description: >-
Queries
stocks for a specific item, warehouse or storage location.
- name: Sales Order
description: Planned
- name: Sales Invoice Correction
description: Planned
- name: Return
description: >-
Create a new
return with associated items and packages.
- name: Item
description: >-
Queries all
responsible persons.
- name: Refund
description: Planned
- name: Property
description: >-
Queries all
properties of items.
- name: Printer
description: >-
Retrieves all
installed printers.
- name: Master Data
description: >-
Queries
all on hold reasons for sales orders.
- name: Manufacturer
description: Development
- name: Label
description: Development
- name: Sales Invoice
description: Planned
- name: Info
description: >-
Returns the
status of the API.
- name: Features
description: >-
Returns the
available feature sets with release state and API version.
- name: Extensibility
description: Planned
- name: Shipment
description: Development
- name: Delivery Note
description: Planned
- name: Custom Field
description: Development
- name: Customer
description: >-
Deletes a
specific customer.
- name: Authentication
description: >-
DEPRECATED seit Wawi 2.2.0: No-Op. Seit
Wawi 2.1.0 registriert sich die Wawi selbst per JWT.
- name: Attribute
description: Development
- name: Sales Quotation
description: >-
Execute
the printing of a sales quotation
- name: Production
- name: Resources
- name: Company
- name: Sales Orders
- name: Marketplace Seller
- name: Seller
- name: Marketplace Order
- name: Marketplace Offer
- name: Marketplace Invoicing
- name: Sales Channel
- name: Payment
- name: Warehouse Assistant
- name: Worker
paths:
/v2/packages/{packageId}/order-data:
get:
tags:
- Shipment
summary: Delivers order data for a specific package
description: Delivers order data for a specific package
operationId: ShipmentPackages_GetOrderData
parameters:
- name: packageId
in: path
required: true
schema:
type: string
x-position: 1
- name: x-companyid
in: header
description: >-
The Company-Id (int or uuid) of the company on whose behalf the
request is executed.
schema:
type: string
- name: x-tenant-id
in: header
required: true
schema:
type: string
format: uuid
description: The tenant ID for the target ERP instance.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.OrderDataItem
'400':
description: ''
content:
application/json: {}
'401':
description: ''
content:
application/json: {}
'403':
description: ''
content:
application/json: {}
'404':
description: ''
content:
application/json: {}
'500':
description: ''
content:
application/json: {}
security:
- oauth2-authorization-code:
- inventory.read
- oauth2-client-credentials:
- inventory.read
components:
schemas:
JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.OrderDataItem:
type: object
description: Single Row of the order data query
additionalProperties: false
required:
- Id
- OrderId
- CustomerId
- CompanyId
- WarehouseId
- ShippingAddress
- CompanyAddress
- WarehouseAddress
- DeliveryNotes
- Content
properties:
id:
type: string
description: The Package ID of the Order
totalWeight:
type: number
description: Total weight in kg (range 0-10000)
format: decimal
orderId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey'
description: Order ID
customerId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundeKey'
description: Customer ID
companyId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
description: Company ID
warehouseId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
description: Warehouse ID
shippingAddress:
$ref: >-
#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.ShippingAddress
description: Shipping address
companyAddress:
$ref: >-
#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.CompanyAddress
description: Company address
warehouseAddress:
$ref: >-
#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.WarehouseAddress
description: Warehouse address
deliveryNotes:
type: array
description: List of delivery notes
items:
$ref: >-
#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.DeliveryNoteItem
content:
type: array
description: List of package content items
items:
$ref: >-
#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.PackageContent
JTL.Data.Contracts.Keys.VerkaufAuftragKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.KundeKey:
type: string
description: Represents a unique key for identifying a customer in the JTL system.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.FirmaKey:
type: string
description: Represents a key for identifying a firm within the application.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.WarenlagerKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.ShippingAddress:
type: object
description: Represents a shipping address
additionalProperties: false
required:
- CustomsDocumentsRequired
properties:
company:
type: string
description: Company name
salutation:
type: string
description: Salutation
title:
type: string
description: Title
firstName:
type: string
description: First name
lastName:
type: string
description: Last name
street:
type: string
description: Street
zipCode:
type: string
description: Zip code
city:
type: string
description: City
country:
type: string
description: Country
phone:
type: string
description: Phone
addressSupplement:
type: string
description: Address supplement
addressSupplement2:
type: string
description: Address supplement 2
postId:
type: string
description: Post ID
mobile:
type: string
description: Mobile
mail:
type: string
description: Mail
fax:
type: string
description: Fax
state:
type: string
description: State
iso:
type: string
description: ISO code
customsDocumentsRequired:
type: boolean
description: Customs documents required
JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.CompanyAddress:
type: object
description: Represents a company address
additionalProperties: false
required:
- Id
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
description: Company ID
name:
type: string
description: Company name
entrepreneur:
type: string
description: Entrepreneur
street:
type: string
description: Street
zipCode:
type: string
description: Zip code
city:
type: string
description: City
country:
type: string
description: Country
phone:
type: string
description: Phone
mail:
type: string
description: Mail
iso:
type: string
description: ISO code
JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.WarehouseAddress:
type: object
description: Represents a warehouse address
additionalProperties: false
required:
- Id
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
description: Warehouse ID
name:
type: string
description: Warehouse name
shortcut:
type: string
description: Shortcut
description:
type: string
description: Description
street:
type: string
description: Street
zipCode:
type: string
description: Zip code
city:
type: string
description: City
country:
type: string
description: Country
phone:
type: string
description: Phone
mail:
type: string
description: Mail
addressSupplement:
type: string
description: Address supplement
JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.DeliveryNoteItem:
type: object
description: A delivery note item
additionalProperties: false
required:
- Id
- CreatedAt
- Number
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey'
description: Unique ID to identify a delivery note.
createdAt:
type: string
description: Created at timestamp
format: date-time
number:
type: string
description: Delivery note number
JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.PackageContent:
type: object
description: Represents a package content item
additionalProperties: false
required:
- Id
- Number
- ContentType
- Amount
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
description: Item ID
number:
type: string
description: Item number
contentType:
type: string
description: Content type (e.g. item, carton, openPosition)
amount:
type: number
description: Amount of the item in the package
format: decimal
weight:
type: number
description: 'Shipping Weight in kg (range: 0-10000)'
format: decimal
JTL.Data.Contracts.Keys.LieferscheinKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.ArtikelKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
securitySchemes:
oauth2-authorization-code:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.jtl-cloud.com/oauth2/auth
tokenUrl: https://auth.jtl-cloud.com/oauth2/token
scopes:
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
saleschannels.read: Verkaufskanäle lesen
all.read: Allows the application to read all data.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
customfields.read: Grants permission to read custom fields.
customfields.write: Grants permission to create and modify custom fields.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliverynotes.print: Grants permission to print and output delivery notes.
deliverynotes.read: Grants permission to read delivery notes.
deliverynotes.write: Grants permission to create and modify delivery notes.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
inventories.read: Grants permission to read stock levels.
inventories.write: Grants permission to modify stock levels.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
labels.read: Grants permission to read labels.
labels.write: Grants permission to create and modify labels.
masterdata.read: >-
Read master data such as shipping methods, payment methods, color
codes and tax classes.
orders.read: Grants permission to read orders.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorders.print: Grants permission to print and output sales orders.
salesorders.read: Grants permission to read sales orders.
salesorders.write: Grants permission to create and modify sales orders.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
taxes.read: Grants permission to read tax data.
warehouse.read: Grants permission to read warehouse data.
wawiapp.all: Grants access to Wawi app related operations.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
payments.read: Ermöglicht den Lesezugriff auf Zahlungen.
payments.write: Ermöglicht den Schreibzugriff auf Zahlungen.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.print: Grants permission to print and output sales invoices.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.print: Grants permission to print and output sales quotations.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
suppliers.read: Grants permission to read suppliers.
system.worker.read: Worker-Synchronisationen lesen
system.worker.write: Worker-Synchronisationen schreiben
resources.read: Grants permission to read resource management data.
resources.write: Grants permission to create and modify resource management data.
pps.read: Grants permission to read production data.
pps.write: Grants permission to create and modify production data.
inventory.write: Bestand schreiben
masterdata.write: Write master data
inventory.read: Grants permission to read stock levels.
taxes.write: Grants permission to create and modify tax data.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
oauth2-client-credentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.jtl-cloud.com/oauth2/token
scopes:
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
saleschannels.read: Verkaufskanäle lesen
all.read: Allows the application to read all data.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
customfields.read: Grants permission to read custom fields.
customfields.write: Grants permission to create and modify custom fields.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliverynotes.print: Grants permission to print and output delivery notes.
deliverynotes.read: Grants permission to read delivery notes.
deliverynotes.write: Grants permission to create and modify delivery notes.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
inventories.read: Grants permission to read stock levels.
inventories.write: Grants permission to modify stock levels.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
labels.read: Grants permission to read labels.
labels.write: Grants permission to create and modify labels.
masterdata.read: >-
Read master data such as shipping methods, payment methods, color
codes and tax classes.
orders.read: Grants permission to read orders.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorders.print: Grants permission to print and output sales orders.
salesorders.read: Grants permission to read sales orders.
salesorders.write: Grants permission to create and modify sales orders.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
taxes.read: Grants permission to read tax data.
warehouse.read: Grants permission to read warehouse data.
wawiapp.all: Grants access to Wawi app related operations.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
payments.read: Ermöglicht den Lesezugriff auf Zahlungen.
payments.write: Ermöglicht den Schreibzugriff auf Zahlungen.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.print: Grants permission to print and output sales invoices.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.print: Grants permission to print and output sales quotations.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
suppliers.read: Grants permission to read suppliers.
system.worker.read: Worker-Synchronisationen lesen
system.worker.write: Worker-Synchronisationen schreiben
resources.read: Grants permission to read resource management data.
resources.write: Grants permission to create and modify resource management data.
pps.read: Grants permission to read production data.
pps.write: Grants permission to create and modify production data.
inventory.write: Bestand schreiben
masterdata.write: Write master data
inventory.read: Grants permission to read stock levels.
taxes.write: Grants permission to create and modify tax data.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
````