> ## 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.
# Update Marketplace Seller Configuration
> Partially updates the configuration (sync, defaults, returns) of the specified marketplace seller/account identified by its composite salesChannelId. Only provided fields are changed; omitted fields keep their current value.
## OpenAPI
````yaml /openapi/2.1.json patch /v2/marketplace/sellers/{salesChannelId}
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.2.0-alpha.9842+Sha.706d4e9\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.1'
x-application-version: 2.2.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 Seller
- name: Seller
- name: Marketplace Order
- name: Marketplace Offer
- name: Marketplace Invoicing
- name: Sales Channel
- name: Payment
- name: Warehouse Assistant
- name: Worker
paths:
/v2/marketplace/sellers/{salesChannelId}:
patch:
tags:
- Marketplace Seller
summary: Update Marketplace Seller Configuration
description: >-
Partially updates the configuration (sync, defaults, returns) of the
specified marketplace seller/account identified by its composite
salesChannelId. Only provided fields are changed; omitted fields keep
their current value.
operationId: Seller_UpdateMarketplaceSellerConfiguration
parameters:
- name: salesChannelId
in: path
required: true
schema:
type: string
x-position: 1
- name: x-companyid
in: header
description: >-
The Company-Id (int or uuid) of the company on whose behalf the
request is executed.
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.
requestBody:
x-name: request
description: Request parameters
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateMarketplaceSellerConfigurationCommandRequest
required: true
x-position: 2
responses:
'200':
description: Marketplace seller configuration was successfully updated.
content:
application/json: {}
'400':
description: >-
Bad request. The salesChannelId could not be parsed, no seller
exists for it, or a foreign-key/number-range validation failed (see
error message for details).
content:
application/json: {}
'401':
description: ''
content:
application/json: {}
'403':
description: ''
content:
application/json: {}
'404':
description: ''
content:
application/json: {}
'500':
description: Internal server error.
content:
application/json: {}
security:
- oauth2-authorization-code:
- sellers.write
- oauth2-client-credentials:
- sellers.write
components:
schemas:
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateMarketplaceSellerConfigurationCommandRequest:
type: object
description: >-
Partially updates the configuration (sync, defaults, returns) of the
specified marketplace seller/account identified by its composite
salesChannelId. Only provided fields are changed; omitted fields keep
their current value. - Request
additionalProperties: false
properties:
sync:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateUpdateMarketplaceSellerSyncSettings
description: >-
Synchronization settings to update (stock, attributes, offer
automapping, offer deletion intervals). Omit to leave unchanged.
defaults:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateUpdateMarketplaceSellerDefaultsSettings
description: >-
Default settings to update (shipping method, payment method, order
confirmation). Omit to leave unchanged.
returns:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateUpdateMarketplaceSellerReturnSettings
description: Return tracking settings to update. Omit to leave unchanged.
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateUpdateMarketplaceSellerSyncSettings:
type: object
description: >-
Partial update of synchronization settings for a marketplace seller.
Only provided fields are changed.
additionalProperties: false
properties:
isDocumentStorageEnabled:
type: boolean
description: Enable/disable document storage for this seller.
isStockUpdateEnabled:
type: boolean
description: Enable/disable stock update transmission.
isAttributeImportEnabled:
type: boolean
description: Enable/disable attribute import from the channel.
isOfferAutomappingEnabled:
type: boolean
description: Enable/disable offer automapping.
offerAutomappingType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceOfferAutomappingType
type: integer
description: Offer automapping strategy.
format: int32
pendingOfferDeletionIntervalDays:
type: integer
description: Deletion interval in days for pending offers. Must not be negative.
format: int32
completedOfferDeletionIntervalDays:
type: integer
description: >-
Deletion interval in days for completed offers. Must not be
negative.
format: int32
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateUpdateMarketplaceSellerDefaultsSettings:
type: object
description: >-
Partial update of default settings for a marketplace seller. Only
provided fields are changed.
additionalProperties: false
properties:
shippingMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey'
description: >-
Default shipping method for this seller. Must reference an existing
shipping method.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
paymentMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey'
description: >-
Default payment method for this seller. Must reference an existing
payment method.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
orderConfirmType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceOrderConfirmType
type: integer
description: Order confirmation strategy.
format: int32
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.UpdateUpdateMarketplaceSellerReturnSettings:
type: object
description: >-
Partial update of return tracking settings for a marketplace seller.
Only provided fields are changed.
additionalProperties: false
properties:
isReturnTrackingIdEnabled:
type: boolean
description: Enable/disable return tracking ID generation.
returnTransmissionType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceReturnTransmissionType
type: integer
description: Return transmission strategy.
format: int32
refundTransmissionType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceRefundTransmissionType
type: integer
description: Refund transmission strategy.
format: int32
returnShippingRuleId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ShippingRuleKey'
description: >-
ID of the return shipping rule (carrier code). Must reference a
shipping rule assigned to this seller's channel.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
returnNumberRangePrefix:
type: string
description: Prefix for the return number range.
returnNumberRangeFrom:
type: integer
description: >-
Start of the return number range. Must be less than or equal to
ReturnNumberRangeTo.
format: int64
returnNumberRangeTo:
type: integer
description: >-
End of the return number range. Must be greater than or equal to
ReturnNumberRangeFrom.
format: int64
returnNumberRangeSuffix:
type: string
description: Suffix for the return number range.
returnNumberRangeCurrent:
type: integer
description: >-
Current return number. Must lie within the resulting return number
range.
format: int64
isReturnIdLimitWarningEnabled:
type: boolean
description: Enable/disable the return-ID limit warning.
returnIdLimitWarningCount:
type: integer
description: Threshold for the return-ID limit warning. Must not be negative.
format: int32
returnIdLimitWarningEmail:
type: string
description: Email address for the return-ID limit warning.
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceOfferAutomappingType:
type: integer
description: 0 = SKU, 1 = EAN, 2 = ProductId
format: int32
x-enumNames:
- SKU
- EAN
- ProductId
enum:
- 0
- 1
- 2
JTL.Data.Contracts.Keys.VersandartKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.ZahlungsartKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceOrderConfirmType:
type: integer
description: 0 = AlwaysAccept, 1 = AcceptOnlyWhenEnoughStock
format: int32
x-enumNames:
- AlwaysAccept
- AcceptOnlyWhenEnoughStock
enum:
- 0
- 1
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceReturnTransmissionType:
type: integer
description: 0 = Always, 1 = Never, 2 = OnSettingPerReturn
format: int32
x-enumNames:
- Always
- Never
- OnSettingPerReturn
enum:
- 0
- 1
- 2
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceRefundTransmissionType:
type: integer
description: 0 = Always, 1 = Never, 2 = OnSettingPerRefund
format: int32
x-enumNames:
- Always
- Never
- OnSettingPerRefund
enum:
- 0
- 1
- 2
JTL.Data.Contracts.Keys.ShippingRuleKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
securitySchemes:
oauth2-authorization-code:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.jtl-cloud.com/oauth2/auth
tokenUrl: https://auth.jtl-cloud.com/oauth2/token
scopes:
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
saleschannels.read: Verkaufskanäle lesen
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.
inventories.write: Grants permission to modify 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.
warehouse.read: Grants permission to read warehouse 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.
suppliers.read: Grants permission to read suppliers.
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.
marketplace.write: >-
Grants permission to create and modify SCX marketplace data
(sellers, orders, offers, invoicing).
sellers.write: >-
Grants permission to create and modify SCX marketplace sellers and
their configuration.
inventory.write: Bestand schreiben
masterdata.write: Write master data
inventory.read: Grants permission to read stock levels.
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://auth.jtl-cloud.com/oauth2/token
scopes:
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
saleschannels.read: Verkaufskanäle lesen
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.
inventories.write: Grants permission to modify 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.
warehouse.read: Grants permission to read warehouse 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.
suppliers.read: Grants permission to read suppliers.
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.
marketplace.write: >-
Grants permission to create and modify SCX marketplace data
(sellers, orders, offers, invoicing).
sellers.write: >-
Grants permission to create and modify SCX marketplace sellers and
their configuration.
inventory.write: Bestand schreiben
masterdata.write: Write master data
inventory.read: Grants permission to read stock levels.
taxes.write: Grants permission to create and modify tax data.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
````