> ## 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 Customer
> Update a specific customer
## OpenAPI
````yaml /openapi/2.0.json patch /v2/customers/{customerId}
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.1.0-beta.5195+Sha.e3d2607\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.0'
x-application-version: 2.1.0.0
servers:
- url: https://api.jtl-cloud.com/erp
description: Production Environment Cloud API Gateway
security: []
tags:
- name: worker
description: Planned
- name: wms
description: >-
Query all pick
lists for a specific wms warehouse that are not completed.
- name: WawiApp
description: Development
- name: warehouse
description: >-
Query all
warehouses
- name: unitsOfMeasure
description: Development
- name: transactionStatus
description: >-
Query all transaction status for sales order
- name: tax
description: >-
Returns the
Taxrate for the given Item
- name: item
description: >-
Query all tax
classes
- name: supplier
description: >-
Query all
suppliers
- name: stock
description: >-
Query stocks for
a specific item, warehouse or storage location
- name: shippingmethod
description: >-
Query
all shipping methods
- name: shipment
description: >-
Download a
PDF Shipping Label from database by ID
- name: salesorder
description: >-
Query all
sales orders
- name: cancellationreason
description: Planned
- name: salesinvoicecorrection
description: Development
- name: saleschannel
description: >-
Get all
sales channels
- name: return
description: >-
Create a new
return with associated items and packages.
- name: returnstate
description: Planned
- name: returnreason
description: Planned
- name: property
description: >-
Query all
properties for items
- name: printer
description: >-
Returns all
Installed Printers
- name: paymentmethod
description: >-
Query
all payment methods
- name: onholdreason
description: >-
Query all
on hold reasons for sales orders
- name: offer
description: >-
Execute the
printing of a Offer
- name: Configuration
description: Planned
- name: manufacturer
description: Development
- name: label
description: Development
- name: duplicateItem
description: Development
- name: copyItem
description: Development
- name: 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: shipping
description: Development
- name: deliverynote
description: Planned
- name: customfields
description: Development
- name: customfield
description: Development
- name: customer
description: >-
Query all
customers
- name: customerGroup
description: >-
Query
all customer groups
- name: customerCategory
description: >-
Query
all customer categories
- name: creditnote
description: >-
Execute the
printing of a CreditNote
- name: company
description: >-
Query all
companies
- name: colorcodes
description: >-
Query all
color codes for sales orders
- name: category
description: Development
- name: appRegistration
description: >-
Send a
registration request for an (external) application
- name: login
description: >-
Sends a request to
log in the user / dynamically assign the WAWI user. Only use this request
if your API uses SSL.
- name: logout
description: >-
Sends a request
to log out the user
- name: attribute
description: Development
- name: accountingData
description: Planned
paths:
/v2/customers/{customerId}:
patch:
tags:
- customer
summary: Update Customer
description: Update a specific customer
operationId: Customer_UpdateCustomerAsync
parameters:
- name: x-tenant-id
in: header
required: true
schema:
type: string
format: uuid
description: The tenant ID for the target ERP instance.
- name: disableAutomaticWorkflows
in: query
description: If true, the workflows do not trigger automatic.
schema:
type: boolean
x-position: 2
- name: customerId
in: path
required: true
description: The id of the Customer to update.
schema:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundeKey'
example: b45f6432-2462-4c6f-b00f-1d9d01000000
x-position: 3
- name: x-runas
in: header
description: >-
The User-Id (int or uuid) on whose behalf the request is executed.
Requires scope 'Application.RunAs'.
schema:
type: string
- 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
requestBody:
x-name: customer
description: The customer to update.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomer
required: true
x-position: 1
responses:
'201':
description: The updated customer.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer
'400':
description: The sent data is invalid.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse
'401':
description: ''
content:
application/json: {}
'402':
description: No licence available or the app has not been authorised by JTL.
content:
application/json: {}
'404':
description: No customer with the given ID exists.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse
security:
- oauth2-authorization-code:
- customers.write
- oauth2-client-credentials:
- customers.write
components:
schemas:
JTL.Data.Contracts.Keys.KundeKey:
type: string
description: Represents a unique key for identifying a customer in the JTL system.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomer:
type: object
description: 'Model Class: UpdateCustomer '
additionalProperties: false
properties:
number:
type: string
description: The customer's number.
customerGroupId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey'
description: The customer group ID.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
billingAddress:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress
description: The customer's default billing address.
shipmentaddress:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress
description: The customer's default shipping address.
customAddress:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress
description: The customer's default non-billing and non-shipping address.
otherAddresses:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateOtherAddresses
description: All other non-default addresses of the customer.
paymentSettings:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdatePaymentSettings
description: The payment settings for the customer.
customerSince:
type: string
description: Date since they have been a customer.
format: date-time
lastChange:
type: string
description: Date of the last customer's data change.
format: date-time
languageIso:
type: string
description: The customer's language.
internalCompanyId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
description: >-
The internal ID of the company associated with the customer. This is
configured in the company and email settings in JTL-Wawi
example: b45f6432-2462-4c6f-b00f-1d9d01000000
customerCategoryId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey'
description: The customer category ID.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
taxIdentificationNumber:
type: string
description: The customer's tax identification number.
accountsReceivableNumber:
type: integer
description: The customer's accounts receivable number.
format: int32
commercialRegisterNumber:
type: string
description: The customer's commercial register number.
website:
type: string
description: The customer's website.
initialContact:
type: string
description: >-
The source of initial contact. This could be for example a specific
sales channel, a convention or a marketing campaign.
ebayUsername:
type: string
description: The customer's eBay username.
birthday:
type: string
description: The customer's date of birth.
format: date-time
isLocked:
type: boolean
description: The customer's locked status for online shop sales channels.
isCashRegisterBased:
type: boolean
description: >-
States if a customer is from a cash-register or point of sale and if
their data should be synchronized with JTL-POS, for example.
JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer:
type: object
description: 'Model Class: Customer '
additionalProperties: false
required:
- Id
- Number
- CustomerGroupId
- BillingAddress
- Shipmentaddress
- CustomAddress
- OtherAddresses
- PaymentSettings
- CustomerSince
- LastChange
- LanguageIso
- InternalCompanyId
- CustomerCategoryId
- TaxIdentificationNumber
- AccountsReceivableNumber
- CommercialRegisterNumber
- Website
- InitialContact
- EbayUsername
- Birthday
- IsLocked
- IsCashRegisterBased
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundeKey'
description: Unique ID to identify a customer.
number:
type: string
description: The customer's number.
customerGroupId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey'
description: The customer group ID.
billingAddress:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
description: The customer's default billing address.
shipmentaddress:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
description: The customer's default shipping address.
customAddress:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
description: The customer's default non-billing and non-shipping address.
otherAddresses:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.OtherAddresses
description: All other non-default addresses of the customer.
paymentSettings:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.PaymentSettings
description: The payment settings for the customer.
customerSince:
type: string
description: Date since they have been a customer.
format: date-time
lastChange:
type: string
description: Date of the last customer's data change.
format: date-time
languageIso:
type: string
description: The customer's language.
internalCompanyId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
description: >-
The internal ID of the company associated with the customer. This is
configured in the company and email settings in JTL-Wawi
customerCategoryId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey'
description: The customer category ID.
taxIdentificationNumber:
type: string
description: The customer's tax identification number.
accountsReceivableNumber:
type: integer
description: The customer's accounts receivable number.
format: int32
commercialRegisterNumber:
type: string
description: The customer's commercial register number.
website:
type: string
description: The customer's website.
initialContact:
type: string
description: >-
The source of initial contact. This could be for example a specific
sales channel, a convention or a marketing campaign.
ebayUsername:
type: string
description: The customer's eBay username.
birthday:
type: string
description: The customer's date of birth.
format: date-time
isLocked:
type: boolean
description: The customer's locked status for online shop sales channels.
isCashRegisterBased:
type: boolean
description: >-
States if a customer is from a cash-register or point of sale and if
their data should be synchronized with JTL-POS, for example.
JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse:
type: object
description: >-
Represents an error response returned by the system in case of a failure
or exception.
additionalProperties: false
properties:
errorCode:
type: string
description: >-
Gets or sets the error code that identifies the type of error
encountered.
validationErrors:
type: object
description: >-
Gets or sets a dictionary containing validation errors associated
with the request.
deprecated: true
x-deprecatedMessage: Use Errors
additionalProperties:
type: string
errors:
type: object
description: Gets or sets a collection of errors associated with the response.
additionalProperties:
type: array
items:
type: string
errorMessage:
type: string
description: >-
Gets or sets the error message that provides details about the error
encountered.
stacktrace:
type: string
description: >-
Gets or sets the stack trace associated with the error, providing
detailed
information about the sequence of method calls that led to the
exception.
JTL.Data.Contracts.Keys.KundenGruppeKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress:
type: object
description: 'Model Class: UpdateAddress '
additionalProperties: false
properties:
company:
type: string
description: Description of the Company.
company2:
type: string
description: Additional company information
formOfAddress:
type: string
description: Customer form of address
title:
type: string
description: Official title
firstName:
type: string
description: Customer first name
lastName:
type: string
description: Customer last name
street:
type: string
description: Street name in the customer's address
address2:
type: string
description: Additional address information
postalCode:
type: string
description: Postal code of the customer's address
city:
type: string
description: Name of city in the customer's address
state:
type: string
description: Name of state in the customer's address
countryIso:
type: string
description: Country ISO code
vatID:
type: string
description: Supplier VAT ID number
phoneNumber:
type: string
description: Landline phone number
mobilePhoneNumber:
type: string
description: Mobile phone number
emailAddress:
type: string
description: Email address
fax:
type: string
description: Fax number
JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateOtherAddresses:
type: object
description: 'Model Class: UpdateOtherAddresses '
additionalProperties: false
properties:
otherBillingAddresses:
type: array
description: All other non-default billing addresses of the customer.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress
otherShippingAddresses:
type: array
description: All other non-default shipping addresses of the customer.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress
otherCustomerAddresses:
type: array
description: All other non-billing and non-shipping addresses of the customer.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress
JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdatePaymentSettings:
type: object
description: 'Model Class: UpdatePaymentSettings '
additionalProperties: false
properties:
paymentMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey'
description: The unique ID to identify a payment method.
example: b45f6432-2462-4c6f-b00f-1d9d01000000
discount:
type: number
description: The indicated discount, if any.
format: decimal
paymentTarget:
type: integer
description: The payment target in days.
format: int32
creditLimit:
type: integer
description: The customer's credit limit.
format: int32
stopPaymentRequest:
type: boolean
description: Option to stop payment requests.
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.KundenKategorieKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Rest.Contracts.Models.V1.Common.Address:
type: object
description: 'Model Class: Address '
additionalProperties: false
required:
- Id
- Company
- Company2
- FormOfAddress
- Title
- FirstName
- LastName
- Street
- Address2
- PostalCode
- City
- State
- CountryIso
- VatID
- PhoneNumber
- MobilePhoneNumber
- EmailAddress
- Fax
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.AdresseKey'
description: Unique ID to identify an address
company:
type: string
description: Description of the Company.
company2:
type: string
description: Additional company information
formOfAddress:
type: string
description: Customer form of address
title:
type: string
description: Official title
firstName:
type: string
description: Customer first name
lastName:
type: string
description: Customer last name
street:
type: string
description: Street name in the customer's address
address2:
type: string
description: Additional address information
postalCode:
type: string
description: Postal code of the customer's address
city:
type: string
description: Name of city in the customer's address
state:
type: string
description: Name of state in the customer's address
countryIso:
type: string
description: Country ISO code
vatID:
type: string
description: Supplier VAT ID number
phoneNumber:
type: string
description: Landline phone number
mobilePhoneNumber:
type: string
description: Mobile phone number
emailAddress:
type: string
description: Email address
fax:
type: string
description: Fax number
JTL.Wawi.Rest.Contracts.Models.V1.Customer.OtherAddresses:
type: object
description: 'Model Class: OtherAddresses '
additionalProperties: false
required:
- OtherBillingAddresses
- OtherShippingAddresses
- OtherCustomerAddresses
properties:
otherBillingAddresses:
type: array
description: All other non-default billing addresses of the customer.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
otherShippingAddresses:
type: array
description: All other non-default shipping addresses of the customer.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
otherCustomerAddresses:
type: array
description: All other non-billing and non-shipping addresses of the customer.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
JTL.Wawi.Rest.Contracts.Models.V1.Customer.PaymentSettings:
type: object
description: 'Model Class: PaymentSettings '
additionalProperties: false
required:
- PaymentMethodId
- Discount
- PaymentTarget
- CreditLimit
- StopPaymentRequest
properties:
paymentMethodId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey'
description: The unique ID to identify a payment method.
discount:
type: number
description: The indicated discount, if any.
format: decimal
paymentTarget:
type: integer
description: The payment target in days.
format: int32
creditLimit:
type: integer
description: The customer's credit limit.
format: int32
stopPaymentRequest:
type: boolean
description: Option to stop payment requests.
JTL.Data.Contracts.Keys.ZahlungsartKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Data.Contracts.Keys.AdresseKey:
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: Artikel lesen
items.write: Artikel schreiben
accountings.read: ''
all.read: Erlaubt der Anwendung, alle Daten zu lesen.
authentication.updateforeignapp: ''
cusomters.read: ''
customers.read: ''
customers.write: ''
customfields.read: ''
customfields.write: ''
deliveries.read: ''
deliveries.write: ''
deliverynotes.print: ''
deliverynotes.read: ''
deliverynotes.write: ''
extensibility.integration: ''
foreignapps.manage: ''
inventories.read: ''
inventories.write: ''
invoices.print: ''
invoices.read: ''
invoices.write: ''
labels.read: ''
labels.write: ''
offers.print: ''
offers.read: ''
orders.read: ''
picklists.read: ''
picklists.write: ''
returns.read: ''
returns.write: ''
saleschannels.read: ''
salesinvoicecorrections.print: ''
salesinvoicecorrections.read: ''
salesinvoicecorrections.write: ''
salesorders.print: ''
salesorders.read: ''
salesorders.write: ''
suppliers.read: ''
system.config.read: ''
system.config.write: ''
system.read: ''
system.worker.read: ''
system.worker.write: ''
taxes.read: ''
warehouse.read: ''
wawiapp.all: Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
resources.read: Ressourcen lesen
resources.write: Ressourcen schreiben
pps.read: Produktionsdaten lesen
pps.write: Produktionsdaten schreiben
inventory.read: Lagerbestand lesen
inventory.write: Lagerbestand schreiben
taxes.write: Steuern schreiben
application.runas: >-
Ermöglicht der Anwendung, Anfragen im Namen eines anderen
Benutzers auszuführen.
oauth2-client-credentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.jtl-cloud.com/oauth2/token
scopes:
items.read: Artikel lesen
items.write: Artikel schreiben
accountings.read: ''
all.read: Erlaubt der Anwendung, alle Daten zu lesen.
authentication.updateforeignapp: ''
cusomters.read: ''
customers.read: ''
customers.write: ''
customfields.read: ''
customfields.write: ''
deliveries.read: ''
deliveries.write: ''
deliverynotes.print: ''
deliverynotes.read: ''
deliverynotes.write: ''
extensibility.integration: ''
foreignapps.manage: ''
inventories.read: ''
inventories.write: ''
invoices.print: ''
invoices.read: ''
invoices.write: ''
labels.read: ''
labels.write: ''
offers.print: ''
offers.read: ''
orders.read: ''
picklists.read: ''
picklists.write: ''
returns.read: ''
returns.write: ''
saleschannels.read: ''
salesinvoicecorrections.print: ''
salesinvoicecorrections.read: ''
salesinvoicecorrections.write: ''
salesorders.print: ''
salesorders.read: ''
salesorders.write: ''
suppliers.read: ''
system.config.read: ''
system.config.write: ''
system.read: ''
system.worker.read: ''
system.worker.write: ''
taxes.read: ''
warehouse.read: ''
wawiapp.all: Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
resources.read: Ressourcen lesen
resources.write: Ressourcen schreiben
pps.read: Produktionsdaten lesen
pps.write: Produktionsdaten schreiben
inventory.read: Lagerbestand lesen
inventory.write: Lagerbestand schreiben
taxes.write: Steuern schreiben
application.runas: >-
Ermöglicht der Anwendung, Anfragen im Namen eines anderen
Benutzers auszuführen.
````