> ## 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.
# Ship Order
> Ships an order after batch picking — packs it into packages and persists it to the database. A package is marked shipped only when its DeliveryDate is supplied (and, for shipping methods that require a tracking id, only when its TrackingId is supplied); jtl-Shipping packages complete themselves. Each package carries its positions, shipping method, weight, dimensions, optional cartons, SSCC, tracking id and delivery date.
## OpenAPI
````yaml /openapi/2.1.json post /v2/wms/shipments/ship-order
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/wms/shipments/ship-order:
post:
tags:
- WMS
summary: Ship Order
description: >-
Ships an order after batch picking — packs it into packages and persists
it to the database. A package is marked shipped only when its
DeliveryDate is supplied (and, for shipping methods that require a
tracking id, only when its TrackingId is supplied); jtl-Shipping
packages complete themselves. Each package carries its positions,
shipping method, weight, dimensions, optional cartons, SSCC, tracking id
and delivery date.
operationId: Shipment_ShipOrder
parameters:
- 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.
requestBody:
x-name: request
description: Request parameters
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.ShipOrderCommandRequest
required: true
x-position: 1
responses:
'200':
description: The order was shipped successfully (persisted to the database).
content:
application/json: {}
'400':
description: ''
content:
application/json: {}
'401':
description: ''
content:
application/json: {}
'403':
description: ''
content:
application/json: {}
'500':
description: Internal server error.
content:
application/json: {}
security:
- oauth2-authorization-code:
- inventory.write
- oauth2-client-credentials:
- inventory.write
components:
schemas:
JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.ShipOrderCommandRequest:
type: object
description: >-
Ships an order after batch picking — packs it into packages and persists
it to the database. A package is marked shipped only when its
DeliveryDate is supplied (and, for shipping methods that require a
tracking id, only when its TrackingId is supplied); jtl-Shipping
packages complete themselves. Each package carries its positions,
shipping method, weight, dimensions, optional cartons, SSCC, tracking id
and delivery date. - Request
additionalProperties: false
required:
- OrderId
- PicklistId
- WarehouseId
- UserId
- Packages
properties:
orderId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey'
description: The order to ship (kAuftrag).
picklistId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey'
description: The picklist associated with the order (kPickliste).
warehouseId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
description: The warehouse the packing runs on (kWarenLager).
userId:
$ref: '#/components/schemas/JTL.Identity.Abstractions.BenutzerKey'
description: The packing user (kBenutzer).
comment:
type: string
description: Optional packing comment (cKommentar).
isPartialDelivery:
type: boolean
description: Whether this is a partial delivery; drives the SP packing mode.
packages:
type: array
description: >-
The packages, each with its own positions, shipping method, weight,
dimensions, cartons and SSCC.
items:
$ref: >-
#/components/schemas/JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.PackageInput
JTL.Data.Contracts.Keys.VerkaufAuftragKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.PicklisteKey:
type: string
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.Identity.Abstractions.BenutzerKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.PackageInput:
type: object
description: >-
One package with its positions, shipping method, weight, dimensions,
optional cartons, SSCC, tracking id and delivery date.
additionalProperties: false
required:
- Positions
- ShippingMethodId
- Weight
properties:
positions:
type: array
description: The positions packed into this package.
items:
$ref: >-
#/components/schemas/JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.PackagePositionInput
shippingMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey'
description: The shipping method of this package.
weight:
type: number
description: The package weight in kilograms.
format: decimal
dimensions:
$ref: >-
#/components/schemas/JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.DimensionsInput
description: >-
Optional package dimensions (length x width x height); only used for
freight shipments (feature-flagged), ignored otherwise.
cartons:
type: array
description: Optional cartons / packaging materials used for this package.
items:
$ref: >-
#/components/schemas/JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.CartonInput
sscc:
type: string
description: The SSCC of this package; generated server-side when omitted.
trackingId:
type: string
description: >-
Per-package tracking id. For shipping methods that require a
tracking id the package cannot be completed without it; ignored for
jtl-Shipping packages.
deliveryDate:
type: string
description: >-
Per-package delivery date. When set, the package is marked shipped
(tVersand.dVersendet); ignored for jtl-Shipping packages.
format: date-time
cartonBinLocationId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey'
description: >-
Optional WMS bin location (kWarenLagerPlatz) the package's cartons
are taken from. WMS-internal; when omitted, the server uses the bin
location of the oldest in-stock carton (FIFO by goods-receipt date).
example: b45f6432-2462-4c6f-b00f-1d9d01000000
JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.PackagePositionInput:
type: object
description: >-
A packed position. Identify EITHER by PicklistPositionId OR by ItemId
plus its Data rows.
additionalProperties: false
required:
- Quantity
properties:
picklistPositionId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.PicklistePosKey'
description: The picklist position being packed (kPicklistePos) — variant A.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
itemId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
description: The item being packed (kArtikel) — variant B.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
quantity:
type: number
description: The packed quantity for this position.
format: decimal
data:
type: array
description: >-
Optional serial-number / batch / best-before data rows for this
position.
items:
$ref: >-
#/components/schemas/JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.PackagePositionDataInput
JTL.Data.Contracts.Keys.VersandartKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.DimensionsInput:
type: object
description: Package dimensions in centimetres (cm).
additionalProperties: false
required:
- Length
- Width
- Height
properties:
length:
type: number
description: Length in cm.
format: decimal
width:
type: number
description: Width in cm.
format: decimal
height:
type: number
description: Height in cm.
format: decimal
JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.CartonInput:
type: object
description: A carton / packaging material consumed while packing.
additionalProperties: false
required:
- ItemId
properties:
itemId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
description: The carton / packaging-material item (kArtikel).
quantity:
type: number
description: The number of this carton used (defaults to 1 when omitted).
format: decimal
JTL.Data.Contracts.Keys.WarenLagerPlatzKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.PicklistePosKey:
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
JTL.WMS.Shipment.PublicApi.DataTransferObjects.V2.Shipment.PackagePositionDataInput:
type: object
description: Serial-number / batch / best-before data for a packed position.
additionalProperties: false
required:
- Quantity
properties:
quantity:
type: number
description: Quantity for this data row.
format: decimal
serialNumber:
type: string
description: Serial number, when applicable.
batchNumber:
type: string
description: Batch / charge number, when applicable.
bestBeforeDate:
type: string
description: Best-before date, when applicable.
format: date-time
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.
````