> ## 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.
# Delivers the curated detail of a single supplier by its id, regardless of active state.
> Delivers the curated detail of a single supplier by its id, regardless of active state.
## OpenAPI
````yaml /openapi/erp/2.1.json get /v2/suppliers/{supplierId}
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.2.0-alpha.5033+Sha.dfa7dbf\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/suppliers/{supplierId}:
get:
tags:
- wawi
- Supplier
summary: >-
Delivers the curated detail of a single supplier by its id, regardless
of active state.
description: >-
Delivers the curated detail of a single supplier by its id, regardless
of active state.
operationId: SupplierDomain_GetSupplierById
parameters:
- name: supplierId
in: path
required: true
description: The key of the supplier to resolve.
schema:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey'
- 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.Suppliers.PublicApi.DataTransferObjects.V2.SupplierDomain.SupplierDetail
'400':
description: Bad request.
content:
application/json: {}
'401':
description: Unauthorized.
content:
application/json: {}
'403':
description: Forbidden.
content:
application/json: {}
'404':
description: Not found.
content:
application/json: {}
'500':
description: Internal server error.
content:
application/json: {}
security:
- oauth2-authorization-code:
- suppliers.read
- oauth2-client-credentials:
- suppliers.read
components:
schemas:
JTL.Data.Contracts.Keys.LieferantKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Suppliers.PublicApi.DataTransferObjects.V2.SupplierDomain.SupplierDetail:
type: object
description: >-
Full, curated detail of a single supplier. Named SupplierDetail (not
Supplier) because the Supplier GraphQL type is already owned by the
overview list type (Supplier.yml, now in this same project) — GraphQL
type names are global across the schema, so the two cannot share one
name and the detail type carries a distinct one. Note the collision is
NOT a consequence of the earlier split across two projects: moving the
overview definition here did not resolve it, and renaming this type to
Supplier would still clash.
additionalProperties: false
required:
- id
- canDropship
- isActive
- address
- isVatExempt
- isExcludedFromPurchaseList
- allowsDropshipCashOnDelivery
- allowsDropshipFreeLineItems
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey'
description: Unique identifier of the supplier.
supplierNumber:
type: string
description: >-
Supplier number (free-text supplier identifier held at the
merchant).
companyName:
type: string
description: Company name of the supplier.
status:
type: string
description: Free-text status of the supplier.
canDropship:
type: boolean
description: Indicates whether the supplier can be used for dropshipping.
currencyIso:
type: string
description: ISO code of the supplier's currency.
isActive:
type: boolean
description: Indicates whether the supplier is active.
address:
$ref: >-
#/components/schemas/JTL.Wawi.Suppliers.PublicApi.DataTransferObjects.V2.SupplierDomain.SupplierAddress
description: Postal address of the supplier.
contact:
$ref: >-
#/components/schemas/JTL.Wawi.Suppliers.PublicApi.DataTransferObjects.V2.SupplierDomain.SupplierContact
description: >-
Contact information of the supplier, or null when the supplier has
no contact data.
languageIso:
type: string
description: ISO code of the language assigned to the supplier.
supplierAccountNumber:
type: string
description: >-
The supplier's own customer number for the merchant ("Eigene
Kd.-Nr."). A free-text value, not an identifier.
creditorNumber:
type: integer
description: Creditor number of the supplier.
format: int32
vatId:
type: string
description: VAT identification number of the supplier.
freightCostAmount:
type: number
description: Freight cost charged by the supplier.
format: decimal
minimumOrderValueAmount:
type: number
description: Minimum order value required by the supplier.
format: decimal
smallQuantitySurchargeAmount:
type: number
description: Surcharge applied by the supplier for small quantities.
format: decimal
cashDiscountPercentage:
type: number
description: Cash discount percentage granted by the supplier.
format: decimal
cashDiscountDays:
type: integer
description: Number of days within which the cash discount applies.
format: int32
paymentTermInDays:
type: integer
description: Payment term in days agreed with the supplier.
format: int32
freeShippingThresholdAmount:
type: number
description: Order value from which the supplier ships free of charge.
format: decimal
deliveryTimeInDays:
type: integer
description: Delivery time in days of the supplier.
format: int32
website:
type: string
description: Website URL of the supplier.
deliveryConditionNote:
type: string
description: Note on the delivery conditions of the supplier.
comment:
type: string
description: Free-text comment on the supplier.
createdAt:
type: string
description: Date and time when the supplier was created.
format: date-time
changedAt:
type: string
description: Date and time when the supplier was last changed.
format: date-time
defaultCompanyId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
description: >-
Default own-company used for orders with this supplier, or null when
unset.
defaultWarehouseId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
description: >-
Default warehouse used for orders with this supplier, or null when
unset.
isVatExempt:
type: boolean
description: Indicates whether the supplier is exempt from VAT.
isExcludedFromPurchaseList:
type: boolean
description: Indicates whether the supplier is excluded from the purchase list.
allowsDropshipCashOnDelivery:
type: boolean
description: >-
Indicates whether cash-on-delivery dropshipping is allowed for the
supplier.
allowsDropshipFreeLineItems:
type: boolean
description: >-
Indicates whether free line items are allowed in dropshipping for
the supplier.
vatFreePositionThresholdAmount:
type: number
description: >-
Order value threshold above which line items are treated as
VAT-free.
format: decimal
JTL.Wawi.Suppliers.PublicApi.DataTransferObjects.V2.SupplierDomain.SupplierAddress:
type: object
description: >-
Postal address of a supplier. A supplier has exactly one address; it
deliberately carries no company-name field (the company name lives on
SupplierDetail.CompanyName — one physical column, one property).
additionalProperties: false
properties:
salutation:
type: string
description: Salutation of the contact person (e.g. Mr., Ms.).
firstName:
type: string
description: First name of the contact person.
lastName:
type: string
description: Last name of the contact person.
additionalCompanyLine:
type: string
description: Additional company line (second company line).
street:
type: string
description: Street including house number (a single field, not split).
additionalAddressLine:
type: string
description: Additional address line (address supplement).
postalCode:
type: string
description: Postal code of the address.
city:
type: string
description: City of the address.
state:
type: string
description: Name of the state / federal state.
countryIso:
type: string
description: ISO code of the country (e.g. DE, US).
JTL.Wawi.Suppliers.PublicApi.DataTransferObjects.V2.SupplierDomain.SupplierContact:
type: object
description: Contact information of a supplier.
additionalProperties: false
properties:
emailAddress:
type: string
description: Email address of the supplier.
phoneNumber:
type: string
description: Central phone number of the supplier.
phoneExtension:
type: string
description: Direct-dial phone extension of the supplier.
faxNumber:
type: string
description: Fax number of the supplier.
contactName:
type: string
description: Name of the contact person at the supplier.
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
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:
inventories.write: Grants permission to modify stock levels.
inventory.read: Grants permission to read stock levels.
inventory.write: Grants permission to modify stock levels.
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
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.
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.
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).
sellers.read: >-
Grants permission to read marketplace sellers and their
configuration.
sellers.write: >-
Grants permission to create and modify marketplace sellers and
their configuration.
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://auth.jtl-cloud.com/oauth2/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.
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
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.
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.
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).
sellers.read: >-
Grants permission to read marketplace sellers and their
configuration.
sellers.write: >-
Grants permission to create and modify marketplace sellers and
their configuration.
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.
````