> ## 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.
# Convert Item To Kit Item
> Converts an existing standard item into a kit, so that selling one unit of it consumes a fixed set of component items from then on. The full component list is mandatory, because a standard item has no component list to fall back on - supplying at least one component is what makes the item a kit. The item keeps its ID, but the conversion resets several settings and converting back does not restore them: the suppliers are removed, because a kit has no suppliers; stock management is switched off first, which clears the per-warehouse minimum and maximum stock levels written through "PATCH /v2/items/{itemId}/warehouse-constraints" and switches "allowNegativeStock" off; and divisible stock is switched off. An item that tracks best-before dates, batches or serial numbers is not converted at all (409). The kit's stock management is then derived from its components - it is stock-managed as soon as one component is - so read the item after the conversion to see the resulting settings. There is no direct reverse operation: removing the last component with "DELETE /v2/items/{itemId}/kit-items/components/{componentItemId}" or "DeleteKitItemComponent" dissolves the kit and turns the item back into a standard item. Because an item that is itself a kit is never an eligible component, kits cannot be nested. Use "POST /v2/items/{itemId}/kit-items/components" or "AddKitItemComponent" to add a further component to a kit that already exists.
## OpenAPI
````yaml /openapi/erp/2.2.json post /v2/items/{itemId}/kit-items/convert
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.3.0-alpha.261112224724+Sha.88e44c9\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.2'
x-application-version: 2.3.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: >-
Queries
all cancellation reasons for sales orders.
- name: Sales Invoice Correction
description: >-
Queries all cancellation reasons for sales
invoice corrections.
- name: Return
description: >-
Create a new
return with associated items and packages.
- name: Item
description: >-
Queries all
responsible persons.
- name: Refund
description: >-
Queries all
cancellation reasons for refunds.
- 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: >-
Gets a
specific invoice.
- 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: >-
Returns
the installed extensions.
- name: Shipment
description: Development
- name: Delivery Note
description: >-
Queries
all delivery notes.
- 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: Sales Orders
- name: Marketplace Order
- name: Marketplace Offer
- name: Marketplace Invoicing
- name: Company
- name: Sales Channel
- name: Payment
- name: Warehouse Assistant
- name: Worker
paths:
/v2/items/{itemId}/kit-items/convert:
post:
tags:
- Item
summary: Convert Item To Kit Item
description: >-
Converts an existing standard item into a kit, so that selling one unit
of it consumes a fixed set of component items from then on. The full
component list is mandatory, because a standard item has no component
list to fall back on - supplying at least one component is what makes
the item a kit. The item keeps its ID, but the conversion resets several
settings and converting back does not restore them: the suppliers are
removed, because a kit has no suppliers; stock management is switched
off first, which clears the per-warehouse minimum and maximum stock
levels written through "PATCH /v2/items/{itemId}/warehouse-constraints"
and switches "allowNegativeStock" off; and divisible stock is switched
off. An item that tracks best-before dates, batches or serial numbers is
not converted at all (409). The kit's stock management is then derived
from its components - it is stock-managed as soon as one component is -
so read the item after the conversion to see the resulting settings.
There is no direct reverse operation: removing the last component with
"DELETE /v2/items/{itemId}/kit-items/components/{componentItemId}" or
"DeleteKitItemComponent" dissolves the kit and turns the item back into
a standard item. Because an item that is itself a kit is never an
eligible component, kits cannot be nested. Use "POST
/v2/items/{itemId}/kit-items/components" or "AddKitItemComponent" to add
a further component to a kit that already exists.
operationId: Itemdetails_ConvertItemToKitItem
parameters:
- name: itemId
in: path
required: true
description: Unique ID of the item that is converted into a kit.
schema:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
- name: Idempotency-Key
in: header
description: >-
Optional, client-generated key for deduplicating repeated write
requests. A repeated request with the same key returns the
originally recorded result instead of executing the effect again.
schema:
type: string
maxLength: 255
minLength: 1
- 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: ConvertItemToKitItemRequest
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Item.PublicApi.Endpoints.V2.Itemdetails.ConvertItemToKitItemRequest
required: true
x-position: 1
responses:
'200':
description: The item was successfully converted into a kit.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.ConvertItemToKitItemCommandResponse
'400':
description: >-
The request is invalid. Validation errors name the property path
they belong to, spelled exactly as shown here and with n as the
zero-based index of the list entry - "Components" when the list is
missing or empty, "Components[n].Quantity" when it is outside the
accepted range of at least 0.0000000000001 and less than
1000000000000, "Components[n].Comment" when it exceeds 255
characters, or "Components[n].ComponentItemId" when the same item
appears more than once (error code ValidationError). Domain refusals
of a single component return their error code at the top level and
name the offending component item ID in the message:
KitItemComponentQuantityInvalid when the quantity is fractional for
a component item that is not divisible, KitItemComponentNotFound
when no item with that ID exists, KitItemComponentIsKitItself when
it refers to the item being converted - the only circular reference
possible, since an item that is itself a kit is never an eligible
component - and KitItemComponentNotEligible when the item may not
become a kit component because it is inactive, itself a kit, a
configuration item, a variation-combination parent, or a
partial-quantity item. When several components are refused, only the
first one in request order is reported. A request body carrying an
unknown member is rejected with 400 as well; that error is reported
without a property name. Nothing is stored.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'403':
description: Forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'404':
description: No item with the specified ID was found (error code ItemNotFound).
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'409':
description: >-
The item exists but the conversion does not fit its current state.
Either the item is already a kit (error code ItemIsAlreadyAKit) -
change its components with "POST
/v2/items/{itemId}/kit-items/components" or "AddKitItemComponent"
and the other kit component endpoints instead - or the item may not
become a kit (error code ItemCannotBecomeAKit): it is used in a
fulfillment network, it is a component of another kit, it is a
variation-combination parent, it has stock on hand in a warehouse or
counts the stock of a supplier as its own, it is a partial-quantity
item, a voucher or packaging, it is on an active pick list, it
tracks best-before dates, batches or serial numbers, it is a
divisible item that cannot give up its divisibility, for example
because of a fractional quantity on a purchase list, its stock
management may not be switched off for another reason, or an
installed plug-in refuses the transition. The components decide
whether the kit is stock-managed - it is as soon as one component is
- and the item can refuse that transition (error code
StockManagementCannotBeEnabled, or StockManagementCannotBeDisabled
for the reverse). The response names the condition that blocked it.
Nothing is stored, with one exception: when an installed plug-in
refuses the transition only while the kit is being saved, no
component is stored, but the settings the conversion resets on the
item itself - stock management, "allowNegativeStock" and divisible
stock - can already be switched off.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails'
security:
- oauth2-authorization-code:
- items.write
- oauth2-client-credentials:
- items.write
components:
schemas:
JTL.Data.Contracts.Keys.ArtikelKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Item.PublicApi.Endpoints.V2.Itemdetails.ConvertItemToKitItemRequest:
type: object
description: >-
Request model for ConvertItemToKitItem command endpoint.
Route parameters bind from the route, query parameters from the query
string, everything else from the body.
additionalProperties: false
required:
- components
properties:
components:
type: array
description: >-
The component items the kit consists of after the conversion. At
least one component is required - it is what makes the item a kit.
Components are stored in the order they are sent unless a component
carries an explicit "position". The same component item may appear
only once.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.KitItemConversionComponent
JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.ConvertItemToKitItemCommandResponse:
type: object
description: >-
Converts an existing standard item into a kit, so that selling one unit
of it consumes a fixed set of component items from then on. The full
component list is mandatory, because a standard item has no component
list to fall back on - supplying at least one component is what makes
the item a kit. The item keeps its ID, but the conversion resets several
settings and converting back does not restore them: the suppliers are
removed, because a kit has no suppliers; stock management is switched
off first, which clears the per-warehouse minimum and maximum stock
levels written through "PATCH /v2/items/{itemId}/warehouse-constraints"
and switches "allowNegativeStock" off; and divisible stock is switched
off. An item that tracks best-before dates, batches or serial numbers is
not converted at all (409). The kit's stock management is then derived
from its components - it is stock-managed as soon as one component is -
so read the item after the conversion to see the resulting settings.
There is no direct reverse operation: removing the last component with
"DELETE /v2/items/{itemId}/kit-items/components/{componentItemId}" or
"DeleteKitItemComponent" dissolves the kit and turns the item back into
a standard item. Because an item that is itself a kit is never an
eligible component, kits cannot be nested. Use "POST
/v2/items/{itemId}/kit-items/components" or "AddKitItemComponent" to add
a further component to a kit that already exists. - Response
additionalProperties: false
required:
- itemId
- components
properties:
itemId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
description: >-
Unique ID of the converted item. Unchanged - a kit keeps the ID it
had as a standard item.
components:
type: array
description: >-
The components as they were stored, in their effective order. Worth
reading for the effective position of each component, which differs
from the requested one when a requested position was out of bounds
and got clamped.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.ConvertedKitItemComponent
FastEndpoints.ProblemDetails:
type: object
additionalProperties: false
properties:
type:
type: string
default: https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1
title:
type: string
default: One or more validation errors occurred.
status:
type: integer
format: int32
default: 400
instance:
type: string
default: /api/route
traceId:
type: string
default: 0HMPNHL0JHL76:00000001
detail:
type: string
errors:
type: array
items:
$ref: '#/components/schemas/FastEndpoints.ProblemDetails_Error'
JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.KitItemConversionComponent:
type: object
description: A component item the kit consists of after the conversion.
additionalProperties: false
required:
- componentItemId
- quantity
properties:
componentItemId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
description: >-
Unique ID of the item to add as a component. The item must be
eligible to become a kit component - an inactive item, an item that
is itself a kit, a configuration item, a variation-combination
parent and a partial-quantity item are all rejected - and it must
not be the item being converted. The same item may appear only once
in the list.
quantity:
type: number
description: >-
How many units of the component item one unit of the kit consumes.
Must be at least 0.0000000000001 and less than 1000000000000. A
component item that is not divisible additionally rejects a
fractional quantity.
format: decimal
comment:
type: string
description: >-
Free-text comment on the component. At most 255 characters. Omitting
the field and sending an explicit null are equivalent - both store
and return an empty string, never null.
position:
type: integer
description: >-
Zero-based position of the component within the kit's component
list. Positions are applied one component at a time in request
order, each as a move within the list, after every component has
been added; a later move can shift a component placed earlier. When
omitted, the component keeps the position it has in this request.
The positions in the response are authoritative. A value outside the
list bounds is clamped to the nearest end rather than rejected. Read
"position" in the response to learn where it ended up.
format: int32
JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.ConvertedKitItemComponent:
type: object
description: A component of the converted kit, as it was stored.
additionalProperties: false
required:
- componentItemId
- quantity
- comment
- position
properties:
componentItemId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
description: >-
ID of the item that was added as a component. A kit component has no
own single-value identifier - its identity is the pair of kit and
component item - so this doubles as the identifier of the component.
quantity:
type: number
description: How many units of the component item one unit of the kit consumes.
format: decimal
comment:
type: string
description: >-
The comment stored on the component. Always a string, never null -
an omitted or explicitly null comment in the request is stored and
returned as an empty string.
position:
type: integer
description: >-
The effective zero-based position of the component. This is the
index the component actually ended up at, which differs from the
requested one when the request was out of bounds and got clamped.
format: int32
FastEndpoints.ProblemDetails_Error:
type: object
additionalProperties: false
properties:
name:
type: string
default: Error or field name
reason:
type: string
default: Error reason
code:
type: string
severity:
type: string
securitySchemes:
oauth2-authorization-code:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://id.jtl-cloud.com/oauth/v2/authorize
tokenUrl: https://id.jtl-cloud.com/oauth/v2/token
scopes:
inventories.write: Grants permission to modify stock levels.
inventory.print: Grants permission to print inventory count lists.
inventory.read: Grants permission to read stock levels.
inventory.write: Grants permission to modify stock levels.
picklists.print: Grants permission to print pick lists.
picklists.write: Grants permission to create and modify pick lists.
warehouse.read: Grants permission to read warehouse data.
warehouses.print: Grants permission to print storage location labels.
warehouses.write: Grants permission to write warehouse data.
items.print: Grants permission to print item labels.
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
procurements.read: Read procurement
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.
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.
wawiapp.all: Grants access to Wawi app related operations.
returns.mail: Grants permission to send returns by e-mail.
returns.print: Grants permission to print returns.
deliverynotes.mail: Grants permission to send delivery notes by e-mail.
customers.print: Grants permission to print customer details.
currencies.read: Grants read access to currencies.
dunning.mail: Grants permission to send dunning notices by e-mail.
dunning.print: Grants permission to print dunning notices.
dunning.read: >-
Grants read access to dunning: dunning levels, dunning notices,
dunning proposals, dunning runs and the dunning status of invoices
and customers.
dunning.write: >-
Grants write access to dunning: maintain dunning levels, issue and
withdraw dunning notices, start dunning runs and set dunning
blocks.
jera.read: Grants read access to JERA internal endpoints.
masterdata.write: Write master data
paymentmethods.read: Grants read access to payment methods.
payments.mail: Grants permission to send payment receipts by e-mail.
payments.read: Grants permission to read payments.
payments.write: Grants permission to write payments.
salescreditnotes.mail: Grants permission to send sales credit notes by e-mail.
salescreditnotes.print: Grants permission to print sales credit notes.
salescreditnotes.write: Grants permission to cancel credit notes.
salesinvoicecorrections.mail: Grants permission to send sales invoice corrections by e-mail.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.mail: Grants permission to send sales invoices by e-mail.
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.
salesorders.mail: Grants permission to send sales orders by e-mail.
salesquotations.mail: Grants permission to send sales quotations by e-mail.
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.
salessubscriptions.read: Grants read access to subscriptions.
salessubscriptions.write: Grants write access to subscriptions.
system.worker.read: Read worker syncs
system.worker.write: Write worker syncs
worker.errors.read: Read the error log of the worker syncs
worker.read: Read the worker service and its syncs
worker.reset: Reset all worker syncs (destructive)
worker.write: Control and configure worker syncs
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).
scxoffers.read: >-
Grants permission to read SCX offer data, such as channel
attributes.
scxoffers.write: >-
Grants permission to write SCX offer data, such as refreshing
attribute definitions.
masterdata.company.irreversible.write: Perform irreversible company actions
masterdata.email.write: Write email configuration
taxes.write: Grants permission to create and modify tax data.
output.read: Grants permission to read output templates and document types.
output.write: Grants permission to manage output template sets.
users.read: Grants permission to read users, user groups and permissions.
users.write: >-
Grants permission to create and modify users, user groups and
their permissions.
incominginvoices.read: >-
Grants permission to read incoming invoices, including their line
items, additional costs and payments, and the additional cost
types.
incominginvoices.write: >-
Grants permission to create and modify incoming invoices,
including their line items, additional costs and payments, and to
maintain the additional cost types.
health.read: Read health
health.sessions.read: Read sessions and logged-in users
application.runas: >-
Allows the application to execute requests on behalf of another
user.
oauth2-client-credentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://id.jtl-cloud.com/oauth/v2/token
scopes:
inventories.write: Grants permission to modify stock levels.
inventory.print: Grants permission to print inventory count lists.
inventory.read: Grants permission to read stock levels.
inventory.write: Grants permission to modify stock levels.
picklists.print: Grants permission to print pick lists.
picklists.write: Grants permission to create and modify pick lists.
warehouse.read: Grants permission to read warehouse data.
warehouses.print: Grants permission to print storage location labels.
warehouses.write: Grants permission to write warehouse data.
items.print: Grants permission to print item labels.
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
procurements.read: Read procurement
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.
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.
wawiapp.all: Grants access to Wawi app related operations.
returns.mail: Grants permission to send returns by e-mail.
returns.print: Grants permission to print returns.
deliverynotes.mail: Grants permission to send delivery notes by e-mail.
customers.print: Grants permission to print customer details.
currencies.read: Grants read access to currencies.
dunning.mail: Grants permission to send dunning notices by e-mail.
dunning.print: Grants permission to print dunning notices.
dunning.read: >-
Grants read access to dunning: dunning levels, dunning notices,
dunning proposals, dunning runs and the dunning status of invoices
and customers.
dunning.write: >-
Grants write access to dunning: maintain dunning levels, issue and
withdraw dunning notices, start dunning runs and set dunning
blocks.
jera.read: Grants read access to JERA internal endpoints.
masterdata.write: Write master data
paymentmethods.read: Grants read access to payment methods.
payments.mail: Grants permission to send payment receipts by e-mail.
payments.read: Grants permission to read payments.
payments.write: Grants permission to write payments.
salescreditnotes.mail: Grants permission to send sales credit notes by e-mail.
salescreditnotes.print: Grants permission to print sales credit notes.
salescreditnotes.write: Grants permission to cancel credit notes.
salesinvoicecorrections.mail: Grants permission to send sales invoice corrections by e-mail.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.mail: Grants permission to send sales invoices by e-mail.
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.
salesorders.mail: Grants permission to send sales orders by e-mail.
salesquotations.mail: Grants permission to send sales quotations by e-mail.
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.
salessubscriptions.read: Grants read access to subscriptions.
salessubscriptions.write: Grants write access to subscriptions.
system.worker.read: Read worker syncs
system.worker.write: Write worker syncs
worker.errors.read: Read the error log of the worker syncs
worker.read: Read the worker service and its syncs
worker.reset: Reset all worker syncs (destructive)
worker.write: Control and configure worker syncs
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).
scxoffers.read: >-
Grants permission to read SCX offer data, such as channel
attributes.
scxoffers.write: >-
Grants permission to write SCX offer data, such as refreshing
attribute definitions.
masterdata.company.irreversible.write: Perform irreversible company actions
masterdata.email.write: Write email configuration
taxes.write: Grants permission to create and modify tax data.
output.read: Grants permission to read output templates and document types.
output.write: Grants permission to manage output template sets.
users.read: Grants permission to read users, user groups and permissions.
users.write: >-
Grants permission to create and modify users, user groups and
their permissions.
incominginvoices.read: >-
Grants permission to read incoming invoices, including their line
items, additional costs and payments, and the additional cost
types.
incominginvoices.write: >-
Grants permission to create and modify incoming invoices,
including their line items, additional costs and payments, and to
maintain the additional cost types.
health.read: Read health
health.sessions.read: Read sessions and logged-in users
application.runas: >-
Allows the application to execute requests on behalf of another
user.
````