Declaratively replaces the complete set of customer-group mappings of a connector account and pushes the resulting mapping live to the Connector endpoint.

curl --request PUT \
  --url https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "customerGroups": [
    {
      "endpointId": "<string>",
      "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ]
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups"

payload = { "customerGroups": [
        {
            "endpointId": "<string>",
            "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
        }
    ] }
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerGroups: [
      {
        endpointId: '<string>',
        customerGroupId: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
      }
    ]
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups', 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-channels/{salesChannelId}/connector/customer-groups",
  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([
    'customerGroups' => [
        [
                'endpointId' => '<string>',
                'customerGroupId' => '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/sales-channels/{salesChannelId}/connector/customer-groups"

	payload := strings.NewReader("{\n  \"customerGroups\": [\n    {\n      \"endpointId\": \"<string>\",\n      \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerGroups\": [\n    {\n      \"endpointId\": \"<string>\",\n      \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerGroups\": [\n    {\n      \"endpointId\": \"<string>\",\n      \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "customerGroups": [
    {
      "endpointId": "<string>",
      "isDefault": true,
      "endpointName": "<string>",
      "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "liveSyncStatus": 0,
  "liveSyncError": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

wawi

Declaratively replaces the complete set of customer-group mappings of a connector account and pushes the resulting mapping live to the Connector endpoint.

Declaratively replaces the complete set of customer-group mappings of a connector account and pushes the resulting mapping live to the Connector endpoint. The request describes the full desired state - provided assignments are upserted and every mapping not contained in the request is cleared. An EndpointId that is neither already mapped nor currently reported by the Connector endpoint (stale data) is silently ignored, exactly as if it had not been submitted. Persistence of the resulting write always succeeds independently of the later live push outcome; a failed or timed-out live push is reported via LiveSyncStatus/LiveSyncError but does not roll back the persisted assignments or change the response code. This command has no IsDefault input - a customer group’s default flag, like its display name, is reported by the Connector endpoint itself; it is never accepted from or echoed back with authority by this write path, so a GET-modify-PUT round trip cannot change or need to preserve it. For an EndpointId not already mapped, EndpointName/IsDefault are instead resolved with one live read from the Connector endpoint before anything is persisted - unlike the later live push, a failure of this live read does fail the whole request (502/504) and persists nothing, because it is needed to build a valid response.

PUT

sales-channels

{salesChannelId}

connector

customer-groups

Declaratively replaces the complete set of customer-group mappings of a connector account and pushes the resulting mapping live to the Connector endpoint.

curl --request PUT \
  --url https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "customerGroups": [
    {
      "endpointId": "<string>",
      "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ]
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups"

payload = { "customerGroups": [
        {
            "endpointId": "<string>",
            "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
        }
    ] }
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerGroups: [
      {
        endpointId: '<string>',
        customerGroupId: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
      }
    ]
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups', 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-channels/{salesChannelId}/connector/customer-groups",
  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([
    'customerGroups' => [
        [
                'endpointId' => '<string>',
                'customerGroupId' => '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/sales-channels/{salesChannelId}/connector/customer-groups"

	payload := strings.NewReader("{\n  \"customerGroups\": [\n    {\n      \"endpointId\": \"<string>\",\n      \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerGroups\": [\n    {\n      \"endpointId\": \"<string>\",\n      \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/customer-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerGroups\": [\n    {\n      \"endpointId\": \"<string>\",\n      \"customerGroupId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "customerGroups": [
    {
      "endpointId": "<string>",
      "isDefault": true,
      "endpointName": "<string>",
      "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "liveSyncStatus": 0,
  "liveSyncError": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "/api/route",
  "traceId": "0HMPNHL0JHL76:00000001",
  "detail": "<string>",
  "errors": [
    {
      "name": "Error or field name",
      "reason": "Error reason",
      "code": "<string>",
      "severity": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Path Parameters

salesChannelId

string

required

Sales channel id of the Connector whose customer groups are replaced.

Body

application/json

Request model for SaveConnectorCustomerGroups command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

customerGroups

object[]

required

The complete desired set of customer-group mappings for the connector account. Any existing mapping not contained in this list is cleared.

Show child attributes

Response

Successfully replaced the customer-group mappings. Returns the persisted mappings together with the outcome of the live push to the Connector endpoint.

Declaratively replaces the complete set of customer-group mappings of a connector account and pushes the resulting mapping live to the Connector endpoint. The request describes the full desired state - provided assignments are upserted and every mapping not contained in the request is cleared. An EndpointId that is neither already mapped nor currently reported by the Connector endpoint (stale data) is silently ignored, exactly as if it had not been submitted. Persistence of the resulting write always succeeds independently of the later live push outcome; a failed or timed-out live push is reported via LiveSyncStatus/LiveSyncError but does not roll back the persisted assignments or change the response code. This command has no IsDefault input - a customer group's default flag, like its display name, is reported by the Connector endpoint itself; it is never accepted from or echoed back with authority by this write path, so a GET-modify-PUT round trip cannot change or need to preserve it. For an EndpointId not already mapped, EndpointName/IsDefault are instead resolved with one live read from the Connector endpoint before anything is persisted - unlike the later live push, a failure of this live read does fail the whole request (502/504) and persists nothing, because it is needed to build a valid response. - Response

customerGroups

object[]

required

The persisted customer-group mappings, minus any submitted EndpointId ignored as stale (see the command description). For an EndpointId already mapped, EndpointName/IsDefault are carried over unchanged from the previously persisted state, exactly as before this call. For a first-time EndpointId, both are instead resolved from a live read performed before persisting, so IsDefault is always a definite, known value here too, never a guess - EndpointName can still be null there if the endpoint itself reports no usable localized name for that group, the same case QueryConnectorCustomerGroups already tolerates. This list is independent of the later live push outcome reported in LiveSyncStatus/LiveSyncError - it reflects what was persisted, not a re-pull after that push, so it does not depend on or wait for the push to succeed.

Show child attributes

liveSyncStatus

enum<integer>

required

Outcome of the live push to the Connector endpoint.

Available options:

0,

1,

2,

3

liveSyncError

object

required

Details of the live sync outcome. Code and Message are not set when LiveSyncStatus is Synced (omitted in REST JSON, null in GraphQL), and populated when it is SyncFailed or SyncTimedOut. Always present as an object (rather than the field itself being nullable) because Command response properties do not support optional-field validation the way GET model properties do - this shape sidesteps that generator limitation.

Show child attributes

⌘I

Overview

GraphQL

REST API

Declaratively replaces the complete set of customer-group mappings of a connector account and pushes the resulting mapping live to the Connector endpoint.

Authorizations

Headers

Path Parameters

Body

Response