Replaces the persisted synchronisation configuration (dbo.tShopKonfiguration) of a connector account.

curl --request PUT \
  --url https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/configuration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "canImport": true,
  "shouldImportItemsAndCategories": true,
  "shouldImportOrdersAndCustomers": true,
  "shouldImportImages": true,
  "canUpload": true,
  "shouldUploadItemComplete": true,
  "shouldUploadItemPriceRestricted": true,
  "shouldUploadItemStockRestricted": true,
  "shouldUploadCustomers": true,
  "shouldUploadImages": true,
  "shouldRefreshExistingItems": true,
  "shouldRefreshCustomers": true,
  "shouldDeleteImagesOnImport": true,
  "shouldWawiCalculateTaxRate": true,
  "shouldWawiCalculateTaxRateForShipping": true,
  "pullCount": 123,
  "quickSyncCount": 123,
  "sendOnlyAssignedManufacturers": true,
  "maximumTransferRate": 123,
  "imagesCount": 123,
  "entityCount": 123,
  "shippingCountryIso": "<string>"
}
'

import requests

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

payload = {
    "canImport": True,
    "shouldImportItemsAndCategories": True,
    "shouldImportOrdersAndCustomers": True,
    "shouldImportImages": True,
    "canUpload": True,
    "shouldUploadItemComplete": True,
    "shouldUploadItemPriceRestricted": True,
    "shouldUploadItemStockRestricted": True,
    "shouldUploadCustomers": True,
    "shouldUploadImages": True,
    "shouldRefreshExistingItems": True,
    "shouldRefreshCustomers": True,
    "shouldDeleteImagesOnImport": True,
    "shouldWawiCalculateTaxRate": True,
    "shouldWawiCalculateTaxRateForShipping": True,
    "pullCount": 123,
    "quickSyncCount": 123,
    "sendOnlyAssignedManufacturers": True,
    "maximumTransferRate": 123,
    "imagesCount": 123,
    "entityCount": 123,
    "shippingCountryIso": "<string>"
}
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({
    canImport: true,
    shouldImportItemsAndCategories: true,
    shouldImportOrdersAndCustomers: true,
    shouldImportImages: true,
    canUpload: true,
    shouldUploadItemComplete: true,
    shouldUploadItemPriceRestricted: true,
    shouldUploadItemStockRestricted: true,
    shouldUploadCustomers: true,
    shouldUploadImages: true,
    shouldRefreshExistingItems: true,
    shouldRefreshCustomers: true,
    shouldDeleteImagesOnImport: true,
    shouldWawiCalculateTaxRate: true,
    shouldWawiCalculateTaxRateForShipping: true,
    pullCount: 123,
    quickSyncCount: 123,
    sendOnlyAssignedManufacturers: true,
    maximumTransferRate: 123,
    imagesCount: 123,
    entityCount: 123,
    shippingCountryIso: '<string>'
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/configuration', 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/configuration",
  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([
    'canImport' => true,
    'shouldImportItemsAndCategories' => true,
    'shouldImportOrdersAndCustomers' => true,
    'shouldImportImages' => true,
    'canUpload' => true,
    'shouldUploadItemComplete' => true,
    'shouldUploadItemPriceRestricted' => true,
    'shouldUploadItemStockRestricted' => true,
    'shouldUploadCustomers' => true,
    'shouldUploadImages' => true,
    'shouldRefreshExistingItems' => true,
    'shouldRefreshCustomers' => true,
    'shouldDeleteImagesOnImport' => true,
    'shouldWawiCalculateTaxRate' => true,
    'shouldWawiCalculateTaxRateForShipping' => true,
    'pullCount' => 123,
    'quickSyncCount' => 123,
    'sendOnlyAssignedManufacturers' => true,
    'maximumTransferRate' => 123,
    'imagesCount' => 123,
    'entityCount' => 123,
    'shippingCountryIso' => '<string>'
  ]),
  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/configuration"

	payload := strings.NewReader("{\n  \"canImport\": true,\n  \"shouldImportItemsAndCategories\": true,\n  \"shouldImportOrdersAndCustomers\": true,\n  \"shouldImportImages\": true,\n  \"canUpload\": true,\n  \"shouldUploadItemComplete\": true,\n  \"shouldUploadItemPriceRestricted\": true,\n  \"shouldUploadItemStockRestricted\": true,\n  \"shouldUploadCustomers\": true,\n  \"shouldUploadImages\": true,\n  \"shouldRefreshExistingItems\": true,\n  \"shouldRefreshCustomers\": true,\n  \"shouldDeleteImagesOnImport\": true,\n  \"shouldWawiCalculateTaxRate\": true,\n  \"shouldWawiCalculateTaxRateForShipping\": true,\n  \"pullCount\": 123,\n  \"quickSyncCount\": 123,\n  \"sendOnlyAssignedManufacturers\": true,\n  \"maximumTransferRate\": 123,\n  \"imagesCount\": 123,\n  \"entityCount\": 123,\n  \"shippingCountryIso\": \"<string>\"\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/configuration")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"canImport\": true,\n  \"shouldImportItemsAndCategories\": true,\n  \"shouldImportOrdersAndCustomers\": true,\n  \"shouldImportImages\": true,\n  \"canUpload\": true,\n  \"shouldUploadItemComplete\": true,\n  \"shouldUploadItemPriceRestricted\": true,\n  \"shouldUploadItemStockRestricted\": true,\n  \"shouldUploadCustomers\": true,\n  \"shouldUploadImages\": true,\n  \"shouldRefreshExistingItems\": true,\n  \"shouldRefreshCustomers\": true,\n  \"shouldDeleteImagesOnImport\": true,\n  \"shouldWawiCalculateTaxRate\": true,\n  \"shouldWawiCalculateTaxRateForShipping\": true,\n  \"pullCount\": 123,\n  \"quickSyncCount\": 123,\n  \"sendOnlyAssignedManufacturers\": true,\n  \"maximumTransferRate\": 123,\n  \"imagesCount\": 123,\n  \"entityCount\": 123,\n  \"shippingCountryIso\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"canImport\": true,\n  \"shouldImportItemsAndCategories\": true,\n  \"shouldImportOrdersAndCustomers\": true,\n  \"shouldImportImages\": true,\n  \"canUpload\": true,\n  \"shouldUploadItemComplete\": true,\n  \"shouldUploadItemPriceRestricted\": true,\n  \"shouldUploadItemStockRestricted\": true,\n  \"shouldUploadCustomers\": true,\n  \"shouldUploadImages\": true,\n  \"shouldRefreshExistingItems\": true,\n  \"shouldRefreshCustomers\": true,\n  \"shouldDeleteImagesOnImport\": true,\n  \"shouldWawiCalculateTaxRate\": true,\n  \"shouldWawiCalculateTaxRateForShipping\": true,\n  \"pullCount\": 123,\n  \"quickSyncCount\": 123,\n  \"sendOnlyAssignedManufacturers\": true,\n  \"maximumTransferRate\": 123,\n  \"imagesCount\": 123,\n  \"entityCount\": 123,\n  \"shippingCountryIso\": \"<string>\"\n}"

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

{
  "canImport": true,
  "shouldImportItemsAndCategories": true,
  "shouldImportOrdersAndCustomers": true,
  "shouldImportImages": true,
  "canUpload": true,
  "shouldUploadItemComplete": true,
  "shouldUploadItemPriceRestricted": true,
  "shouldUploadItemStockRestricted": true,
  "shouldUploadCustomers": true,
  "shouldUploadImages": true,
  "shouldRefreshExistingItems": true,
  "shouldRefreshCustomers": true,
  "shouldDeleteImagesOnImport": true,
  "shouldWawiCalculateTaxRate": true,
  "shouldWawiCalculateTaxRateForShipping": true,
  "pullCount": 123,
  "quickSyncCount": 123,
  "sendOnlyAssignedManufacturers": true,
  "maximumTransferRate": 123,
  "imagesCount": 123,
  "entityCount": 123,
  "shippingCountryIso": "<string>",
  "dummyCategoryId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

{
  "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

Replaces the persisted synchronisation configuration (dbo.tShopKonfiguration) of a connector account.

Replaces the persisted synchronisation configuration (dbo.tShopKonfiguration) of a connector account. Section-scoped: no other part of the connector account - base data, credentials, customer groups, languages, currencies, shipping methods - is read or written. Full replacement, not a patch: the request describes the complete desired state of the configuration section, and every writable field must be sent. Omitting an optional field sets it to null (its documented ‘unrestricted / not set’ meaning), so a GET-modify-PUT round trip is the intended usage; use UpdateConnector for field-wise partial updates. A connector account that has no configuration row yet gets one created by this call, which is why a partial write is not offered here - ‘leave unchanged’ has no meaning against a row that does not exist. Persists only: it does not contact the Connector endpoint at any point. Two groups of ConnectorConfiguration fields are deliberately not writable and are not part of this request. Live-only fields reported by the connected endpoint’s handshake (PlatformName, PlatformVersion, ProtocolVersion, EndpointVersion, IsOldConnector, ServerInfo) are not persisted at all and can never be written. DummyCategoryId is system-managed - the import pipeline assigns the fallback category itself when an imported product has no category - so it is read-only here and its stored value is preserved unchanged by this call. Submitting any of those names is not an error on REST, where unknown body properties are ignored; on GraphQL the schema rejects them as unknown input fields.

PUT

sales-channels

{salesChannelId}

connector

configuration

Replaces the persisted synchronisation configuration (dbo.tShopKonfiguration) of a connector account.

curl --request PUT \
  --url https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/configuration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "canImport": true,
  "shouldImportItemsAndCategories": true,
  "shouldImportOrdersAndCustomers": true,
  "shouldImportImages": true,
  "canUpload": true,
  "shouldUploadItemComplete": true,
  "shouldUploadItemPriceRestricted": true,
  "shouldUploadItemStockRestricted": true,
  "shouldUploadCustomers": true,
  "shouldUploadImages": true,
  "shouldRefreshExistingItems": true,
  "shouldRefreshCustomers": true,
  "shouldDeleteImagesOnImport": true,
  "shouldWawiCalculateTaxRate": true,
  "shouldWawiCalculateTaxRateForShipping": true,
  "pullCount": 123,
  "quickSyncCount": 123,
  "sendOnlyAssignedManufacturers": true,
  "maximumTransferRate": 123,
  "imagesCount": 123,
  "entityCount": 123,
  "shippingCountryIso": "<string>"
}
'

import requests

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

payload = {
    "canImport": True,
    "shouldImportItemsAndCategories": True,
    "shouldImportOrdersAndCustomers": True,
    "shouldImportImages": True,
    "canUpload": True,
    "shouldUploadItemComplete": True,
    "shouldUploadItemPriceRestricted": True,
    "shouldUploadItemStockRestricted": True,
    "shouldUploadCustomers": True,
    "shouldUploadImages": True,
    "shouldRefreshExistingItems": True,
    "shouldRefreshCustomers": True,
    "shouldDeleteImagesOnImport": True,
    "shouldWawiCalculateTaxRate": True,
    "shouldWawiCalculateTaxRateForShipping": True,
    "pullCount": 123,
    "quickSyncCount": 123,
    "sendOnlyAssignedManufacturers": True,
    "maximumTransferRate": 123,
    "imagesCount": 123,
    "entityCount": 123,
    "shippingCountryIso": "<string>"
}
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({
    canImport: true,
    shouldImportItemsAndCategories: true,
    shouldImportOrdersAndCustomers: true,
    shouldImportImages: true,
    canUpload: true,
    shouldUploadItemComplete: true,
    shouldUploadItemPriceRestricted: true,
    shouldUploadItemStockRestricted: true,
    shouldUploadCustomers: true,
    shouldUploadImages: true,
    shouldRefreshExistingItems: true,
    shouldRefreshCustomers: true,
    shouldDeleteImagesOnImport: true,
    shouldWawiCalculateTaxRate: true,
    shouldWawiCalculateTaxRateForShipping: true,
    pullCount: 123,
    quickSyncCount: 123,
    sendOnlyAssignedManufacturers: true,
    maximumTransferRate: 123,
    imagesCount: 123,
    entityCount: 123,
    shippingCountryIso: '<string>'
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-channels/{salesChannelId}/connector/configuration', 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/configuration",
  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([
    'canImport' => true,
    'shouldImportItemsAndCategories' => true,
    'shouldImportOrdersAndCustomers' => true,
    'shouldImportImages' => true,
    'canUpload' => true,
    'shouldUploadItemComplete' => true,
    'shouldUploadItemPriceRestricted' => true,
    'shouldUploadItemStockRestricted' => true,
    'shouldUploadCustomers' => true,
    'shouldUploadImages' => true,
    'shouldRefreshExistingItems' => true,
    'shouldRefreshCustomers' => true,
    'shouldDeleteImagesOnImport' => true,
    'shouldWawiCalculateTaxRate' => true,
    'shouldWawiCalculateTaxRateForShipping' => true,
    'pullCount' => 123,
    'quickSyncCount' => 123,
    'sendOnlyAssignedManufacturers' => true,
    'maximumTransferRate' => 123,
    'imagesCount' => 123,
    'entityCount' => 123,
    'shippingCountryIso' => '<string>'
  ]),
  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/configuration"

	payload := strings.NewReader("{\n  \"canImport\": true,\n  \"shouldImportItemsAndCategories\": true,\n  \"shouldImportOrdersAndCustomers\": true,\n  \"shouldImportImages\": true,\n  \"canUpload\": true,\n  \"shouldUploadItemComplete\": true,\n  \"shouldUploadItemPriceRestricted\": true,\n  \"shouldUploadItemStockRestricted\": true,\n  \"shouldUploadCustomers\": true,\n  \"shouldUploadImages\": true,\n  \"shouldRefreshExistingItems\": true,\n  \"shouldRefreshCustomers\": true,\n  \"shouldDeleteImagesOnImport\": true,\n  \"shouldWawiCalculateTaxRate\": true,\n  \"shouldWawiCalculateTaxRateForShipping\": true,\n  \"pullCount\": 123,\n  \"quickSyncCount\": 123,\n  \"sendOnlyAssignedManufacturers\": true,\n  \"maximumTransferRate\": 123,\n  \"imagesCount\": 123,\n  \"entityCount\": 123,\n  \"shippingCountryIso\": \"<string>\"\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/configuration")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"canImport\": true,\n  \"shouldImportItemsAndCategories\": true,\n  \"shouldImportOrdersAndCustomers\": true,\n  \"shouldImportImages\": true,\n  \"canUpload\": true,\n  \"shouldUploadItemComplete\": true,\n  \"shouldUploadItemPriceRestricted\": true,\n  \"shouldUploadItemStockRestricted\": true,\n  \"shouldUploadCustomers\": true,\n  \"shouldUploadImages\": true,\n  \"shouldRefreshExistingItems\": true,\n  \"shouldRefreshCustomers\": true,\n  \"shouldDeleteImagesOnImport\": true,\n  \"shouldWawiCalculateTaxRate\": true,\n  \"shouldWawiCalculateTaxRateForShipping\": true,\n  \"pullCount\": 123,\n  \"quickSyncCount\": 123,\n  \"sendOnlyAssignedManufacturers\": true,\n  \"maximumTransferRate\": 123,\n  \"imagesCount\": 123,\n  \"entityCount\": 123,\n  \"shippingCountryIso\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"canImport\": true,\n  \"shouldImportItemsAndCategories\": true,\n  \"shouldImportOrdersAndCustomers\": true,\n  \"shouldImportImages\": true,\n  \"canUpload\": true,\n  \"shouldUploadItemComplete\": true,\n  \"shouldUploadItemPriceRestricted\": true,\n  \"shouldUploadItemStockRestricted\": true,\n  \"shouldUploadCustomers\": true,\n  \"shouldUploadImages\": true,\n  \"shouldRefreshExistingItems\": true,\n  \"shouldRefreshCustomers\": true,\n  \"shouldDeleteImagesOnImport\": true,\n  \"shouldWawiCalculateTaxRate\": true,\n  \"shouldWawiCalculateTaxRateForShipping\": true,\n  \"pullCount\": 123,\n  \"quickSyncCount\": 123,\n  \"sendOnlyAssignedManufacturers\": true,\n  \"maximumTransferRate\": 123,\n  \"imagesCount\": 123,\n  \"entityCount\": 123,\n  \"shippingCountryIso\": \"<string>\"\n}"

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

{
  "canImport": true,
  "shouldImportItemsAndCategories": true,
  "shouldImportOrdersAndCustomers": true,
  "shouldImportImages": true,
  "canUpload": true,
  "shouldUploadItemComplete": true,
  "shouldUploadItemPriceRestricted": true,
  "shouldUploadItemStockRestricted": true,
  "shouldUploadCustomers": true,
  "shouldUploadImages": true,
  "shouldRefreshExistingItems": true,
  "shouldRefreshCustomers": true,
  "shouldDeleteImagesOnImport": true,
  "shouldWawiCalculateTaxRate": true,
  "shouldWawiCalculateTaxRateForShipping": true,
  "pullCount": 123,
  "quickSyncCount": 123,
  "sendOnlyAssignedManufacturers": true,
  "maximumTransferRate": 123,
  "imagesCount": 123,
  "entityCount": 123,
  "shippingCountryIso": "<string>",
  "dummyCategoryId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

{
  "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 account whose configuration is replaced.

Body

application/json

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

canImport

boolean

required

The connector account is allowed to import data from the endpoint.

shouldImportItemsAndCategories

boolean

required

Items and categories are imported.

shouldImportOrdersAndCustomers

boolean

required

Orders and customers are imported.

shouldImportImages

boolean

required

Item images are imported.

canUpload

boolean

required

The connector account is allowed to upload data to the endpoint.

shouldUploadItemComplete

boolean

required

Items are uploaded completely, rather than price/stock-restricted.

shouldUploadItemPriceRestricted

boolean

required

Item uploads are restricted to prices only.

shouldUploadItemStockRestricted

boolean

required

Item uploads are restricted to stock only.

shouldUploadCustomers

boolean

required

Customer data is uploaded.

shouldUploadImages

boolean

required

Images are uploaded.

shouldRefreshExistingItems

boolean

required

Existing items are merged/refreshed rather than only added.

shouldRefreshCustomers

boolean

required

Existing customer data is refreshed.

shouldDeleteImagesOnImport

boolean

required

Images are deleted on import.

shouldWawiCalculateTaxRate

boolean

required

The Wawi calculates the tax rate for items, rather than taking the endpoint-reported one.

shouldWawiCalculateTaxRateForShipping

boolean

required

The Wawi calculates the tax rate for shipping, rather than taking the endpoint-reported one.

pullCount

integer<int32>

required

Maximum pull count per sync run. The desktop client offers 1-1000 here; the API only requires a non-negative value, so an existing out-of-range row stays round-trippable.

quickSyncCount

integer<int32>

required

Maximum quick-sync count per sync run. The desktop client offers 1-1000 here; the API only requires a non-negative value, so an existing out-of-range row stays round-trippable.

sendOnlyAssignedManufacturers

boolean

required

Manufacturer data sent to the endpoint is filtered to only assigned manufacturers.

maximumTransferRate

number<decimal>

Maximum transfer rate for uploads, in megabytes. Omit or send null for unrestricted.

imagesCount

integer<int32>

Maximum number of images transferred per run. Omit or send null for unrestricted.

entityCount

integer<int32>

Maximum number of entities transferred per run. Omit or send null for unrestricted.

shippingCountryIso

string

The shipping/departure country as an ISO 3166-1 alpha-2 country code. Omit or send null to clear it. Matching is case-insensitive; the value is stored and returned in the canonical UPPERCASE form (ADR-85).

Response

The configuration was replaced. Returns the configuration as persisted, re-read after the write - not an echo of the request - so normalised values (uppercased ShippingCountryIso, omitted optionals resolved to null) and the preserved read-only DummyCategoryId are visible to the caller.

The persisted synchronisation configuration of a connector account (dbo.tShopKonfiguration). Live-only, non-persisted fields reported by the connected endpoint's handshake (PlatformName, PlatformVersion, ProtocolVersion, EndpointVersion, IsOldConnector, ServerInfo) are not part of this DB-backed read.

canImport

boolean

required

The connector account is allowed to import data from the endpoint.

shouldImportItemsAndCategories

boolean

required

Items and categories are imported.

shouldImportOrdersAndCustomers

boolean

required

Orders and customers are imported.

shouldImportImages

boolean

required

Item images are imported.

canUpload

boolean

required

The connector account is allowed to upload data to the endpoint.

shouldUploadItemComplete

boolean

required

Items are uploaded completely, rather than price/stock-restricted.

shouldUploadItemPriceRestricted

boolean

required

Item uploads are restricted to prices only.

shouldUploadItemStockRestricted

boolean

required

Item uploads are restricted to stock only.

shouldUploadCustomers

boolean

required

Customer data is uploaded.

shouldUploadImages

boolean

required

Images are uploaded.

shouldRefreshExistingItems

boolean

required

Existing items are merged/refreshed rather than only added.

shouldRefreshCustomers

boolean

required

Existing customer data is refreshed.

shouldDeleteImagesOnImport

boolean

required

Images are deleted on import.

shouldWawiCalculateTaxRate

boolean

required

The Wawi calculates the tax rate for items, rather than taking the endpoint-reported one.

shouldWawiCalculateTaxRateForShipping

boolean

required

The Wawi calculates the tax rate for shipping, rather than taking the endpoint-reported one.

pullCount

integer<int32>

required

Maximum pull count per sync run.

quickSyncCount

integer<int32>

required

Maximum quick-sync count per sync run.

sendOnlyAssignedManufacturers

boolean

required

Manufacturer data sent to the endpoint is filtered to only assigned manufacturers.

maximumTransferRate

number<decimal>

Maximum transfer rate for uploads, in megabytes, or null if unrestricted.

imagesCount

integer<int32>

Maximum number of images transferred per run, or null if unrestricted.

entityCount

integer<int32>

Maximum number of entities transferred per run, or null if unrestricted.

shippingCountryIso

string

The shipping/departure country as an ISO 3166-1 alpha-2 country code, or null if not set. Canonical form is UPPERCASE (ADR-85); matching is case-insensitive.

dummyCategoryId

string<uuid>

Fallback category for uncategorized imported items, or null if not set.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Overview

GraphQL

REST API

Replaces the persisted synchronisation configuration (dbo.tShopKonfiguration) of a connector account.

Authorizations

Headers

Path Parameters

Body

Response