> ## 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.
# Create Sales Order Note
> Create a new note for a specific sales order
## OpenAPI
````yaml /openapi/1.4.json post /salesOrders/{salesOrderId}/notes
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: '1.4'
x-application-version: 2.2.0.0
servers:
- url: https://api.jtl-cloud.com/erp
description: Production Environment Cloud API Gateway
security: []
tags:
- name: Worker
description: >-
Returns the
Available Syncs of the Worker
- name: WMS
description: >-
Query all pick
lists for a specific wms warehouse that are not completed.
- name: Warehouses
description: >-
Query all
warehouses
- name: Transaction Status
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: Inventory
description: >-
Query stocks
for a specific item, warehouse or storage location
- name: Master Data
description: >-
Query all
shipping methods
- name: Sales Order
description: >-
Query all
sales orders
- name: Sales Invoice Correction
description: Planned
- name: Sales Channel
description: >-
Get all
sales channels
- name: Return
description: >-
Create a new
return with associated items and packages.
- name: Refund
description: Planned
- name: Property
description: >-
Query all
properties for items
- name: Printer
description: >-
Returns all
Installed Printers
- name: Sales Quotation
description: >-
Execute
the printing of a Offer
- 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: Customer
description: >-
Query all
customers
- name: Company
description: >-
Query all
companies
- name: Cancellation Reason
description: >-
Query all cancellation reasons for sales orders
- name: Authentication
description: >-
DEPRECATED seit Wawi 2.2.0: No-Op. Seit
Wawi 2.1.0 registriert sich die Wawi selbst per JWT.
- name: Accounting Data
description: Planned
paths:
/salesOrders/{salesOrderId}/notes:
post:
tags:
- Sales Order
summary: Create Sales Order Note
description: Create a new note for a specific sales order
operationId: SalesOrderHeader_CreateSalesOrderNoteAsync
parameters:
- name: salesOrderId
in: path
required: true
description: The id of the sales order that the notes belong to.
schema:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey'
x-position: 2
- 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: note
description: The note of the sales order to create.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateNote
required: true
x-position: 1
responses:
'201':
description: The created note of the sales order.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Note
'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: {}
deprecated: true
security:
- oauth2-authorization-code: []
- oauth2-client-credentials: []
components:
schemas:
JTL.Data.Contracts.Keys.VerkaufAuftragKey:
type: integer
format: int32
additionalProperties: false
JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateNote:
type: object
description: 'Model Class: CreateNote '
additionalProperties: false
required:
- NoteBody
properties:
NoteBody:
type: string
description: The text in the customer note.
JTL.Wawi.Rest.Contracts.Models.V1.Common.Note:
type: object
description: 'Model Class: Note '
additionalProperties: false
required:
- NoteId
- NoteBody
properties:
NoteId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.NotizKey'
description: >-
Unique ID to identify a customer note. A customer note always has a
customer reference and may have a sales order reference as well.
NoteBody:
type: string
description: The text in the customer note.
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.NotizKey:
type: integer
format: int32
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:
wawiapp.all: Grants access to Wawi app related operations.
accountingdata.queryaccountingdata: Grants permission to query and retrieve accounting data.
accountings.read: Grants permission to read accounting data.
all.read: Allows the application to read all data.
availability.queryavailabilities: Grants permission to query and retrieve availabilities.
cancellationreason.querycancellationreasons: Grants permission to query and retrieve cancellation reasons.
category.addcategoryitems: Grants permission to add items to specific categories.
category.createcategory: Grants permission to create categories.
category.createcategorydescription: Grants permission to create category descriptions.
category.deletecategorydescription: Grants permission to delete category descriptions.
category.getcategory: Grants permission to retrieve category details.
category.querycategories: Grants permission to query and retrieve multiple categories.
category.querycategorydescriptions: Grants permission to query and retrieve category descriptions.
category.updatecategory: Grants permission to update and retrieve categories.
category.updatecategorydescription: Grants permission to update and retrieve category descriptions.
colorcode.querycolorcodes: Grants permission to query and retrieve color codes.
company.querycompanies: Grants permission to query and retrieve company details.
condition.queryconditions: Grants permission to query and retrieve conditions.
creditnote.mailcreditnote: Grants permission to send credit notes by email.
creditnote.pdfcreditnote: Grants permission to generate credit notes as a PDF document.
creditnote.printcreditnote: Grants permission to print credit notes.
cusomters.read: Grants permission to read customer data.
customer.createcustomer: Grants permission to create and retrieve customer details.
customer.createcustomerbankaccount: Grants permission to create and retrieve customer bank accounts.
customer.createcustomercontact: Grants permission to create and retrieve customer contacts.
customer.createcustomernote: Grants permission to create and retrieve customer notes.
customer.deletecustomer: Grants permission to delete and retrieve customer details.
customer.deletecustomerbankaccount: Grants permission to delete and retrieve customer bank accounts.
customer.deletecustomercontact: Grants permission to delete and retrieve customer contacts.
customer.deletecustomercustomfield: Grants permission to delete and retrieve customer custom fields.
customer.deletecustomernote: Grants permission to delete and retrieve customer notes.
customer.getcustomer: Grants permission to retrieve customer details.
customer.getcustomerbankaccount: Grants permission to retrieve customer bank account details.
customer.getcustomercontact: Grants permission to retrieve customer contact details.
customer.getcustomerlastchange: >-
Grants permission to query the customers that have changed since a
given point in time.
customer.getcustomernote: Grants permission to retrieve customer note details.
customer.querycustomerbankaccounts: Grants permission to query and retrieve customer bank accounts.
customer.querycustomercontacts: Grants permission to query and retrieve customer contacts.
customer.querycustomercustomfields: Grants permission to query and retrieve customer custom fields.
customer.querycustomercustomfieldvalues: >-
Grants permission to query and retrieve custom field values for
customers.
customer.querycustomernotes: Grants permission to query and retrieve customer notes.
customer.querycustomers: Grants permission to query and retrieve customer data.
customer.querycustomerworkflowevents: Grants permission to query and retrieve customer workflow events.
customer.triggercustomerworkflow: Grants permission to trigger workflow events for customers.
customer.triggercustomerworkflowevent: Grants permission to trigger customer workflow events.
customer.updatecustomer: Grants permission to update and retrieve customer details.
customer.updatecustomerbankaccount: Grants permission to update and retrieve customer bank accounts.
customer.updatecustomercontact: Grants permission to update and retrieve customer contacts.
customer.updatecustomercustomfield: Grants permission to update and retrieve customer custom fields.
customer.updatecustomernote: Grants permission to update and retrieve customer notes.
customercategory.createcustomercategory: Grants permission to create and retrieve customer categories.
customercategory.deletecustomercategory: Grants permission to delete and retrieve customer categories.
customercategory.getcustomercategory: Grants permission to retrieve customer category details.
customercategory.querycustomercategories: Grants permission to query and retrieve customer categories.
customercategory.updatecustomercategory: Grants permission to update and retrieve customer categories.
customergroup.createcustomergroup: Grants permission to create and retrieve customer groups.
customergroup.deletecustomergroup: Grants permission to delete and retrieve customer groups.
customergroup.getcustomergroup: Grants permission to retrieve customer group details.
customergroup.querycustomergroups: Grants permission to query and retrieve customer groups.
customergroup.updatecustomergroup: Grants permission to update and retrieve customer groups.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliveryapi.cancelreservation: Grants permission to cancel stock reservations.
deliveryapi.deliversalesorder: Grants permission to ship and deliver sales orders.
deliveryapi.queryreservations: Grants permission to retrieve all reserved sales orders.
deliveryapi.reassignstock: Grants permission to re-reserve and reassign stock.
deliveryapi.reservesalesorders: Grants permission to reserve stock for sales orders.
deliverynote.getdeliverynote: Grants permission to retrieve delivery notes.
deliverynote.getdeliverynotepackages: Grants permission to retrieve delivery note packages.
deliverynote.maildeliverynote: Grants permission to send delivery notes by email.
deliverynote.package: Grants permission to manage delivery note packages.
deliverynote.patchpackagedata: Grants permission to patch package data for delivery notes.
deliverynote.pdfdeliverynote: Grants permission to generate delivery notes as a PDF document.
deliverynote.postpackagedatafordeliverynote: Grants permission to post package data for delivery notes.
deliverynote.printdeliverynote: Grants permission to print delivery notes.
deliverynote.querydeliverynotes: Grants permission to query and retrieve delivery notes.
deliverynote.triggerdeliverynoteworkflow: Grants permission to trigger workflow events for delivery notes.
deliverynotes.package: Grants permission to manage delivery note packages.
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.createextension: Grants permission to register an extension.
extensibility.deleteextension: Grants permission to delete and thereby deactivate an extension.
extensibility.getextension: Grants permission to retrieve a single extension.
extensibility.getextensions: Grants permission to retrieve all installed extensions.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
extensibility.putextensionmanifest: >-
Grants permission to push an extension manifest together with its
signature.
extensibility.updateextension: Grants permission to update information of an extension.
inventories.read: Grants permission to read stock levels.
inventories.write: Grants permission to modify stock levels.
invoice.cancelinvoice: Grants permission to cancel an invoice
invoice.finalizeinvoice: Grants permission to finalize an invoice
invoice.getinvoice: Grants permission to retrieve invoices.
invoice.mailinvoice: Grants permission to send invoices by email.
invoice.pdfinvoice: Grants permission to generate invoices as a PDF document.
invoice.printinvoice: Grants permission to print invoices.
invoice.queryinvoicecancellationreasons: >-
Grants permission to query and retrieve invoice cancellation
reasons.
invoice.queryinvoicelineitems: Grants permission to query and retrieve invoice line items.
invoice.queryinvoices: Grants permission to query and retrieve invoices.
invoice.queryinvoiceworkflowevents: Grants permission to query and retrieve invoice workflow events.
invoice.triggerinvoiceworkflow: Grants permission to trigger invoice workflows
invoice.triggerinvoiceworkflowevent: Grants permission to trigger invoice workflow events.
invoices.print: Grants permission to print and output invoices.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
item.assignchilditemtoparent: Grants permission to assign child items to parent items.
item.createitem: Grants permission to create and retrieve items.
item.createitemcustomerprice: Grants permission to create and retrieve item customer prices.
item.createitemdescription: Grants permission to create and retrieve item descriptions.
item.createitemimage: Grants permission to create and retrieve item images.
item.createitemproperty: Grants permission to create and retrieve item properties.
item.createitemsaleschannelprice: >-
Grants permission to create and retrieve item sales channel
prices.
item.createitemsupplier: Grants permission to create and retrieve item suppliers.
item.createitemvariation: Grants permission to create and retrieve item variations.
item.createitemvariationvalue: Grants permission to create and retrieve item variation values.
item.deleteitemcustomerprice: Grants permission to delete and retrieve item customer prices.
item.deleteitemcustomfield: Grants permission to delete and retrieve item custom fields.
item.deleteitemdescription: Grants permission to delete and retrieve item descriptions.
item.deleteitemimage: Grants permission to delete and retrieve item images.
item.deleteitemproperty: Grants permission to delete and retrieve item properties.
item.deleteitemsaleschannelprice: >-
Grants permission to delete and retrieve item sales channel
prices.
item.deleteitemsupplier: Grants permission to delete and retrieve item suppliers.
item.deleteitemvariation: Grants permission to delete and retrieve item variations.
item.deleteitemvariationvalue: Grants permission to delete and retrieve item variation values.
item.getitem: Grants permission to retrieve item details.
item.queryitemcustomerprices: Grants permission to query and retrieve item customer prices.
item.queryitemcustomfields: Grants permission to query and retrieve item custom fields.
item.queryitemcustomfieldvalues: Grants permission to query and retrieve item custom field values.
item.queryitemdescriptions: Grants permission to query and retrieve item descriptions.
item.queryitemimagedata: Grants permission to query and retrieve item image data.
item.queryitemimages: Grants permission to query and retrieve item images.
item.queryitemproperties: Grants permission to query and retrieve item properties.
item.queryitems: Grants permission to query and retrieve items.
item.queryitemsaleschannelprice: Grants permission to query and retrieve item sales channel prices.
item.queryitemspecialprice: Grants permission to query and retrieve item special prices.
item.queryitemsuppliers: Grants permission to query and retrieve item suppliers.
item.queryitemvariations: Grants permission to query and retrieve item variations.
item.queryitemvariationvalues: Grants permission to query and retrieve item variation values.
item.queryitemworkflowevents: Grants permission to query and retrieve item workflow events.
item.triggeritemworkflow: Grants permission to trigger workflow events for items.
item.triggeritemworkflowevent: Grants permission to trigger item workflow events.
item.updateitem: Grants permission to update and retrieve items.
item.updateitemcustomerprice: Grants permission to update and retrieve item customer prices.
item.updateitemcustomfield: Grants permission to update and retrieve item custom fields.
item.updateitemdescription: Grants permission to update and retrieve item descriptions.
item.updateitemimage: Grants permission to update and retrieve item images.
item.updateitemsaleschannelprice: >-
Grants permission to update and retrieve item sales channel
prices.
item.updateitemsaleschannels: Grants permission to update the active sales channels of an item.
item.updateitemspecialprice: Grants permission to update and retrieve item special prices.
item.updateitemsupplier: Grants permission to update and retrieve item suppliers.
item.updateitemvariation: Grants permission to update and retrieve item variations.
item.updateitemvariationvalue: Grants permission to update and retrieve item variation values.
items.read: Grants permission to read item master data.
items.write: Grants permission to create and modify item master data.
manufacturer.querymanufacturers: Grants permission to query and retrieve manufacturers.
numberranges.createnumberrange: Grants permission to create number ranges.
numberranges.deletenumberrange: Grants permission to delete number ranges.
numberranges.getnumberrange: >-
Grants permission to retrieve the details of a single number
range.
numberranges.getnumberranges: Grants permission to retrieve the list of all number ranges.
numberranges.numberrangeincrement: >-
Increments the counter of a number range and returns the next
value.
numberranges.numberrangepreview: >-
Returns a preview of the next value of a number range without
incrementing the counter.
numberranges.updatenumberrange: Grants permission to update number ranges.
offer.mailoffer: Grants permission to send offers by email.
offer.pdfoffer: Grants permission to generate offers as a PDF document.
offer.printoffer: Grants permission to print offers.
offers.print: Grants permission to print and output offers.
offers.read: Grants permission to read offers.
onholdreason.queryonholdreasons: Grants permission to query and retrieve on-hold reasons.
orders.read: Grants permission to read orders.
paymentmethod.querypaymentmethods: Grants permission to query and retrieve payment methods.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
printers.installedprinters: >-
Grants permission to retrieve the printers installed on the
system.
productgroup.queryproductgroups: Grants permission to query and retrieve product groups.
property.createproperty: Grants permission to create and retrieve properties.
property.createpropertygroup: Grants permission to create and retrieve property groups.
property.createpropertyvalue: Grants permission to create and retrieve property values.
property.createpropertyvaluedescription: >-
Grants permission to create and retrieve property value
descriptions.
property.deletepropertyvalue: Grants permission to delete and retrieve property values.
property.deletepropertyvaluedescription: >-
Grants permission to delete and retrieve property value
descriptions.
property.queryproperties: Grants permission to query and retrieve properties.
property.querypropertygroups: Grants permission to query and retrieve property groups.
property.querypropertyvaluedescriptions: >-
Grants permission to query and retrieve property value
descriptions.
property.querypropertyvalues: Grants permission to query and retrieve property values.
property.updatepropertyvalue: Grants permission to update and retrieve property values.
property.updatepropertyvaluedescription: >-
Grants permission to update and retrieve property value
descriptions.
refund.queryrefundcancellationreasons: >-
Grants permission to query sales invoice correction cancellation
reasons
responsibleperson.queryresponsiblepersons: Grants permission to query and retrieve responsible persons.
return.createreturn: Grants permission to create returns.
return.getreturn: Grants permission to retrieve return details.
return.queryreturnlineitems: Grants permission to query and retrieve return line items.
return.queryreturnpackages: Grants permission to query the shipping information of returns.
return.queryreturns: Grants permission to query and retrieve returns.
returnreason.queryreturnreasons: Grants permission to query and retrieve return reasons.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
returnstate.queryreturnstates: Grants permission to query and retrieve return states.
saleschannel.getsaleschannels: Grants permission to retrieve sales channels.
saleschannels.read: Grants permission to read sales channels.
salesinvoicecorrection.finalizesalesinvoicecorrection: Grants permission to finalize a sales invoice correction
salesinvoicecorrection.querysalesinvoicecorrectioncancellationreasons: >-
Grants permission to query the sales invoice correction
cancellation reasons
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorder.cancelsalesorder: Grants permission to cancel and retrieve sales orders.
salesorder.createsalesorder: Grants permission to create and retrieve sales orders.
salesorder.createsalesorderfile: Grants permission to create and retrieve sales order files.
salesorder.createsalesorderlineitem: Grants permission to create and retrieve sales order line items.
salesorder.createsalesorderlineitemfile: >-
Grants permission to create and retrieve sales order line item
files.
salesorder.createsalesordernote: Grants permission to create and retrieve sales order notes.
salesorder.deletesalesordercustomfield: >-
Grants permission to delete and retrieve sales order custom
fields.
salesorder.deletesalesorderfile: Grants permission to delete and retrieve sales order files.
salesorder.deletesalesorderlineitem: Grants permission to delete and retrieve sales order line items.
salesorder.deletesalesorderlineitemfile: Grants permission to delete sales order line item files.
salesorder.deletesalesordernote: Grants permission to delete and retrieve sales order notes.
salesorder.getsalesorder: Grants permission to retrieve sales orders.
salesorder.mailsalesorder: Grants permission to send sales orders by email.
salesorder.newinvoice: Grants permission to create an invoice for a sales order.
salesorder.pdfsalesorder: Grants permission to generate sales orders as a PDF document.
salesorder.printsalesorder: Grants permission to print sales orders.
salesorder.querysalesordercancellationreasons: >-
Grants permission to query and retrieve sales order cancellation
reasons.
salesorder.querysalesordercustomfields: Grants permission to query and retrieve sales order custom fields.
salesorder.querysalesordercustomfieldvalues: >-
Grants permission to query and retrieve sales order custom field
values.
salesorder.querysalesorderfiledata: Grants permission to query and retrieve sales order file data.
salesorder.querysalesorderfiles: Grants permission to query and retrieve sales order files.
salesorder.querysalesorderlineitemfiledata: >-
Grants permission to query and retrieve sales order line item file
data.
salesorder.querysalesorderlineitemfiles: >-
Grants permission to query and retrieve sales order line item
files.
salesorder.querysalesorderlineitems: Grants permission to query and retrieve sales order line items.
salesorder.querysalesordernotes: Grants permission to query and retrieve sales order notes.
salesorder.querysalesorders: Grants permission to query and retrieve sales orders.
salesorder.querysalesorderworkflowevents: >-
Grants permission to query and retrieve sales order workflow
events.
salesorder.triggersalesorderworkflow: Grants permission to trigger workflow events for sales orders.
salesorder.triggersalesorderworkflowevent: Grants permission to trigger sales order workflow events.
salesorder.undosalesordercancellation: Grants the permission to undo an order cancellation.
salesorder.updatesalesorder: Grants permission to update and retrieve sales orders.
salesorder.updatesalesordercustomfield: >-
Grants permission to update and retrieve sales order custom
fields.
salesorder.updatesalesorderfile: Grants permission to update and retrieve sales order files.
salesorder.updatesalesorderlineitem: Grants permission to update and retrieve sales order line items.
salesorder.updatesalesorderlineitemfile: >-
Grants permission to update and retrieve sales order line item
files.
salesorder.updatesalesordernote: Grants permission to update and retrieve sales order notes.
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.
shippingclass.queryshippingclasses: Grants permission to query and retrieve shipping classes.
shippingmethod.queryshippingmethods: Grants permission to query and retrieve shipping methods.
stock.queryserialnumberperwarehouse: >-
Grants permission to query and retrieve serial numbers per
warehouse.
stock.querystockchanges: Grants permission to query and retrieve stock changes.
stock.querystocksperitem: Grants permission to query and retrieve stock per item.
stock.stockadjustment: Grants permission to adjust and retrieve stock levels.
supplier.querysuppliers: Grants permission to query and retrieve suppliers.
suppliers.read: Grants permission to read suppliers.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
system.read: Grants permission to read system-related data and configuration.
system.worker.read: >-
Grants permission to read the configuration and status of
background workers.
system.worker.write: Grants permission to configure and control background workers.
taxclass.querytaxclasses: Grants permission to query and retrieve tax classes.
taxes.read: Grants permission to read tax data.
transactionstatus.querytransactionstatus: Grants permission to query and retrieve transaction statuses.
warehouse.querystoragelocations: Grants permission to query and retrieve storage locations.
warehouse.querystoragelocationtype: Grants permission to query and retrieve storage location types.
warehouse.querywarehouses: Grants permission to query and retrieve warehouses.
warehouse.querywarehousetypes: Grants permission to query and retrieve warehouse types.
warehouse.read: Grants permission to read warehouse data.
wms.changereservation: >-
Grants permission to change stock reservations in warehouse
management.
wms.createpicklist: Grants permission to create and retrieve pick lists.
wms.deletepicklistposition: Grants permission to delete a position from a pick list.
wms.pickposition: Grants permission to pick a pick list position.
wms.querypicklist: Grants permission to query and retrieve pick lists.
wms.querypicklistposition: Grants permission to query and retrieve pick list positions.
wms.querypicklisttemplate: Grants permission to query and retrieve pick list templates.
worker.configuresync: >-
Grants permission to configure the synchronization of background
workers.
worker.getworkerstatus: Grants permission to retrieve the status of background workers.
worker.getworkersyncs: >-
Grants permission to retrieve the synchronization settings of
background workers.
worker.synccontrol: >-
Grants permission to control the synchronization of background
workers.
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:
wawiapp.all: Grants access to Wawi app related operations.
accountingdata.queryaccountingdata: Grants permission to query and retrieve accounting data.
accountings.read: Grants permission to read accounting data.
all.read: Allows the application to read all data.
availability.queryavailabilities: Grants permission to query and retrieve availabilities.
cancellationreason.querycancellationreasons: Grants permission to query and retrieve cancellation reasons.
category.addcategoryitems: Grants permission to add items to specific categories.
category.createcategory: Grants permission to create categories.
category.createcategorydescription: Grants permission to create category descriptions.
category.deletecategorydescription: Grants permission to delete category descriptions.
category.getcategory: Grants permission to retrieve category details.
category.querycategories: Grants permission to query and retrieve multiple categories.
category.querycategorydescriptions: Grants permission to query and retrieve category descriptions.
category.updatecategory: Grants permission to update and retrieve categories.
category.updatecategorydescription: Grants permission to update and retrieve category descriptions.
colorcode.querycolorcodes: Grants permission to query and retrieve color codes.
company.querycompanies: Grants permission to query and retrieve company details.
condition.queryconditions: Grants permission to query and retrieve conditions.
creditnote.mailcreditnote: Grants permission to send credit notes by email.
creditnote.pdfcreditnote: Grants permission to generate credit notes as a PDF document.
creditnote.printcreditnote: Grants permission to print credit notes.
cusomters.read: Grants permission to read customer data.
customer.createcustomer: Grants permission to create and retrieve customer details.
customer.createcustomerbankaccount: Grants permission to create and retrieve customer bank accounts.
customer.createcustomercontact: Grants permission to create and retrieve customer contacts.
customer.createcustomernote: Grants permission to create and retrieve customer notes.
customer.deletecustomer: Grants permission to delete and retrieve customer details.
customer.deletecustomerbankaccount: Grants permission to delete and retrieve customer bank accounts.
customer.deletecustomercontact: Grants permission to delete and retrieve customer contacts.
customer.deletecustomercustomfield: Grants permission to delete and retrieve customer custom fields.
customer.deletecustomernote: Grants permission to delete and retrieve customer notes.
customer.getcustomer: Grants permission to retrieve customer details.
customer.getcustomerbankaccount: Grants permission to retrieve customer bank account details.
customer.getcustomercontact: Grants permission to retrieve customer contact details.
customer.getcustomerlastchange: >-
Grants permission to query the customers that have changed since a
given point in time.
customer.getcustomernote: Grants permission to retrieve customer note details.
customer.querycustomerbankaccounts: Grants permission to query and retrieve customer bank accounts.
customer.querycustomercontacts: Grants permission to query and retrieve customer contacts.
customer.querycustomercustomfields: Grants permission to query and retrieve customer custom fields.
customer.querycustomercustomfieldvalues: >-
Grants permission to query and retrieve custom field values for
customers.
customer.querycustomernotes: Grants permission to query and retrieve customer notes.
customer.querycustomers: Grants permission to query and retrieve customer data.
customer.querycustomerworkflowevents: Grants permission to query and retrieve customer workflow events.
customer.triggercustomerworkflow: Grants permission to trigger workflow events for customers.
customer.triggercustomerworkflowevent: Grants permission to trigger customer workflow events.
customer.updatecustomer: Grants permission to update and retrieve customer details.
customer.updatecustomerbankaccount: Grants permission to update and retrieve customer bank accounts.
customer.updatecustomercontact: Grants permission to update and retrieve customer contacts.
customer.updatecustomercustomfield: Grants permission to update and retrieve customer custom fields.
customer.updatecustomernote: Grants permission to update and retrieve customer notes.
customercategory.createcustomercategory: Grants permission to create and retrieve customer categories.
customercategory.deletecustomercategory: Grants permission to delete and retrieve customer categories.
customercategory.getcustomercategory: Grants permission to retrieve customer category details.
customercategory.querycustomercategories: Grants permission to query and retrieve customer categories.
customercategory.updatecustomercategory: Grants permission to update and retrieve customer categories.
customergroup.createcustomergroup: Grants permission to create and retrieve customer groups.
customergroup.deletecustomergroup: Grants permission to delete and retrieve customer groups.
customergroup.getcustomergroup: Grants permission to retrieve customer group details.
customergroup.querycustomergroups: Grants permission to query and retrieve customer groups.
customergroup.updatecustomergroup: Grants permission to update and retrieve customer groups.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliveryapi.cancelreservation: Grants permission to cancel stock reservations.
deliveryapi.deliversalesorder: Grants permission to ship and deliver sales orders.
deliveryapi.queryreservations: Grants permission to retrieve all reserved sales orders.
deliveryapi.reassignstock: Grants permission to re-reserve and reassign stock.
deliveryapi.reservesalesorders: Grants permission to reserve stock for sales orders.
deliverynote.getdeliverynote: Grants permission to retrieve delivery notes.
deliverynote.getdeliverynotepackages: Grants permission to retrieve delivery note packages.
deliverynote.maildeliverynote: Grants permission to send delivery notes by email.
deliverynote.package: Grants permission to manage delivery note packages.
deliverynote.patchpackagedata: Grants permission to patch package data for delivery notes.
deliverynote.pdfdeliverynote: Grants permission to generate delivery notes as a PDF document.
deliverynote.postpackagedatafordeliverynote: Grants permission to post package data for delivery notes.
deliverynote.printdeliverynote: Grants permission to print delivery notes.
deliverynote.querydeliverynotes: Grants permission to query and retrieve delivery notes.
deliverynote.triggerdeliverynoteworkflow: Grants permission to trigger workflow events for delivery notes.
deliverynotes.package: Grants permission to manage delivery note packages.
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.createextension: Grants permission to register an extension.
extensibility.deleteextension: Grants permission to delete and thereby deactivate an extension.
extensibility.getextension: Grants permission to retrieve a single extension.
extensibility.getextensions: Grants permission to retrieve all installed extensions.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
extensibility.putextensionmanifest: >-
Grants permission to push an extension manifest together with its
signature.
extensibility.updateextension: Grants permission to update information of an extension.
inventories.read: Grants permission to read stock levels.
inventories.write: Grants permission to modify stock levels.
invoice.cancelinvoice: Grants permission to cancel an invoice
invoice.finalizeinvoice: Grants permission to finalize an invoice
invoice.getinvoice: Grants permission to retrieve invoices.
invoice.mailinvoice: Grants permission to send invoices by email.
invoice.pdfinvoice: Grants permission to generate invoices as a PDF document.
invoice.printinvoice: Grants permission to print invoices.
invoice.queryinvoicecancellationreasons: >-
Grants permission to query and retrieve invoice cancellation
reasons.
invoice.queryinvoicelineitems: Grants permission to query and retrieve invoice line items.
invoice.queryinvoices: Grants permission to query and retrieve invoices.
invoice.queryinvoiceworkflowevents: Grants permission to query and retrieve invoice workflow events.
invoice.triggerinvoiceworkflow: Grants permission to trigger invoice workflows
invoice.triggerinvoiceworkflowevent: Grants permission to trigger invoice workflow events.
invoices.print: Grants permission to print and output invoices.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
item.assignchilditemtoparent: Grants permission to assign child items to parent items.
item.createitem: Grants permission to create and retrieve items.
item.createitemcustomerprice: Grants permission to create and retrieve item customer prices.
item.createitemdescription: Grants permission to create and retrieve item descriptions.
item.createitemimage: Grants permission to create and retrieve item images.
item.createitemproperty: Grants permission to create and retrieve item properties.
item.createitemsaleschannelprice: >-
Grants permission to create and retrieve item sales channel
prices.
item.createitemsupplier: Grants permission to create and retrieve item suppliers.
item.createitemvariation: Grants permission to create and retrieve item variations.
item.createitemvariationvalue: Grants permission to create and retrieve item variation values.
item.deleteitemcustomerprice: Grants permission to delete and retrieve item customer prices.
item.deleteitemcustomfield: Grants permission to delete and retrieve item custom fields.
item.deleteitemdescription: Grants permission to delete and retrieve item descriptions.
item.deleteitemimage: Grants permission to delete and retrieve item images.
item.deleteitemproperty: Grants permission to delete and retrieve item properties.
item.deleteitemsaleschannelprice: >-
Grants permission to delete and retrieve item sales channel
prices.
item.deleteitemsupplier: Grants permission to delete and retrieve item suppliers.
item.deleteitemvariation: Grants permission to delete and retrieve item variations.
item.deleteitemvariationvalue: Grants permission to delete and retrieve item variation values.
item.getitem: Grants permission to retrieve item details.
item.queryitemcustomerprices: Grants permission to query and retrieve item customer prices.
item.queryitemcustomfields: Grants permission to query and retrieve item custom fields.
item.queryitemcustomfieldvalues: Grants permission to query and retrieve item custom field values.
item.queryitemdescriptions: Grants permission to query and retrieve item descriptions.
item.queryitemimagedata: Grants permission to query and retrieve item image data.
item.queryitemimages: Grants permission to query and retrieve item images.
item.queryitemproperties: Grants permission to query and retrieve item properties.
item.queryitems: Grants permission to query and retrieve items.
item.queryitemsaleschannelprice: Grants permission to query and retrieve item sales channel prices.
item.queryitemspecialprice: Grants permission to query and retrieve item special prices.
item.queryitemsuppliers: Grants permission to query and retrieve item suppliers.
item.queryitemvariations: Grants permission to query and retrieve item variations.
item.queryitemvariationvalues: Grants permission to query and retrieve item variation values.
item.queryitemworkflowevents: Grants permission to query and retrieve item workflow events.
item.triggeritemworkflow: Grants permission to trigger workflow events for items.
item.triggeritemworkflowevent: Grants permission to trigger item workflow events.
item.updateitem: Grants permission to update and retrieve items.
item.updateitemcustomerprice: Grants permission to update and retrieve item customer prices.
item.updateitemcustomfield: Grants permission to update and retrieve item custom fields.
item.updateitemdescription: Grants permission to update and retrieve item descriptions.
item.updateitemimage: Grants permission to update and retrieve item images.
item.updateitemsaleschannelprice: >-
Grants permission to update and retrieve item sales channel
prices.
item.updateitemsaleschannels: Grants permission to update the active sales channels of an item.
item.updateitemspecialprice: Grants permission to update and retrieve item special prices.
item.updateitemsupplier: Grants permission to update and retrieve item suppliers.
item.updateitemvariation: Grants permission to update and retrieve item variations.
item.updateitemvariationvalue: Grants permission to update and retrieve item variation values.
items.read: Grants permission to read item master data.
items.write: Grants permission to create and modify item master data.
manufacturer.querymanufacturers: Grants permission to query and retrieve manufacturers.
numberranges.createnumberrange: Grants permission to create number ranges.
numberranges.deletenumberrange: Grants permission to delete number ranges.
numberranges.getnumberrange: >-
Grants permission to retrieve the details of a single number
range.
numberranges.getnumberranges: Grants permission to retrieve the list of all number ranges.
numberranges.numberrangeincrement: >-
Increments the counter of a number range and returns the next
value.
numberranges.numberrangepreview: >-
Returns a preview of the next value of a number range without
incrementing the counter.
numberranges.updatenumberrange: Grants permission to update number ranges.
offer.mailoffer: Grants permission to send offers by email.
offer.pdfoffer: Grants permission to generate offers as a PDF document.
offer.printoffer: Grants permission to print offers.
offers.print: Grants permission to print and output offers.
offers.read: Grants permission to read offers.
onholdreason.queryonholdreasons: Grants permission to query and retrieve on-hold reasons.
orders.read: Grants permission to read orders.
paymentmethod.querypaymentmethods: Grants permission to query and retrieve payment methods.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
printers.installedprinters: >-
Grants permission to retrieve the printers installed on the
system.
productgroup.queryproductgroups: Grants permission to query and retrieve product groups.
property.createproperty: Grants permission to create and retrieve properties.
property.createpropertygroup: Grants permission to create and retrieve property groups.
property.createpropertyvalue: Grants permission to create and retrieve property values.
property.createpropertyvaluedescription: >-
Grants permission to create and retrieve property value
descriptions.
property.deletepropertyvalue: Grants permission to delete and retrieve property values.
property.deletepropertyvaluedescription: >-
Grants permission to delete and retrieve property value
descriptions.
property.queryproperties: Grants permission to query and retrieve properties.
property.querypropertygroups: Grants permission to query and retrieve property groups.
property.querypropertyvaluedescriptions: >-
Grants permission to query and retrieve property value
descriptions.
property.querypropertyvalues: Grants permission to query and retrieve property values.
property.updatepropertyvalue: Grants permission to update and retrieve property values.
property.updatepropertyvaluedescription: >-
Grants permission to update and retrieve property value
descriptions.
refund.queryrefundcancellationreasons: >-
Grants permission to query sales invoice correction cancellation
reasons
responsibleperson.queryresponsiblepersons: Grants permission to query and retrieve responsible persons.
return.createreturn: Grants permission to create returns.
return.getreturn: Grants permission to retrieve return details.
return.queryreturnlineitems: Grants permission to query and retrieve return line items.
return.queryreturnpackages: Grants permission to query the shipping information of returns.
return.queryreturns: Grants permission to query and retrieve returns.
returnreason.queryreturnreasons: Grants permission to query and retrieve return reasons.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
returnstate.queryreturnstates: Grants permission to query and retrieve return states.
saleschannel.getsaleschannels: Grants permission to retrieve sales channels.
saleschannels.read: Grants permission to read sales channels.
salesinvoicecorrection.finalizesalesinvoicecorrection: Grants permission to finalize a sales invoice correction
salesinvoicecorrection.querysalesinvoicecorrectioncancellationreasons: >-
Grants permission to query the sales invoice correction
cancellation reasons
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorder.cancelsalesorder: Grants permission to cancel and retrieve sales orders.
salesorder.createsalesorder: Grants permission to create and retrieve sales orders.
salesorder.createsalesorderfile: Grants permission to create and retrieve sales order files.
salesorder.createsalesorderlineitem: Grants permission to create and retrieve sales order line items.
salesorder.createsalesorderlineitemfile: >-
Grants permission to create and retrieve sales order line item
files.
salesorder.createsalesordernote: Grants permission to create and retrieve sales order notes.
salesorder.deletesalesordercustomfield: >-
Grants permission to delete and retrieve sales order custom
fields.
salesorder.deletesalesorderfile: Grants permission to delete and retrieve sales order files.
salesorder.deletesalesorderlineitem: Grants permission to delete and retrieve sales order line items.
salesorder.deletesalesorderlineitemfile: Grants permission to delete sales order line item files.
salesorder.deletesalesordernote: Grants permission to delete and retrieve sales order notes.
salesorder.getsalesorder: Grants permission to retrieve sales orders.
salesorder.mailsalesorder: Grants permission to send sales orders by email.
salesorder.newinvoice: Grants permission to create an invoice for a sales order.
salesorder.pdfsalesorder: Grants permission to generate sales orders as a PDF document.
salesorder.printsalesorder: Grants permission to print sales orders.
salesorder.querysalesordercancellationreasons: >-
Grants permission to query and retrieve sales order cancellation
reasons.
salesorder.querysalesordercustomfields: Grants permission to query and retrieve sales order custom fields.
salesorder.querysalesordercustomfieldvalues: >-
Grants permission to query and retrieve sales order custom field
values.
salesorder.querysalesorderfiledata: Grants permission to query and retrieve sales order file data.
salesorder.querysalesorderfiles: Grants permission to query and retrieve sales order files.
salesorder.querysalesorderlineitemfiledata: >-
Grants permission to query and retrieve sales order line item file
data.
salesorder.querysalesorderlineitemfiles: >-
Grants permission to query and retrieve sales order line item
files.
salesorder.querysalesorderlineitems: Grants permission to query and retrieve sales order line items.
salesorder.querysalesordernotes: Grants permission to query and retrieve sales order notes.
salesorder.querysalesorders: Grants permission to query and retrieve sales orders.
salesorder.querysalesorderworkflowevents: >-
Grants permission to query and retrieve sales order workflow
events.
salesorder.triggersalesorderworkflow: Grants permission to trigger workflow events for sales orders.
salesorder.triggersalesorderworkflowevent: Grants permission to trigger sales order workflow events.
salesorder.undosalesordercancellation: Grants the permission to undo an order cancellation.
salesorder.updatesalesorder: Grants permission to update and retrieve sales orders.
salesorder.updatesalesordercustomfield: >-
Grants permission to update and retrieve sales order custom
fields.
salesorder.updatesalesorderfile: Grants permission to update and retrieve sales order files.
salesorder.updatesalesorderlineitem: Grants permission to update and retrieve sales order line items.
salesorder.updatesalesorderlineitemfile: >-
Grants permission to update and retrieve sales order line item
files.
salesorder.updatesalesordernote: Grants permission to update and retrieve sales order notes.
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.
shippingclass.queryshippingclasses: Grants permission to query and retrieve shipping classes.
shippingmethod.queryshippingmethods: Grants permission to query and retrieve shipping methods.
stock.queryserialnumberperwarehouse: >-
Grants permission to query and retrieve serial numbers per
warehouse.
stock.querystockchanges: Grants permission to query and retrieve stock changes.
stock.querystocksperitem: Grants permission to query and retrieve stock per item.
stock.stockadjustment: Grants permission to adjust and retrieve stock levels.
supplier.querysuppliers: Grants permission to query and retrieve suppliers.
suppliers.read: Grants permission to read suppliers.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
system.read: Grants permission to read system-related data and configuration.
system.worker.read: >-
Grants permission to read the configuration and status of
background workers.
system.worker.write: Grants permission to configure and control background workers.
taxclass.querytaxclasses: Grants permission to query and retrieve tax classes.
taxes.read: Grants permission to read tax data.
transactionstatus.querytransactionstatus: Grants permission to query and retrieve transaction statuses.
warehouse.querystoragelocations: Grants permission to query and retrieve storage locations.
warehouse.querystoragelocationtype: Grants permission to query and retrieve storage location types.
warehouse.querywarehouses: Grants permission to query and retrieve warehouses.
warehouse.querywarehousetypes: Grants permission to query and retrieve warehouse types.
warehouse.read: Grants permission to read warehouse data.
wms.changereservation: >-
Grants permission to change stock reservations in warehouse
management.
wms.createpicklist: Grants permission to create and retrieve pick lists.
wms.deletepicklistposition: Grants permission to delete a position from a pick list.
wms.pickposition: Grants permission to pick a pick list position.
wms.querypicklist: Grants permission to query and retrieve pick lists.
wms.querypicklistposition: Grants permission to query and retrieve pick list positions.
wms.querypicklisttemplate: Grants permission to query and retrieve pick list templates.
worker.configuresync: >-
Grants permission to configure the synchronization of background
workers.
worker.getworkerstatus: Grants permission to retrieve the status of background workers.
worker.getworkersyncs: >-
Grants permission to retrieve the synchronization settings of
background workers.
worker.synccontrol: >-
Grants permission to control the synchronization of background
workers.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
````