Shipping
curl --request PUT \
--url https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orderList": [
{
"sellerId": "4711",
"orderId": "43523-43432-43532",
"shippingComplete": true,
"shippingItems": [
{
"carrier": "DHL",
"trackingNumber": "23435833543343222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322",
"returnTracking": {
"carrier": "DHL",
"trackingNumber": "432353833232443222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322"
},
"shippedAt": "2019-01-13T12:00:00+00:00",
"orderItemIdList": [
{
"orderItemId": "5437233",
"quantity": 123
}
],
"shippedFrom": {
"city": "Köln",
"country": "DE",
"postcode": "51107"
}
}
],
"channel": "MYBESTDEALCOMDE"
}
]
}
'import requests
url = "https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping"
payload = { "orderList": [
{
"sellerId": "4711",
"orderId": "43523-43432-43532",
"shippingComplete": True,
"shippingItems": [
{
"carrier": "DHL",
"trackingNumber": "23435833543343222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322",
"returnTracking": {
"carrier": "DHL",
"trackingNumber": "432353833232443222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322"
},
"shippedAt": "2019-01-13T12:00:00+00:00",
"orderItemIdList": [
{
"orderItemId": "5437233",
"quantity": 123
}
],
"shippedFrom": {
"city": "Köln",
"country": "DE",
"postcode": "51107"
}
}
],
"channel": "MYBESTDEALCOMDE"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orderList: [
{
sellerId: '4711',
orderId: '43523-43432-43532',
shippingComplete: true,
shippingItems: [
{
carrier: 'DHL',
trackingNumber: '23435833543343222322',
trackingUrl: 'https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322',
returnTracking: {
carrier: 'DHL',
trackingNumber: '432353833232443222322',
trackingUrl: 'https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322'
},
shippedAt: '2019-01-13T12:00:00+00:00',
orderItemIdList: [{orderItemId: '5437233', quantity: 123}],
shippedFrom: {city: 'Köln', country: 'DE', postcode: '51107'}
}
],
channel: 'MYBESTDEALCOMDE'
}
]
})
};
fetch('https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping', 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://scx-sbx.api.jtl-software.com/v1/seller/order/shipping",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'orderList' => [
[
'sellerId' => '4711',
'orderId' => '43523-43432-43532',
'shippingComplete' => true,
'shippingItems' => [
[
'carrier' => 'DHL',
'trackingNumber' => '23435833543343222322',
'trackingUrl' => 'https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322',
'returnTracking' => [
'carrier' => 'DHL',
'trackingNumber' => '432353833232443222322',
'trackingUrl' => 'https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322'
],
'shippedAt' => '2019-01-13T12:00:00+00:00',
'orderItemIdList' => [
[
'orderItemId' => '5437233',
'quantity' => 123
]
],
'shippedFrom' => [
'city' => 'Köln',
'country' => 'DE',
'postcode' => '51107'
]
]
],
'channel' => 'MYBESTDEALCOMDE'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://scx-sbx.api.jtl-software.com/v1/seller/order/shipping"
payload := strings.NewReader("{\n \"orderList\": [\n {\n \"sellerId\": \"4711\",\n \"orderId\": \"43523-43432-43532\",\n \"shippingComplete\": true,\n \"shippingItems\": [\n {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"23435833543343222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322\",\n \"returnTracking\": {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"432353833232443222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322\"\n },\n \"shippedAt\": \"2019-01-13T12:00:00+00:00\",\n \"orderItemIdList\": [\n {\n \"orderItemId\": \"5437233\",\n \"quantity\": 123\n }\n ],\n \"shippedFrom\": {\n \"city\": \"Köln\",\n \"country\": \"DE\",\n \"postcode\": \"51107\"\n }\n }\n ],\n \"channel\": \"MYBESTDEALCOMDE\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderList\": [\n {\n \"sellerId\": \"4711\",\n \"orderId\": \"43523-43432-43532\",\n \"shippingComplete\": true,\n \"shippingItems\": [\n {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"23435833543343222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322\",\n \"returnTracking\": {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"432353833232443222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322\"\n },\n \"shippedAt\": \"2019-01-13T12:00:00+00:00\",\n \"orderItemIdList\": [\n {\n \"orderItemId\": \"5437233\",\n \"quantity\": 123\n }\n ],\n \"shippedFrom\": {\n \"city\": \"Köln\",\n \"country\": \"DE\",\n \"postcode\": \"51107\"\n }\n }\n ],\n \"channel\": \"MYBESTDEALCOMDE\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderList\": [\n {\n \"sellerId\": \"4711\",\n \"orderId\": \"43523-43432-43532\",\n \"shippingComplete\": true,\n \"shippingItems\": [\n {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"23435833543343222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322\",\n \"returnTracking\": {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"432353833232443222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322\"\n },\n \"shippedAt\": \"2019-01-13T12:00:00+00:00\",\n \"orderItemIdList\": [\n {\n \"orderItemId\": \"5437233\",\n \"quantity\": 123\n }\n ],\n \"shippedFrom\": {\n \"city\": \"Köln\",\n \"country\": \"DE\",\n \"postcode\": \"51107\"\n }\n }\n ],\n \"channel\": \"MYBESTDEALCOMDE\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"errorList": [
{
"code": "VAL100",
"message": "Required field sellerId not found",
"severity": "error",
"hint": "Check the field `sellerId` — it must be a non-empty string."
}
]
}{
"errorList": [
{
"code": "GEN500",
"message": "Internal Server Error",
"severity": "error",
"hint": null
}
]
}Order
Shipping
Send shipping information for shipped orders
PUT
/
v1
/
seller
/
order
/
shipping
Shipping
curl --request PUT \
--url https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orderList": [
{
"sellerId": "4711",
"orderId": "43523-43432-43532",
"shippingComplete": true,
"shippingItems": [
{
"carrier": "DHL",
"trackingNumber": "23435833543343222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322",
"returnTracking": {
"carrier": "DHL",
"trackingNumber": "432353833232443222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322"
},
"shippedAt": "2019-01-13T12:00:00+00:00",
"orderItemIdList": [
{
"orderItemId": "5437233",
"quantity": 123
}
],
"shippedFrom": {
"city": "Köln",
"country": "DE",
"postcode": "51107"
}
}
],
"channel": "MYBESTDEALCOMDE"
}
]
}
'import requests
url = "https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping"
payload = { "orderList": [
{
"sellerId": "4711",
"orderId": "43523-43432-43532",
"shippingComplete": True,
"shippingItems": [
{
"carrier": "DHL",
"trackingNumber": "23435833543343222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322",
"returnTracking": {
"carrier": "DHL",
"trackingNumber": "432353833232443222322",
"trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322"
},
"shippedAt": "2019-01-13T12:00:00+00:00",
"orderItemIdList": [
{
"orderItemId": "5437233",
"quantity": 123
}
],
"shippedFrom": {
"city": "Köln",
"country": "DE",
"postcode": "51107"
}
}
],
"channel": "MYBESTDEALCOMDE"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orderList: [
{
sellerId: '4711',
orderId: '43523-43432-43532',
shippingComplete: true,
shippingItems: [
{
carrier: 'DHL',
trackingNumber: '23435833543343222322',
trackingUrl: 'https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322',
returnTracking: {
carrier: 'DHL',
trackingNumber: '432353833232443222322',
trackingUrl: 'https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322'
},
shippedAt: '2019-01-13T12:00:00+00:00',
orderItemIdList: [{orderItemId: '5437233', quantity: 123}],
shippedFrom: {city: 'Köln', country: 'DE', postcode: '51107'}
}
],
channel: 'MYBESTDEALCOMDE'
}
]
})
};
fetch('https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping', 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://scx-sbx.api.jtl-software.com/v1/seller/order/shipping",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'orderList' => [
[
'sellerId' => '4711',
'orderId' => '43523-43432-43532',
'shippingComplete' => true,
'shippingItems' => [
[
'carrier' => 'DHL',
'trackingNumber' => '23435833543343222322',
'trackingUrl' => 'https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322',
'returnTracking' => [
'carrier' => 'DHL',
'trackingNumber' => '432353833232443222322',
'trackingUrl' => 'https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322'
],
'shippedAt' => '2019-01-13T12:00:00+00:00',
'orderItemIdList' => [
[
'orderItemId' => '5437233',
'quantity' => 123
]
],
'shippedFrom' => [
'city' => 'Köln',
'country' => 'DE',
'postcode' => '51107'
]
]
],
'channel' => 'MYBESTDEALCOMDE'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://scx-sbx.api.jtl-software.com/v1/seller/order/shipping"
payload := strings.NewReader("{\n \"orderList\": [\n {\n \"sellerId\": \"4711\",\n \"orderId\": \"43523-43432-43532\",\n \"shippingComplete\": true,\n \"shippingItems\": [\n {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"23435833543343222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322\",\n \"returnTracking\": {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"432353833232443222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322\"\n },\n \"shippedAt\": \"2019-01-13T12:00:00+00:00\",\n \"orderItemIdList\": [\n {\n \"orderItemId\": \"5437233\",\n \"quantity\": 123\n }\n ],\n \"shippedFrom\": {\n \"city\": \"Köln\",\n \"country\": \"DE\",\n \"postcode\": \"51107\"\n }\n }\n ],\n \"channel\": \"MYBESTDEALCOMDE\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderList\": [\n {\n \"sellerId\": \"4711\",\n \"orderId\": \"43523-43432-43532\",\n \"shippingComplete\": true,\n \"shippingItems\": [\n {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"23435833543343222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322\",\n \"returnTracking\": {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"432353833232443222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322\"\n },\n \"shippedAt\": \"2019-01-13T12:00:00+00:00\",\n \"orderItemIdList\": [\n {\n \"orderItemId\": \"5437233\",\n \"quantity\": 123\n }\n ],\n \"shippedFrom\": {\n \"city\": \"Köln\",\n \"country\": \"DE\",\n \"postcode\": \"51107\"\n }\n }\n ],\n \"channel\": \"MYBESTDEALCOMDE\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://scx-sbx.api.jtl-software.com/v1/seller/order/shipping")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderList\": [\n {\n \"sellerId\": \"4711\",\n \"orderId\": \"43523-43432-43532\",\n \"shippingComplete\": true,\n \"shippingItems\": [\n {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"23435833543343222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322\",\n \"returnTracking\": {\n \"carrier\": \"DHL\",\n \"trackingNumber\": \"432353833232443222322\",\n \"trackingUrl\": \"https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322\"\n },\n \"shippedAt\": \"2019-01-13T12:00:00+00:00\",\n \"orderItemIdList\": [\n {\n \"orderItemId\": \"5437233\",\n \"quantity\": 123\n }\n ],\n \"shippedFrom\": {\n \"city\": \"Köln\",\n \"country\": \"DE\",\n \"postcode\": \"51107\"\n }\n }\n ],\n \"channel\": \"MYBESTDEALCOMDE\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"errorList": [
{
"code": "VAL100",
"message": "Required field sellerId not found",
"severity": "error",
"hint": "Check the field `sellerId` — it must be a non-empty string."
}
]
}{
"errorList": [
{
"code": "GEN500",
"message": "Internal Server Error",
"severity": "error",
"hint": null
}
]
}Authorizations
Bearer JWT issued to a seller after they sign up for a JTL-Scx subscription via the JTL
Customer Center. Usage format: Bearer <JWT>.
Body
application/json
Shipping notification for one or more order line items, including carrier and tracking information.
Batch of shipping notifications for marketplace orders (carrier, tracking number, ship date).
Show child attributes
Show child attributes
Response
Created
Was this page helpful?
⌘I