Ships an order after batch picking — packs it into packages and persists it to the database.
curl --request POST \
--url https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"orderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"picklistId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"userId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"packages": [
{
"positions": [
{
"quantity": 123,
"picklistPositionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"data": [
{
"quantity": 123,
"serialNumber": "<string>",
"batchNumber": "<string>",
"bestBeforeDate": "2023-11-07T05:31:56Z"
}
]
}
],
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"weight": 123,
"packagingMaterials": [
{
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123
}
],
"sscc": "<string>",
"trackingId": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"packagingMaterialBinLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
],
"comment": "<string>",
"isPartialDelivery": true
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order"
payload = {
"orderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"picklistId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"userId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"packages": [
{
"positions": [
{
"quantity": 123,
"picklistPositionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"data": [
{
"quantity": 123,
"serialNumber": "<string>",
"batchNumber": "<string>",
"bestBeforeDate": "2023-11-07T05:31:56Z"
}
]
}
],
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"weight": 123,
"packagingMaterials": [
{
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123
}
],
"sscc": "<string>",
"trackingId": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"packagingMaterialBinLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
],
"comment": "<string>",
"isPartialDelivery": True
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-tenant-id': '<x-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
orderId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
picklistId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
warehouseId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
userId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
packages: [
{
positions: [
{
quantity: 123,
picklistPositionId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
itemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
data: [
{
quantity: 123,
serialNumber: '<string>',
batchNumber: '<string>',
bestBeforeDate: '2023-11-07T05:31:56Z'
}
]
}
],
shippingMethodId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
weight: 123,
packagingMaterials: [{itemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000', quantity: 123}],
sscc: '<string>',
trackingId: '<string>',
deliveryDate: '2023-11-07T05:31:56Z',
packagingMaterialBinLocationId: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
}
],
comment: '<string>',
isPartialDelivery: true
})
};
fetch('https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'picklistId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'warehouseId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'userId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'packages' => [
[
'positions' => [
[
'quantity' => 123,
'picklistPositionId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'itemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'data' => [
[
'quantity' => 123,
'serialNumber' => '<string>',
'batchNumber' => '<string>',
'bestBeforeDate' => '2023-11-07T05:31:56Z'
]
]
]
],
'shippingMethodId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'weight' => 123,
'packagingMaterials' => [
[
'itemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'quantity' => 123
]
],
'sscc' => '<string>',
'trackingId' => '<string>',
'deliveryDate' => '2023-11-07T05:31:56Z',
'packagingMaterialBinLocationId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000'
]
],
'comment' => '<string>',
'isPartialDelivery' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-tenant-id: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order"
payload := strings.NewReader("{\n \"orderId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"picklistId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"userId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"packages\": [\n {\n \"positions\": [\n {\n \"quantity\": 123,\n \"picklistPositionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"data\": [\n {\n \"quantity\": 123,\n \"serialNumber\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"bestBeforeDate\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ],\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"weight\": 123,\n \"packagingMaterials\": [\n {\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123\n }\n ],\n \"sscc\": \"<string>\",\n \"trackingId\": \"<string>\",\n \"deliveryDate\": \"2023-11-07T05:31:56Z\",\n \"packagingMaterialBinLocationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ],\n \"comment\": \"<string>\",\n \"isPartialDelivery\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-tenant-id", "<x-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"picklistId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"userId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"packages\": [\n {\n \"positions\": [\n {\n \"quantity\": 123,\n \"picklistPositionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"data\": [\n {\n \"quantity\": 123,\n \"serialNumber\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"bestBeforeDate\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ],\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"weight\": 123,\n \"packagingMaterials\": [\n {\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123\n }\n ],\n \"sscc\": \"<string>\",\n \"trackingId\": \"<string>\",\n \"deliveryDate\": \"2023-11-07T05:31:56Z\",\n \"packagingMaterialBinLocationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ],\n \"comment\": \"<string>\",\n \"isPartialDelivery\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"picklistId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"userId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"packages\": [\n {\n \"positions\": [\n {\n \"quantity\": 123,\n \"picklistPositionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"data\": [\n {\n \"quantity\": 123,\n \"serialNumber\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"bestBeforeDate\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ],\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"weight\": 123,\n \"packagingMaterials\": [\n {\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123\n }\n ],\n \"sscc\": \"<string>\",\n \"trackingId\": \"<string>\",\n \"deliveryDate\": \"2023-11-07T05:31:56Z\",\n \"packagingMaterialBinLocationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ],\n \"comment\": \"<string>\",\n \"isPartialDelivery\": true\n}"
response = http.request(request)
puts response.read_body{
"deliveryNotes": [
{
"id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"number": "<string>",
"packages": [
{
"id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"isShipped": true,
"packageId": "<string>",
"trackingId": "<string>"
}
]
}
]
}WMS
Ships an order after batch picking — packs it into packages and persists it to the database.
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 packaging materials, SSCC, tracking id and delivery date. Returns the created delivery note and packages. A per-package PackageId (for shipping-label retrieval) is only assigned when the shipping-preparation feature and licence are active.
POST
/
v2
/
wms
/
shipments
/
ship-order
Ships an order after batch picking — packs it into packages and persists it to the database.
curl --request POST \
--url https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"orderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"picklistId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"userId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"packages": [
{
"positions": [
{
"quantity": 123,
"picklistPositionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"data": [
{
"quantity": 123,
"serialNumber": "<string>",
"batchNumber": "<string>",
"bestBeforeDate": "2023-11-07T05:31:56Z"
}
]
}
],
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"weight": 123,
"packagingMaterials": [
{
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123
}
],
"sscc": "<string>",
"trackingId": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"packagingMaterialBinLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
],
"comment": "<string>",
"isPartialDelivery": true
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order"
payload = {
"orderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"picklistId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"userId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"packages": [
{
"positions": [
{
"quantity": 123,
"picklistPositionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"data": [
{
"quantity": 123,
"serialNumber": "<string>",
"batchNumber": "<string>",
"bestBeforeDate": "2023-11-07T05:31:56Z"
}
]
}
],
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"weight": 123,
"packagingMaterials": [
{
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123
}
],
"sscc": "<string>",
"trackingId": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"packagingMaterialBinLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
],
"comment": "<string>",
"isPartialDelivery": True
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-tenant-id': '<x-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
orderId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
picklistId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
warehouseId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
userId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
packages: [
{
positions: [
{
quantity: 123,
picklistPositionId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
itemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
data: [
{
quantity: 123,
serialNumber: '<string>',
batchNumber: '<string>',
bestBeforeDate: '2023-11-07T05:31:56Z'
}
]
}
],
shippingMethodId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
weight: 123,
packagingMaterials: [{itemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000', quantity: 123}],
sscc: '<string>',
trackingId: '<string>',
deliveryDate: '2023-11-07T05:31:56Z',
packagingMaterialBinLocationId: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
}
],
comment: '<string>',
isPartialDelivery: true
})
};
fetch('https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'picklistId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'warehouseId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'userId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'packages' => [
[
'positions' => [
[
'quantity' => 123,
'picklistPositionId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'itemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'data' => [
[
'quantity' => 123,
'serialNumber' => '<string>',
'batchNumber' => '<string>',
'bestBeforeDate' => '2023-11-07T05:31:56Z'
]
]
]
],
'shippingMethodId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'weight' => 123,
'packagingMaterials' => [
[
'itemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'quantity' => 123
]
],
'sscc' => '<string>',
'trackingId' => '<string>',
'deliveryDate' => '2023-11-07T05:31:56Z',
'packagingMaterialBinLocationId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000'
]
],
'comment' => '<string>',
'isPartialDelivery' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-tenant-id: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order"
payload := strings.NewReader("{\n \"orderId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"picklistId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"userId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"packages\": [\n {\n \"positions\": [\n {\n \"quantity\": 123,\n \"picklistPositionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"data\": [\n {\n \"quantity\": 123,\n \"serialNumber\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"bestBeforeDate\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ],\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"weight\": 123,\n \"packagingMaterials\": [\n {\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123\n }\n ],\n \"sscc\": \"<string>\",\n \"trackingId\": \"<string>\",\n \"deliveryDate\": \"2023-11-07T05:31:56Z\",\n \"packagingMaterialBinLocationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ],\n \"comment\": \"<string>\",\n \"isPartialDelivery\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-tenant-id", "<x-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"picklistId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"userId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"packages\": [\n {\n \"positions\": [\n {\n \"quantity\": 123,\n \"picklistPositionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"data\": [\n {\n \"quantity\": 123,\n \"serialNumber\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"bestBeforeDate\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ],\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"weight\": 123,\n \"packagingMaterials\": [\n {\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123\n }\n ],\n \"sscc\": \"<string>\",\n \"trackingId\": \"<string>\",\n \"deliveryDate\": \"2023-11-07T05:31:56Z\",\n \"packagingMaterialBinLocationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ],\n \"comment\": \"<string>\",\n \"isPartialDelivery\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/wms/shipments/ship-order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"picklistId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"userId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"packages\": [\n {\n \"positions\": [\n {\n \"quantity\": 123,\n \"picklistPositionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"data\": [\n {\n \"quantity\": 123,\n \"serialNumber\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"bestBeforeDate\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ],\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"weight\": 123,\n \"packagingMaterials\": [\n {\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123\n }\n ],\n \"sscc\": \"<string>\",\n \"trackingId\": \"<string>\",\n \"deliveryDate\": \"2023-11-07T05:31:56Z\",\n \"packagingMaterialBinLocationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ],\n \"comment\": \"<string>\",\n \"isPartialDelivery\": true\n}"
response = http.request(request)
puts response.read_body{
"deliveryNotes": [
{
"id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"number": "<string>",
"packages": [
{
"id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"isShipped": true,
"packageId": "<string>",
"trackingId": "<string>"
}
]
}
]
}Authorizations
oauth2-authorization-codeoauth2-client-credentials
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The tenant ID for the target ERP instance.
The Company-Id (int or uuid) of the company on whose behalf the request is executed.
Body
application/json
Request parameters
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 packaging materials, SSCC, tracking id and delivery date. Returns the created delivery note and packages. A per-package PackageId (for shipping-label retrieval) is only assigned when the shipping-preparation feature and licence are active. - Request
The order to ship (kAuftrag).
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The picklist associated with the order (kPickliste).
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The warehouse the packing runs on (kWarenLager).
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The packing user (kBenutzer).
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The packages, each with its own positions, shipping method, weight, dimensions, packaging materials and SSCC.
Show child attributes
Show child attributes
Optional packing comment (cKommentar).
Whether this is a partial delivery; drives the SP packing mode.
Response
The order was shipped successfully (persisted to the database). Returns the created delivery note and its packages. PackageId is only assigned when the shipping-preparation feature and licence are active — without it no shipping label can be retrieved via GET v2/wms/shipping-line/packages/{packageId}/label.
The delivery notes and packages created by a ShipOrder call. Today one call creates exactly one delivery note; the list keeps the contract extensible.
The delivery notes created by this call (currently exactly one).
Show child attributes
Show child attributes
Was this page helpful?
⌘I