> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Shop Transfer Parameters
> Returns the JTL-Shop transfer parameters (archive sizes, quick-sync and order transfer batch sizes). These parameters are global: they apply to every JTL-Wawi-managed online shop of the tenant, not only to the shop in the route. The sales channel id must identify an existing JTL-Wawi-managed online shop (otherwise it is reported as not found), but does not select which values are returned; every shop returns the same values. Per parameter, a saved value above 0 is returned unchanged (no upper limit, except "orderTransferCount", which is returned as at most 50); for a value that is missing, blank, not a number or not positive, the default of that parameter is returned. Values saved via "PUT /v2/sales-channels/{salesChannelId}/shop/transfer-parameters" or "SaveShopTransferParameters" are returned immediately by the next call.
## OpenAPI
````yaml /openapi/erp/2.2.json get /v2/sales-channels/{salesChannelId}/shop/transfer-parameters
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.3.0-alpha.261012205739+Sha.bc2e7a5\r\n# Introduction\r\n\r\nWelcome to the JTL-WAWI technical API documentation. This guide is here to help developers understand how our REST API works and how it can be integrated into your existing systems. We'll delve into the details of authentication and data manipulation processes, providing clear examples along the way. Whether you're a developer or an IT professional, this documentation aims to give you a practical understanding, laying the groundwork for effectively using the JTL-WAWI API to enhance your processes.\r\n\r\n# Authentication\r\n\r\nYou register your application with the API by sending a POST request with the required information and corresponding keys. You can find the exact request details at https://developer.jtl-software.com/products/erp/swagger/appregistration. This information has to include the following:\r\n\r\n* AppId\r\n* DisplayName\r\n* Description\r\n* Version\r\n* ProviderName\r\n* ProviderWebsite\r\n* MandatoryApiScopes\r\n\r\nThis data is crucial for identifying and registering your application with the API. The API uses it to generate a temporary authentication ID that allows your application to access the necessary resources. After successful validation of this information, you will receive the API key required for future authentication and API requests.\r\n\r\nBefore you can begin the registration process, you must open JTL-Wawi (new interface) and start the registration process under 'Admin->App registration'. Only at this point are you authorised to send the first API call. This step in JTL-Wawi ensures that your application is properly registered and has permission to use the API.\r\n\r\nThe API will send you an authentication ID in the form of a token. Once you have received this token and successfully completed the registration in JTL-Wawi, you will send another request to the API by including this authentication ID in the URL path.\r\n\r\nAfter successful validation of this second request by the API and confirmation of the correct information, you will be provided with the actual API key. It is important to note that this API key will not be displayed again!\r\n\r\nThis API key will be used in the future to authenticate requests to the API. It is of utmost importance that you securely store the API key upon receipt, as it cannot be retrieved from any other location in the system."
contact:
name: JTL-Software-GmbH
url: https://developer.jtl-software.com/
email: partner@jtl-software.com
version: '2.2'
x-application-version: 2.3.0.0
servers:
- url: https://api.jtl-cloud.com/erp
description: Production Environment Cloud API Gateway
security: []
tags:
- name: WMS
description: >-
Query all pick
lists for a specific wms warehouse that are not completed.
- name: Wawi App
description: >-
Get a
specific customer
- name: Warehouses
description: >-
Queries all
storage locations for a given warehouse.
- name: Units
description: Development
- name: Transaction Status
description: >-
Queries all transaction statuses for a sales
order.
- name: Tax
description: >-
Returns the tax
rate for the given item.
- name: Inventory
description: >-
Queries
stocks for a specific item, warehouse or storage location.
- name: Sales Order
description: Planned
- name: Sales Invoice Correction
description: Planned
- name: Return
description: >-
Create a new
return with associated items and packages.
- name: Item
description: >-
Queries all
responsible persons.
- name: Refund
description: Planned
- name: Property
description: >-
Queries all
properties of items.
- name: Printer
description: >-
Retrieves all
installed printers.
- name: Master Data
description: >-
Queries
all on hold reasons for sales orders.
- name: Manufacturer
description: Development
- name: Label
description: Development
- name: Sales Invoice
description: Planned
- name: Info
description: >-
Returns the
status of the API.
- name: Features
description: >-
Returns the
available feature sets with release state and API version.
- name: Extensibility
description: Planned
- name: Shipment
description: Development
- name: Delivery Note
description: Planned
- name: Custom Field
description: Development
- name: Customer
description: >-
Deletes a
specific customer.
- name: Authentication
description: >-
DEPRECATED seit Wawi 2.2.0: No-Op. Seit
Wawi 2.1.0 registriert sich die Wawi selbst per JWT.
- name: Attribute
description: Development
- name: Sales Quotation
description: >-
Execute
the printing of a sales quotation
- name: Production
- name: Resources
- name: Company
- name: Sales Orders
- name: Marketplace Order
- name: Marketplace Offer
- name: Marketplace Invoicing
- name: Sales Channel
- name: Payment
- name: Warehouse Assistant
- name: Worker
paths:
/v2/sales-channels/{salesChannelId}/shop/transfer-parameters:
get:
tags:
- wawi
- Sales Channel
summary: Get Shop Transfer Parameters
description: >-
Returns the JTL-Shop transfer parameters (archive sizes, quick-sync and
order transfer batch sizes). These parameters are global: they apply to
every JTL-Wawi-managed online shop of the tenant, not only to the shop
in the route. The sales channel id must identify an existing
JTL-Wawi-managed online shop (otherwise it is reported as not found),
but does not select which values are returned; every shop returns the
same values. Per parameter, a saved value above 0 is returned unchanged
(no upper limit, except "orderTransferCount", which is returned as at
most 50); for a value that is missing, blank, not a number or not
positive, the default of that parameter is returned. Values saved via
"PUT /v2/sales-channels/{salesChannelId}/shop/transfer-parameters" or
"SaveShopTransferParameters" are returned immediately by the next call.
operationId: Shop_GetShopTransferParameters
parameters:
- name: salesChannelId
in: path
required: true
description: >-
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.
schema:
type: string
- name: x-tenant-id
in: header
required: true
schema:
type: string
format: uuid
description: The tenant ID for the target ERP instance.
responses:
'200':
description: Success.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopTransferParameters
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'403':
description: Forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'404':
description: >-
Malformed sales channel id, the sales channel does not name an
online-shop channel, or the named shop does not exist or is not
managed by JTL-Wawi.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
security:
- oauth2-authorization-code:
- saleschannels.read
- oauth2-client-credentials:
- saleschannels.read
components:
schemas:
JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopTransferParameters:
type: object
description: >-
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".
additionalProperties: false
required:
- maxFilesPerArchive
- quickSyncArticleCount
- maxImagesPerArchive
- orderTransferCount
- maxArchiveSizeInKilobytes
- maxImageArchiveSizeInKilobytes
properties:
maxFilesPerArchive:
type: integer
description: >-
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.
format: int32
quickSyncArticleCount:
type: integer
description: >-
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.
format: int32
maxImagesPerArchive:
type: integer
description: >-
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.
format: int32
orderTransferCount:
type: integer
description: >-
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.
format: int32
maxArchiveSizeInKilobytes:
type: integer
description: >-
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.
format: int32
maxImageArchiveSizeInKilobytes:
type: integer
description: >-
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.
format: int32
FastEndpoints.ProblemDetails:
type: object
additionalProperties: false
properties:
type:
type: string
default: https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1
title:
type: string
default: One or more validation errors occurred.
status:
type: integer
format: int32
default: 400
instance:
type: string
default: /api/route
traceId:
type: string
default: 0HMPNHL0JHL76:00000001
detail:
type: string
errors:
type: array
items:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails_Error'
FastEndpoints.ProblemDetails_Error:
type: object
additionalProperties: false
properties:
name:
type: string
default: Error or field name
reason:
type: string
default: Error reason
code:
type: string
severity:
type: string
securitySchemes:
oauth2-authorization-code:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://id.jtl-cloud.com/oauth/v2/authorize
tokenUrl: https://id.jtl-cloud.com/oauth/v2/token
scopes:
inventories.write: Grants permission to modify stock levels.
inventory.read: Grants permission to read stock levels.
inventory.write: Grants permission to modify stock levels.
warehouse.read: Grants permission to read warehouse data.
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
procurements.read: Beschaffung lesen
saleschannels.read: Grants permission to read sales channels.
saleschannels.write: Grants permission to create and modify sales channels.
all.read: Allows the application to read all data.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
customfields.read: Grants permission to read custom fields.
customfields.write: Grants permission to create and modify custom fields.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliverynotes.print: Grants permission to print and output delivery notes.
deliverynotes.read: Grants permission to read delivery notes.
deliverynotes.write: Grants permission to create and modify delivery notes.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
inventories.read: Grants permission to read stock levels.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
labels.read: Grants permission to read labels.
labels.write: Grants permission to create and modify labels.
masterdata.read: >-
Read master data such as shipping methods, payment methods, color
codes and tax classes.
orders.read: Grants permission to read orders.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorders.print: Grants permission to print and output sales orders.
salesorders.read: Grants permission to read sales orders.
salesorders.write: Grants permission to create and modify sales orders.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
taxes.read: Grants permission to read tax data.
wawiapp.all: Grants access to Wawi app related operations.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
payments.read: Ermöglicht den Lesezugriff auf Zahlungen.
payments.write: Ermöglicht den Schreibzugriff auf Zahlungen.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.print: Grants permission to print and output sales invoices.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.print: Grants permission to print and output sales quotations.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
system.worker.read: Worker-Synchronisationen lesen
system.worker.write: Worker-Synchronisationen schreiben
resources.read: Grants permission to read resource management data.
resources.write: Grants permission to create and modify resource management data.
pps.read: Grants permission to read production data.
pps.write: Grants permission to create and modify production data.
channels.read: Grants permission to read marketplace channels.
invoices.print: >-
Grants permission to print marketplace external documents
(invoices, credit notes).
marketplaceoffers.read: Grants permission to read marketplace offers and offer failures.
marketplaceoffers.write: Grants permission to create and modify marketplace offers.
notifications.read: Grants permission to read marketplace notifications.
orders.write: >-
Grants permission to modify marketplace order data (exclude/reset
cancellation, payment, return and shipping uploads).
masterdata.write: Write master data
taxes.write: Grants permission to create and modify tax data.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
oauth2-client-credentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://id.jtl-cloud.com/oauth/v2/token
scopes:
inventories.write: Grants permission to modify stock levels.
inventory.read: Grants permission to read stock levels.
inventory.write: Grants permission to modify stock levels.
warehouse.read: Grants permission to read warehouse data.
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
procurements.read: Beschaffung lesen
saleschannels.read: Grants permission to read sales channels.
saleschannels.write: Grants permission to create and modify sales channels.
all.read: Allows the application to read all data.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
customfields.read: Grants permission to read custom fields.
customfields.write: Grants permission to create and modify custom fields.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliverynotes.print: Grants permission to print and output delivery notes.
deliverynotes.read: Grants permission to read delivery notes.
deliverynotes.write: Grants permission to create and modify delivery notes.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
inventories.read: Grants permission to read stock levels.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
labels.read: Grants permission to read labels.
labels.write: Grants permission to create and modify labels.
masterdata.read: >-
Read master data such as shipping methods, payment methods, color
codes and tax classes.
orders.read: Grants permission to read orders.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorders.print: Grants permission to print and output sales orders.
salesorders.read: Grants permission to read sales orders.
salesorders.write: Grants permission to create and modify sales orders.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
taxes.read: Grants permission to read tax data.
wawiapp.all: Grants access to Wawi app related operations.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
payments.read: Ermöglicht den Lesezugriff auf Zahlungen.
payments.write: Ermöglicht den Schreibzugriff auf Zahlungen.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.print: Grants permission to print and output sales invoices.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.print: Grants permission to print and output sales quotations.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
system.worker.read: Worker-Synchronisationen lesen
system.worker.write: Worker-Synchronisationen schreiben
resources.read: Grants permission to read resource management data.
resources.write: Grants permission to create and modify resource management data.
pps.read: Grants permission to read production data.
pps.write: Grants permission to create and modify production data.
channels.read: Grants permission to read marketplace channels.
invoices.print: >-
Grants permission to print marketplace external documents
(invoices, credit notes).
marketplaceoffers.read: Grants permission to read marketplace offers and offer failures.
marketplaceoffers.write: Grants permission to create and modify marketplace offers.
notifications.read: Grants permission to read marketplace notifications.
orders.write: >-
Grants permission to modify marketplace order data (exclude/reset
cancellation, payment, return and shipping uploads).
masterdata.write: Write master data
taxes.write: Grants permission to create and modify tax data.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
````