Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options.
curl --request POST \
--url https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"variation": {
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"position": 123,
"values": [
{
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationValueId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemNumber": "<string>",
"gTIN": "<string>",
"weightOffset": 123,
"surcharges": {
"defaultSurchargeNet": 123,
"customerGroupSurcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": true
}
],
"salesChannelSurcharges": [
{
"salesChannelId": "<string>",
"surcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": true
}
]
}
]
},
"position": 123,
"image": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
]
}
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations"
payload = { "variation": {
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"position": 123,
"values": [
{
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationValueId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemNumber": "<string>",
"gTIN": "<string>",
"weightOffset": 123,
"surcharges": {
"defaultSurchargeNet": 123,
"customerGroupSurcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": True
}
],
"salesChannelSurcharges": [
{
"salesChannelId": "<string>",
"surcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": True
}
]
}
]
},
"position": 123,
"image": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
]
} }
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({
variation: {
descriptions: [{languageIso: '<string>', name: '<string>'}],
variationId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
position: 123,
values: [
{
descriptions: [{languageIso: '<string>', name: '<string>'}],
variationValueId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
itemNumber: '<string>',
gTIN: '<string>',
weightOffset: 123,
surcharges: {
defaultSurchargeNet: 123,
customerGroupSurcharges: [
{
customerGroupId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
surcharge: 123,
isActive: true
}
],
salesChannelSurcharges: [
{
salesChannelId: '<string>',
surcharges: [
{
customerGroupId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
surcharge: 123,
isActive: true
}
]
}
]
},
position: 123,
image: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
}
]
}
})
};
fetch('https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations', 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/items/{itemId}/variations",
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([
'variation' => [
'descriptions' => [
[
'languageIso' => '<string>',
'name' => '<string>'
]
],
'variationId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'position' => 123,
'values' => [
[
'descriptions' => [
[
'languageIso' => '<string>',
'name' => '<string>'
]
],
'variationValueId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'itemNumber' => '<string>',
'gTIN' => '<string>',
'weightOffset' => 123,
'surcharges' => [
'defaultSurchargeNet' => 123,
'customerGroupSurcharges' => [
[
'customerGroupId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'surcharge' => 123,
'isActive' => true
]
],
'salesChannelSurcharges' => [
[
'salesChannelId' => '<string>',
'surcharges' => [
[
'customerGroupId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'surcharge' => 123,
'isActive' => true
]
]
]
]
],
'position' => 123,
'image' => 'b45f6432-2462-4c6f-b00f-1d9d01000000'
]
]
]
]),
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/items/{itemId}/variations"
payload := strings.NewReader("{\n \"variation\": {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"position\": 123,\n \"values\": [\n {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationValueId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemNumber\": \"<string>\",\n \"gTIN\": \"<string>\",\n \"weightOffset\": 123,\n \"surcharges\": {\n \"defaultSurchargeNet\": 123,\n \"customerGroupSurcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ],\n \"salesChannelSurcharges\": [\n {\n \"salesChannelId\": \"<string>\",\n \"surcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ]\n }\n ]\n },\n \"position\": 123,\n \"image\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ]\n }\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/items/{itemId}/variations")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"variation\": {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"position\": 123,\n \"values\": [\n {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationValueId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemNumber\": \"<string>\",\n \"gTIN\": \"<string>\",\n \"weightOffset\": 123,\n \"surcharges\": {\n \"defaultSurchargeNet\": 123,\n \"customerGroupSurcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ],\n \"salesChannelSurcharges\": [\n {\n \"salesChannelId\": \"<string>\",\n \"surcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ]\n }\n ]\n },\n \"position\": 123,\n \"image\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations")
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 \"variation\": {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"position\": 123,\n \"values\": [\n {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationValueId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemNumber\": \"<string>\",\n \"gTIN\": \"<string>\",\n \"weightOffset\": 123,\n \"surcharges\": {\n \"defaultSurchargeNet\": 123,\n \"customerGroupSurcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ],\n \"salesChannelSurcharges\": [\n {\n \"salesChannelId\": \"<string>\",\n \"surcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ]\n }\n ]\n },\n \"position\": 123,\n \"image\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"variationId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}Item
Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options.
Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options.
POST
/
v2
/
items
/
{itemId}
/
variations
Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options.
curl --request POST \
--url https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"variation": {
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"position": 123,
"values": [
{
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationValueId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemNumber": "<string>",
"gTIN": "<string>",
"weightOffset": 123,
"surcharges": {
"defaultSurchargeNet": 123,
"customerGroupSurcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": true
}
],
"salesChannelSurcharges": [
{
"salesChannelId": "<string>",
"surcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": true
}
]
}
]
},
"position": 123,
"image": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
]
}
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations"
payload = { "variation": {
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"position": 123,
"values": [
{
"descriptions": [
{
"languageIso": "<string>",
"name": "<string>"
}
],
"variationValueId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemNumber": "<string>",
"gTIN": "<string>",
"weightOffset": 123,
"surcharges": {
"defaultSurchargeNet": 123,
"customerGroupSurcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": True
}
],
"salesChannelSurcharges": [
{
"salesChannelId": "<string>",
"surcharges": [
{
"customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"surcharge": 123,
"isActive": True
}
]
}
]
},
"position": 123,
"image": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
]
} }
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({
variation: {
descriptions: [{languageIso: '<string>', name: '<string>'}],
variationId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
position: 123,
values: [
{
descriptions: [{languageIso: '<string>', name: '<string>'}],
variationValueId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
itemNumber: '<string>',
gTIN: '<string>',
weightOffset: 123,
surcharges: {
defaultSurchargeNet: 123,
customerGroupSurcharges: [
{
customerGroupId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
surcharge: 123,
isActive: true
}
],
salesChannelSurcharges: [
{
salesChannelId: '<string>',
surcharges: [
{
customerGroupId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
surcharge: 123,
isActive: true
}
]
}
]
},
position: 123,
image: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
}
]
}
})
};
fetch('https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations', 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/items/{itemId}/variations",
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([
'variation' => [
'descriptions' => [
[
'languageIso' => '<string>',
'name' => '<string>'
]
],
'variationId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'position' => 123,
'values' => [
[
'descriptions' => [
[
'languageIso' => '<string>',
'name' => '<string>'
]
],
'variationValueId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'itemNumber' => '<string>',
'gTIN' => '<string>',
'weightOffset' => 123,
'surcharges' => [
'defaultSurchargeNet' => 123,
'customerGroupSurcharges' => [
[
'customerGroupId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'surcharge' => 123,
'isActive' => true
]
],
'salesChannelSurcharges' => [
[
'salesChannelId' => '<string>',
'surcharges' => [
[
'customerGroupId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'surcharge' => 123,
'isActive' => true
]
]
]
]
],
'position' => 123,
'image' => 'b45f6432-2462-4c6f-b00f-1d9d01000000'
]
]
]
]),
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/items/{itemId}/variations"
payload := strings.NewReader("{\n \"variation\": {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"position\": 123,\n \"values\": [\n {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationValueId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemNumber\": \"<string>\",\n \"gTIN\": \"<string>\",\n \"weightOffset\": 123,\n \"surcharges\": {\n \"defaultSurchargeNet\": 123,\n \"customerGroupSurcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ],\n \"salesChannelSurcharges\": [\n {\n \"salesChannelId\": \"<string>\",\n \"surcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ]\n }\n ]\n },\n \"position\": 123,\n \"image\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ]\n }\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/items/{itemId}/variations")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"variation\": {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"position\": 123,\n \"values\": [\n {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationValueId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemNumber\": \"<string>\",\n \"gTIN\": \"<string>\",\n \"weightOffset\": 123,\n \"surcharges\": {\n \"defaultSurchargeNet\": 123,\n \"customerGroupSurcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ],\n \"salesChannelSurcharges\": [\n {\n \"salesChannelId\": \"<string>\",\n \"surcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ]\n }\n ]\n },\n \"position\": 123,\n \"image\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/items/{itemId}/variations")
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 \"variation\": {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"position\": 123,\n \"values\": [\n {\n \"descriptions\": [\n {\n \"languageIso\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"variationValueId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"itemNumber\": \"<string>\",\n \"gTIN\": \"<string>\",\n \"weightOffset\": 123,\n \"surcharges\": {\n \"defaultSurchargeNet\": 123,\n \"customerGroupSurcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ],\n \"salesChannelSurcharges\": [\n {\n \"salesChannelId\": \"<string>\",\n \"surcharges\": [\n {\n \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"surcharge\": 123,\n \"isActive\": true\n }\n ]\n }\n ]\n },\n \"position\": 123,\n \"image\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"variationId": "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.
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
Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options. - Request
The variation to add including type (selectbox, radio, etc.), descriptions in multiple languages, and optional variation values.
Show child attributes
Show child attributes
Response
Variation was successfully added to the item.
Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options. - Response
Unique ID of the newly added variation.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Was this page helpful?
Adds a new value to an existing item variation.Removes an existing variation from an item. All associated variation values and combinations will also be removed.
⌘I