> ## 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.
# Retrieves all marketplace sellers including all sub-elements (price types, shipping rules, metadata, supported marketplaces).
> Retrieves all marketplace sellers including all sub-elements (price types, shipping rules, metadata, supported marketplaces).
## OpenAPI
````yaml /openapi/2.1.json get /v2/marketplace/sellers/all
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.2.0-alpha.9492+Sha.4c8d5d1\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/all:
get:
tags:
- Seller
summary: >-
Retrieves all marketplace sellers including all sub-elements (price
types, shipping rules, metadata, supported marketplaces).
description: >-
Retrieves all marketplace sellers including all sub-elements (price
types, shipping rules, metadata, supported marketplaces).
operationId: Seller_GetAllMarketplaceSellersWithDetails
parameters:
- 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.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerDetailsListItem
'400':
description: ''
content:
application/json: {}
'401':
description: ''
content:
application/json: {}
'403':
description: ''
content:
application/json: {}
'500':
description: ''
content:
application/json: {}
security:
- oauth2-authorization-code: []
- oauth2-client-credentials: []
components:
schemas:
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerDetailsListItem:
type: object
description: >-
Wrapper containing a list of all marketplace sellers with complete
details.
additionalProperties: false
required:
- Sellers
properties:
sellers:
type: array
description: List of sellers with all nested detail data.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerWithDetailsItem
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerWithDetailsItem:
type: object
description: >-
Complete marketplace seller including base info and all detail
sub-elements.
additionalProperties: false
required:
- ScxShopId
- ShopId
- ChannelId
- IsActive
- SellerId
- Channel
- CreatedAt
- ChannelDisplayName
- ChannelCurrency
- IsDocumentStorageEnabled
- IsStockUpdateEnabled
- IsOfferAutomappingEnabled
- OfferAutomappingType
- IsAttributeImportEnabled
- OrderConfirmType
- PendingOfferDeletionIntervalDays
- CompletedOfferDeletionIntervalDays
- IsDeleted
- IsVariationsSupported
- IsQuantityPriceSupported
- InvoiceDocumentTransfer
- IsAllowCombineOrders
properties:
scxShopId:
$ref: '#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxShopKey'
description: ID of the SCX shop assignment.
shopId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ShopKey'
description: ID of the shop.
channelId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelKey
description: ID of the channel.
name:
type: string
description: Name of the shop.
isActive:
type: boolean
description: Shop is active.
isBlocked:
type: integer
description: Shop blocked state.
format: int32
companyId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
description: ID of the company.
warehouseId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
description: ID of the warehouse.
languageId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.SpracheKey'
description: ID of the language.
sellerId:
type: string
description: Seller identifier on the marketplace channel.
channel:
type: string
description: Channel code.
createdAt:
type: string
description: Creation timestamp.
format: date-time
updatedAt:
type: string
description: Last update timestamp.
format: date-time
reason:
type: string
description: Reason text.
shippingMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey'
description: ID of the default shipping method.
channelDisplayName:
type: string
description: Display name of the channel.
channelCurrency:
type: string
description: Currency of the channel.
isDocumentStorageEnabled:
type: boolean
description: Document storage is enabled.
isStockUpdateEnabled:
type: boolean
description: Stock update is enabled.
isOfferAutomappingEnabled:
type: boolean
description: Offer automapping is enabled.
offerAutomappingType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceOfferAutomappingType
description: Offer automapping type.
isAttributeImportEnabled:
type: boolean
description: Attribute import is enabled.
orderConfirmType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceOrderConfirmType
description: Order confirm type.
paymentMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey'
description: ID of the payment method.
pendingOfferDeletionIntervalDays:
type: integer
description: Deletion interval for pending offers in days.
format: int32
completedOfferDeletionIntervalDays:
type: integer
description: Deletion interval for completed offers in days.
format: int32
isDeleted:
type: boolean
description: SCX shop assignment is marked as deleted.
isVariationsSupported:
type: boolean
description: Channel supports variations.
isQuantityPriceSupported:
type: boolean
description: Channel supports quantity prices.
invoiceDocumentTransfer:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceInvoiceDocumentTransferType
description: Invoice document transfer mode.
isAllowCombineOrders:
type: boolean
description: Channel allows combining orders.
priceTypes:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerPriceTypes
description: Price types assigned to this seller channel.
shippingRules:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerShippingRules
description: Shipping rules assigned to this seller channel.
metaData:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerMetaData
description: Metadata entries for this seller (no date required).
events:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerEvents
description: Event entries for this seller (with CreatedAfter date).
supportedMarketplaces:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerSupportedMarketplaces
description: Supported marketplaces for this seller channel.
returnSettings:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerReturnSettings
description: Return tracking settings for this seller.
JTL.Wawi.Marketplace.Scx.Types.Keys.ScxShopKey:
type: string
description: Represents a key for a ScxShop entity.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.ShopKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelKey:
type: string
description: Represents a key for a SCX channel.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.FirmaKey:
type: string
description: Represents a key for identifying a firm within the application.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.WarenlagerKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.SpracheKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.VersandartKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
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.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.Data.Contracts.Keys.ZahlungsartKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceInvoiceDocumentTransferType:
type: integer
description: 0 = NotSupported, 1 = FromSeller, 2 = FromChannel
format: int32
x-enumNames:
- NotSupported
- FromSeller
- FromChannel
enum:
- 0
- 1
- 2
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerPriceTypes:
type: object
description: Price types assigned to a marketplace seller.
additionalProperties: false
required:
- PriceTypes
properties:
priceTypes:
type: array
description: List of price types.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerPriceType
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerShippingRules:
type: object
description: Shipping rules assigned to a marketplace seller.
additionalProperties: false
required:
- ShippingRules
properties:
shippingRules:
type: array
description: List of shipping rules.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerShippingRule
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerMetaData:
type: object
description: Metadata entries for a marketplace seller (no date required).
additionalProperties: false
required:
- MetaData
properties:
metaData:
type: array
description: List of metadata entries.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerMetaDataItem
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerEvents:
type: object
description: Event entries for a marketplace seller (with CreatedAfter date).
additionalProperties: false
required:
- Events
properties:
events:
type: array
description: List of event entries.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerEventItem
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerSupportedMarketplaces:
type: object
description: Supported marketplaces for a seller channel.
additionalProperties: false
required:
- SupportedMarketplaces
properties:
supportedMarketplaces:
type: array
description: List of supported marketplaces.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerSupportedMarketplace
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerReturnSettings:
type: object
description: Return tracking settings for a marketplace seller.
additionalProperties: false
required:
- IsReturnTrackingRequired
- IsReturnTrackingIdEnabled
- ReturnTransmissionType
- RefundTransmissionType
- ReturnNumberRangeFrom
- ReturnNumberRangeTo
- ReturnNumberRangeCurrent
- IsReturnIdLimitWarningEnabled
- ReturnIdLimitWarningCount
properties:
isReturnTrackingRequired:
type: boolean
description: Channel requires return tracking.
isReturnTrackingIdEnabled:
type: boolean
description: Return tracking ID generation is enabled.
returnTransmissionType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceReturnTransmissionType
description: Return transmission type.
refundTransmissionType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceRefundTransmissionType
description: Refund transmission type.
returnShippingRuleId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ShippingRuleKey'
description: ID of the return shipping rule (carrier code).
returnWarehouseId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
description: ID of the return warehouse.
returnNumberRangePrefix:
type: string
description: Prefix for return number range.
returnNumberRangeFrom:
type: integer
description: Start of return number range.
format: int64
returnNumberRangeTo:
type: integer
description: End of return number range.
format: int64
returnNumberRangeSuffix:
type: string
description: Suffix for return number range.
returnNumberRangeCurrent:
type: integer
description: Current return number in the range.
format: int64
isReturnIdLimitWarningEnabled:
type: boolean
description: Return ID limit warning is enabled.
returnIdLimitWarningCount:
type: integer
description: Remaining IDs threshold for warning.
format: int32
returnIdLimitWarningEmail:
type: string
description: Email address for return ID limit warning.
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerPriceType:
type: object
description: Single price type assigned to a seller channel.
additionalProperties: false
required:
- ChannelPriceTypeId
- ChannelId
- ShopId
properties:
channelPriceTypeId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelPriceTypeKey
description: ID of the channel price type.
channelId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelKey
description: ID of the channel.
shopId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ShopKey'
description: ID of the shop.
priceTypeId:
type: string
description: Price type identifier on the channel.
displayName:
type: string
description: Display name of the price type.
description:
type: string
description: Description of the price type.
customerGroupId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey'
description: ID of the mapped customer group.
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerShippingRule:
type: object
description: Single shipping rule assigned to a seller channel.
additionalProperties: false
required:
- ShippingRuleId
- ChannelId
- CarrierId
properties:
shippingRuleId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ShippingRuleKey'
description: ID of the shipping rule.
channelId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelKey
description: ID of the channel.
carrierId:
type: string
description: Carrier identifier.
displayName:
type: string
description: Display name of the shipping rule.
shippingMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey'
description: ID of the mapped shipping method.
shopId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ShopKey'
description: ID of the shop.
customCarrierId:
type: string
description: Custom carrier code override.
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerMetaDataItem:
type: object
description: >-
Single metadata entry for a seller (ApiModeType =
Metadata/MetadataPull).
additionalProperties: false
required:
- Type
- SellerId
- ChannelId
- ApiModeType
- IsImportEnabled
properties:
type:
type: string
description: >-
Download type (e.g. CATEGORY, GLOBAL_ATTRIBUTES). Unique key per
seller.
metaDataEntryId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxMetaDataChangedKey
description: ID of the metadata entry. Null if not yet persisted.
resource:
type: string
description: Resource identifier.
sellerId:
type: string
description: Seller identifier.
channelId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelKey
description: ID of the channel.
apiModeType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceApiModeType
description: API mode type (1=Metadata, 4=MetadataPull).
isImportEnabled:
type: boolean
description: Whether import is enabled for this metadata type.
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerEventItem:
type: object
description: Single event entry for a seller (CreatedAfter date is relevant).
additionalProperties: false
required:
- Type
- SellerId
- ChannelId
- ApiModeType
- IsImportEnabled
properties:
type:
type: string
description: >-
Event type (e.g. Channel:Order, Channel:OfferListing:Failed). Unique
key per seller.
metaDataEntryId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxMetaDataChangedKey
description: ID of the metadata entry. Null if not yet persisted.
resource:
type: string
description: Resource identifier.
sellerId:
type: string
description: Seller identifier.
channelId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelKey
description: ID of the channel.
createdAfter:
type: string
description: Events created after this timestamp will be fetched.
format: date-time
apiModeType:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceApiModeType
description: API mode type (0=Event).
isImportEnabled:
type: boolean
description: Whether import is enabled for this event type.
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceSellerSupportedMarketplace:
type: object
description: Single supported marketplace (country) for a seller channel.
additionalProperties: false
required:
- ChannelId
- Iso
- Name
- Sort
properties:
channelId:
$ref: >-
#/components/schemas/JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelKey
description: ID of the channel.
iso:
type: string
description: ISO code of the marketplace country.
name:
type: string
description: Country name.
sort:
type: integer
description: Sort order.
format: int32
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
JTL.Wawi.Marketplace.Scx.Types.Keys.ScxChannelPriceTypeKey:
type: string
description: Represents a key for the SCX channel price type.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.KundenGruppeKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Marketplace.Scx.Types.Keys.ScxMetaDataChangedKey:
type: string
description: Represents a key for a SCX metadata changed entry.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Seller.MarketplaceApiModeType:
type: integer
description: 0 = Event, 1 = Metadata, 2 = Report, 3 = Channel, 4 = MetadataPull
format: int32
x-enumNames:
- Event
- Metadata
- Report
- Channel
- MetadataPull
enum:
- 0
- 1
- 2
- 3
- 4
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.
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.
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.
````