Skip to main content
GET
Get Shop Transfer Parameters

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 shop, used only to validate that an existing JTL-Wawi-managed online shop is addressed. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing. Does not scope which shop's transfer parameters are returned; see the query description.

Response

Success.

The JTL-Shop transfer parameters (archive sizes, quick-sync and order transfer batch sizes) as currently saved. These parameters are global: they apply to every JTL-Wawi-managed online shop of the tenant. The properties match the request of "PUT /v2/sales-channels/{salesChannelId}/shop/transfer-parameters" or "SaveShopTransferParameters".

maxFilesPerArchive
integer<int32>
required

Threshold for the number of files in an item export archive that triggers sending it to the JTL-Shop, before its target size ("maxArchiveSizeInKilobytes") is reached. Returns 100 if no valid positive value has been saved. A saved value above 0 is returned unchanged; there is no upper limit.

quickSyncArticleCount
integer<int32>
required

Number of items transferred per quick-sync run. Returns 100 if no valid positive value has been saved. A saved value above 0 is returned unchanged; there is no upper limit.

maxImagesPerArchive
integer<int32>
required

Threshold for the number of images in an image export archive that triggers sending it to the JTL-Shop, before its target size ("maxImageArchiveSizeInKilobytes") is reached. Returns 25 if no valid positive value has been saved. A saved value above 0 is returned unchanged; there is no upper limit.

orderTransferCount
integer<int32>
required

Number of orders transferred per order transfer run. Returns 50 if no valid positive value has been saved. A saved value above 50 is returned as 50, the maximum the save request accepts.

maxArchiveSizeInKilobytes
integer<int32>
required

Target size, in kilobytes, of an item export archive that triggers sending it to the JTL-Shop, before its file-count threshold ("maxFilesPerArchive") is reached. Returns 1024 if no valid positive value has been saved. A saved value above 0 is returned unchanged; there is no upper limit.

maxImageArchiveSizeInKilobytes
integer<int32>
required

Target size, in kilobytes, of an image export archive that triggers sending it to the JTL-Shop, before its file-count threshold ("maxImagesPerArchive") is reached. Returns 300 if no valid positive value has been saved. A saved value above 0 is returned unchanged; there is no upper limit.