Modifies an existing sales order.
curl --request PATCH \
--url https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"billingAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shipmentAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"lineItems": [
{
"salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"discountPercent": 123,
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"name": "<string>",
"note": "<string>",
"quantity": 123,
"salesPriceNet": 123,
"salesUnit": "<string>",
"sku": "<string>",
"taxRate": 123
}
]
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}"
payload = {
"companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"billingAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shipmentAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"lineItems": [
{
"salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"discountPercent": 123,
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"name": "<string>",
"note": "<string>",
"quantity": 123,
"salesPriceNet": 123,
"salesUnit": "<string>",
"sku": "<string>",
"taxRate": 123
}
]
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-tenant-id': '<x-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
customerId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
billingAddress: {
salutation: '<string>',
title: '<string>',
firstName: '<string>',
lastName: '<string>',
company: '<string>',
additionalCompanyLine: '<string>',
street: '<string>',
additionalAddressLine: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>',
countryIso: '<string>',
postId: '<string>',
emailAddress: '<string>',
phoneNumber: '<string>',
mobilePhoneNumber: '<string>',
fax: '<string>',
vatId: '<string>'
},
shipmentAddress: {
salutation: '<string>',
title: '<string>',
firstName: '<string>',
lastName: '<string>',
company: '<string>',
additionalCompanyLine: '<string>',
street: '<string>',
additionalAddressLine: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>',
countryIso: '<string>',
postId: '<string>',
emailAddress: '<string>',
phoneNumber: '<string>',
mobilePhoneNumber: '<string>',
fax: '<string>',
vatId: '<string>'
},
shippingMethodId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
paymentMethodId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
lineItems: [
{
salesOrderLineItemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
taxClassId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
taxCodeId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
discountPercent: 123,
itemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
name: '<string>',
note: '<string>',
quantity: 123,
salesPriceNet: 123,
salesUnit: '<string>',
sku: '<string>',
taxRate: 123
}
]
})
};
fetch('https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}', 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/sales-orders/{salesOrderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'customerId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'billingAddress' => [
'salutation' => '<string>',
'title' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'company' => '<string>',
'additionalCompanyLine' => '<string>',
'street' => '<string>',
'additionalAddressLine' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>',
'countryIso' => '<string>',
'postId' => '<string>',
'emailAddress' => '<string>',
'phoneNumber' => '<string>',
'mobilePhoneNumber' => '<string>',
'fax' => '<string>',
'vatId' => '<string>'
],
'shipmentAddress' => [
'salutation' => '<string>',
'title' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'company' => '<string>',
'additionalCompanyLine' => '<string>',
'street' => '<string>',
'additionalAddressLine' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>',
'countryIso' => '<string>',
'postId' => '<string>',
'emailAddress' => '<string>',
'phoneNumber' => '<string>',
'mobilePhoneNumber' => '<string>',
'fax' => '<string>',
'vatId' => '<string>'
],
'shippingMethodId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'paymentMethodId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'lineItems' => [
[
'salesOrderLineItemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'taxClassId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'taxCodeId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'discountPercent' => 123,
'itemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'name' => '<string>',
'note' => '<string>',
'quantity' => 123,
'salesPriceNet' => 123,
'salesUnit' => '<string>',
'sku' => '<string>',
'taxRate' => 123
]
]
]),
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/sales-orders/{salesOrderId}"
payload := strings.NewReader("{\n \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"customerId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"billingAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shipmentAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"paymentMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"lineItems\": [\n {\n \"salesOrderLineItemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxClassId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxCodeId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"discountPercent\": 123,\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"quantity\": 123,\n \"salesPriceNet\": 123,\n \"salesUnit\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxRate\": 123\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"customerId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"billingAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shipmentAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"paymentMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"lineItems\": [\n {\n \"salesOrderLineItemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxClassId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxCodeId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"discountPercent\": 123,\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"quantity\": 123,\n \"salesPriceNet\": 123,\n \"salesUnit\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxRate\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"customerId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"billingAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shipmentAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"paymentMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"lineItems\": [\n {\n \"salesOrderLineItemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxClassId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxCodeId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"discountPercent\": 123,\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"quantity\": 123,\n \"salesPriceNet\": 123,\n \"salesUnit\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxRate\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}Sales Order
Modifies an existing sales order.
Modifies an existing sales order.
PATCH
/
v2
/
sales-orders
/
{salesOrderId}
Modifies an existing sales order.
curl --request PATCH \
--url https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"billingAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shipmentAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"lineItems": [
{
"salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"discountPercent": 123,
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"name": "<string>",
"note": "<string>",
"quantity": 123,
"salesPriceNet": 123,
"salesUnit": "<string>",
"sku": "<string>",
"taxRate": 123
}
]
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}"
payload = {
"companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"billingAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shipmentAddress": {
"salutation": "<string>",
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"additionalCompanyLine": "<string>",
"street": "<string>",
"additionalAddressLine": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"countryIso": "<string>",
"postId": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"mobilePhoneNumber": "<string>",
"fax": "<string>",
"vatId": "<string>"
},
"shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"lineItems": [
{
"salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"discountPercent": 123,
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"name": "<string>",
"note": "<string>",
"quantity": 123,
"salesPriceNet": 123,
"salesUnit": "<string>",
"sku": "<string>",
"taxRate": 123
}
]
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-tenant-id': '<x-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
customerId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
billingAddress: {
salutation: '<string>',
title: '<string>',
firstName: '<string>',
lastName: '<string>',
company: '<string>',
additionalCompanyLine: '<string>',
street: '<string>',
additionalAddressLine: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>',
countryIso: '<string>',
postId: '<string>',
emailAddress: '<string>',
phoneNumber: '<string>',
mobilePhoneNumber: '<string>',
fax: '<string>',
vatId: '<string>'
},
shipmentAddress: {
salutation: '<string>',
title: '<string>',
firstName: '<string>',
lastName: '<string>',
company: '<string>',
additionalCompanyLine: '<string>',
street: '<string>',
additionalAddressLine: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>',
countryIso: '<string>',
postId: '<string>',
emailAddress: '<string>',
phoneNumber: '<string>',
mobilePhoneNumber: '<string>',
fax: '<string>',
vatId: '<string>'
},
shippingMethodId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
paymentMethodId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
lineItems: [
{
salesOrderLineItemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
taxClassId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
taxCodeId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
discountPercent: 123,
itemId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
name: '<string>',
note: '<string>',
quantity: 123,
salesPriceNet: 123,
salesUnit: '<string>',
sku: '<string>',
taxRate: 123
}
]
})
};
fetch('https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}', 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/sales-orders/{salesOrderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'customerId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'billingAddress' => [
'salutation' => '<string>',
'title' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'company' => '<string>',
'additionalCompanyLine' => '<string>',
'street' => '<string>',
'additionalAddressLine' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>',
'countryIso' => '<string>',
'postId' => '<string>',
'emailAddress' => '<string>',
'phoneNumber' => '<string>',
'mobilePhoneNumber' => '<string>',
'fax' => '<string>',
'vatId' => '<string>'
],
'shipmentAddress' => [
'salutation' => '<string>',
'title' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'company' => '<string>',
'additionalCompanyLine' => '<string>',
'street' => '<string>',
'additionalAddressLine' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>',
'countryIso' => '<string>',
'postId' => '<string>',
'emailAddress' => '<string>',
'phoneNumber' => '<string>',
'mobilePhoneNumber' => '<string>',
'fax' => '<string>',
'vatId' => '<string>'
],
'shippingMethodId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'paymentMethodId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'lineItems' => [
[
'salesOrderLineItemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'taxClassId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'taxCodeId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'discountPercent' => 123,
'itemId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'name' => '<string>',
'note' => '<string>',
'quantity' => 123,
'salesPriceNet' => 123,
'salesUnit' => '<string>',
'sku' => '<string>',
'taxRate' => 123
]
]
]),
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/sales-orders/{salesOrderId}"
payload := strings.NewReader("{\n \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"customerId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"billingAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shipmentAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"paymentMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"lineItems\": [\n {\n \"salesOrderLineItemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxClassId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxCodeId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"discountPercent\": 123,\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"quantity\": 123,\n \"salesPriceNet\": 123,\n \"salesUnit\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxRate\": 123\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"customerId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"billingAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shipmentAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"paymentMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"lineItems\": [\n {\n \"salesOrderLineItemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxClassId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxCodeId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"discountPercent\": 123,\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"quantity\": 123,\n \"salesPriceNet\": 123,\n \"salesUnit\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxRate\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/sales-orders/{salesOrderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"customerId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"billingAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shipmentAddress\": {\n \"salutation\": \"<string>\",\n \"title\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"company\": \"<string>\",\n \"additionalCompanyLine\": \"<string>\",\n \"street\": \"<string>\",\n \"additionalAddressLine\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"postId\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"fax\": \"<string>\",\n \"vatId\": \"<string>\"\n },\n \"shippingMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"paymentMethodId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"lineItems\": [\n {\n \"salesOrderLineItemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxClassId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"taxCodeId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"discountPercent\": 123,\n \"itemId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"quantity\": 123,\n \"salesPriceNet\": 123,\n \"salesUnit\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxRate\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}Authorizations
oauth2-authorization-codeoauth2-client-credentials
The access token received from the authorization server in the OAuth 2.0 flow.
FlowAuthorization Code
- Authorization URL
- https://auth.jtl-cloud.com/oauth2/auth
- Token URL
- https://auth.jtl-cloud.com/oauth2/token
Scopes1
salesorders.write
Grants permission to create and modify sales orders.
Headers
The Company-Id (int or uuid) of the company on whose behalf the request is executed.
The tenant ID for the target ERP instance.
Path Parameters
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Body
application/json
Request parameters
Modifies an existing sales order. - Request
Unique ID of the company.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The ID of the customer associated with the sales order.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
SalesOrderBillingAddress
Show child attributes
Show child attributes
SalesOrderBillingAddress
Show child attributes
Show child attributes
The ID of the shipping method for the sales order.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The ID of the payment method for the sales order.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The line items included in the sales order.
Show child attributes
Show child attributes
Response
SalesOrder was successfully modified.
Modifies an existing sales order. - Response
Unique ID of the modified sales order.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Was this page helpful?