{
  "x-generator": "NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))",
  "openapi": "3.0.0",
  "info": {
    "title": "JTL-WAWI API (Cloud)",
    "description": "JTL-Wawi-Version: 2.3.0-alpha.261116152332+Sha.a379990\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": "3.0",
    "x-application-version": "2.3.0.0"
  },
  "servers": [
    {
      "url": "https://api.jtl-cloud.com/erp",
      "description": "Production Environment Cloud API Gateway"
    }
  ],
  "paths": {},
  "components": {
    "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": {
              "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.read": "Grants permission to read pick lists.",
              "picklists.write": "Grants permission to create and modify pick lists.",
              "warehouses.print": "Grants permission to print storage location labels.",
              "warehouses.read": "Grants permission to read warehouse data.",
              "warehouses.write": "Grants permission to write warehouse data.",
              "categories.read": "Grants permission to read category data.",
              "categories.write": "Grants permission to create and modify category 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.",
              "manufacturers.read": "Grants permission to read manufacturer data.",
              "manufacturers.write": "Grants permission to create, modify and delete manufacturer data.",
              "masterdata.read": "Read master data",
              "masterdata.write": "Write master data",
              "purchaseorders.read": "Read purchase orders",
              "purchaseorders.write": "Write purchase orders",
              "returns.mail": "Grants permission to send returns by e-mail.",
              "returns.print": "Grants permission to print returns.",
              "returns.read": "Grants read access to returns.",
              "returns.write": "Grants permission to create and modify returns.",
              "deliverynotes.mail": "Grants permission to send delivery notes by e-mail.",
              "deliverynotes.print": "Grants permission to print delivery notes.",
              "deliverynotes.read": "Grants read access to delivery notes.",
              "deliverynotes.write": "Grants write access to delivery notes.",
              "customers.print": "Grants permission to print customer details.",
              "customers.read": "Grants permission to read customer data.",
              "customers.write": "Grants permission to create and modify customer data.",
              "currencies.read": "Grants read access to currencies.",
              "currencies.write": "Grants write access to currencies: create, change and delete currencies and set or refresh exchange rates.",
              "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.",
              "invoices.read": "Grants permission to read invoices.",
              "invoices.write": "Grants permission to create and modify invoices.",
              "paymentaccounts.read": "Grants read access to payment accounts and payment providers.",
              "paymentaccounts.write": "Grants permission to change the settings of payment accounts, to hide them, to lock their automatic import and to create external payment accounts.",
              "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.",
              "paymenttransactions.import": "Grants permission to fetch payment transactions from the bank or the payment provider and to deliver the transactions of external payment accounts.",
              "paymenttransactions.read": "Grants read access to payment transactions and to the fetch runs of payment accounts.",
              "paymenttransactions.write": "Grants permission to assign and unassign payment transactions, to ignore them, to change their note and to refund their remainder.",
              "refunds.read": "Grants permission to read refunds.",
              "refunds.send": "Grants permission to send refunds to the payment provider or the bank.",
              "refunds.write": "Grants permission to create, change and delete refunds.",
              "salescreditnotes.mail": "Grants permission to send sales credit notes by e-mail.",
              "salescreditnotes.print": "Grants permission to print sales credit notes.",
              "salescreditnotes.read": "Grants permission to read 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.",
              "salesinvoicecorrections.read": "Grants permission to read invoice corrections.",
              "salesinvoicecorrections.write": "Grants permission to create and modify 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.",
              "salesorders.print": "Grants permission to print sales orders.",
              "salesorders.read": "Grants permission to read sales orders.",
              "salesorders.write": "Grants permission to create and modify sales orders.",
              "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.",
              "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",
              "workflows.executions.read": "Read the workflow queue and log",
              "workflows.read": "Read the object types of workflows",
              "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.",
              "customfields.read": "Read custom fields",
              "customfields.write": "Write custom fields",
              "files.read": "Read files and file destination types",
              "files.write": "Upload files and delete files that are not assigned",
              "itemmasterdata.read": "Read item master data",
              "itemmasterdata.write": "Write item master data",
              "labels.read": "Read labels",
              "labels.write": "Write labels",
              "masterdata.company.irreversible.write": "Perform irreversible company actions",
              "masterdata.email.write": "Write email configuration",
              "numberranges.read": "Read number ranges",
              "numberranges.write": "Write number ranges",
              "postalcodes.read": "Read postal codes",
              "postalcodes.write": "Write postal codes",
              "reasons.read": "Read on-hold and cancellation reasons",
              "reasons.write": "Write on-hold and cancellation reasons",
              "texts.read": "Read texts",
              "texts.write": "Write texts",
              "transactionstatuses.read": "Read transaction statuses",
              "transactionstatuses.write": "Write transaction statuses",
              "units.read": "Read units",
              "units.write": "Write units",
              "taxes.read": "Grants permission to read tax data.",
              "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.",
              "shippingproviders.read": "Grants permission to read shipping providers and shipping accounts.",
              "shippingproviders.write": "Grants permission to delete shipping accounts.",
              "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",
              "apps.read": "Read the calling app's registration and granted API scopes",
              "apps.registrations.read": "Read all app registrations",
              "system.read": "Read the JTL-Wawi version and API versions",
              "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": {
              "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.read": "Grants permission to read pick lists.",
              "picklists.write": "Grants permission to create and modify pick lists.",
              "warehouses.print": "Grants permission to print storage location labels.",
              "warehouses.read": "Grants permission to read warehouse data.",
              "warehouses.write": "Grants permission to write warehouse data.",
              "categories.read": "Grants permission to read category data.",
              "categories.write": "Grants permission to create and modify category 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.",
              "manufacturers.read": "Grants permission to read manufacturer data.",
              "manufacturers.write": "Grants permission to create, modify and delete manufacturer data.",
              "masterdata.read": "Read master data",
              "masterdata.write": "Write master data",
              "purchaseorders.read": "Read purchase orders",
              "purchaseorders.write": "Write purchase orders",
              "returns.mail": "Grants permission to send returns by e-mail.",
              "returns.print": "Grants permission to print returns.",
              "returns.read": "Grants read access to returns.",
              "returns.write": "Grants permission to create and modify returns.",
              "deliverynotes.mail": "Grants permission to send delivery notes by e-mail.",
              "deliverynotes.print": "Grants permission to print delivery notes.",
              "deliverynotes.read": "Grants read access to delivery notes.",
              "deliverynotes.write": "Grants write access to delivery notes.",
              "customers.print": "Grants permission to print customer details.",
              "customers.read": "Grants permission to read customer data.",
              "customers.write": "Grants permission to create and modify customer data.",
              "currencies.read": "Grants read access to currencies.",
              "currencies.write": "Grants write access to currencies: create, change and delete currencies and set or refresh exchange rates.",
              "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.",
              "invoices.read": "Grants permission to read invoices.",
              "invoices.write": "Grants permission to create and modify invoices.",
              "paymentaccounts.read": "Grants read access to payment accounts and payment providers.",
              "paymentaccounts.write": "Grants permission to change the settings of payment accounts, to hide them, to lock their automatic import and to create external payment accounts.",
              "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.",
              "paymenttransactions.import": "Grants permission to fetch payment transactions from the bank or the payment provider and to deliver the transactions of external payment accounts.",
              "paymenttransactions.read": "Grants read access to payment transactions and to the fetch runs of payment accounts.",
              "paymenttransactions.write": "Grants permission to assign and unassign payment transactions, to ignore them, to change their note and to refund their remainder.",
              "refunds.read": "Grants permission to read refunds.",
              "refunds.send": "Grants permission to send refunds to the payment provider or the bank.",
              "refunds.write": "Grants permission to create, change and delete refunds.",
              "salescreditnotes.mail": "Grants permission to send sales credit notes by e-mail.",
              "salescreditnotes.print": "Grants permission to print sales credit notes.",
              "salescreditnotes.read": "Grants permission to read 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.",
              "salesinvoicecorrections.read": "Grants permission to read invoice corrections.",
              "salesinvoicecorrections.write": "Grants permission to create and modify 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.",
              "salesorders.print": "Grants permission to print sales orders.",
              "salesorders.read": "Grants permission to read sales orders.",
              "salesorders.write": "Grants permission to create and modify sales orders.",
              "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.",
              "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",
              "workflows.executions.read": "Read the workflow queue and log",
              "workflows.read": "Read the object types of workflows",
              "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.",
              "customfields.read": "Read custom fields",
              "customfields.write": "Write custom fields",
              "files.read": "Read files and file destination types",
              "files.write": "Upload files and delete files that are not assigned",
              "itemmasterdata.read": "Read item master data",
              "itemmasterdata.write": "Write item master data",
              "labels.read": "Read labels",
              "labels.write": "Write labels",
              "masterdata.company.irreversible.write": "Perform irreversible company actions",
              "masterdata.email.write": "Write email configuration",
              "numberranges.read": "Read number ranges",
              "numberranges.write": "Write number ranges",
              "postalcodes.read": "Read postal codes",
              "postalcodes.write": "Write postal codes",
              "reasons.read": "Read on-hold and cancellation reasons",
              "reasons.write": "Write on-hold and cancellation reasons",
              "texts.read": "Read texts",
              "texts.write": "Write texts",
              "transactionstatuses.read": "Read transaction statuses",
              "transactionstatuses.write": "Write transaction statuses",
              "units.read": "Read units",
              "units.write": "Write units",
              "taxes.read": "Grants permission to read tax data.",
              "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.",
              "shippingproviders.read": "Grants permission to read shipping providers and shipping accounts.",
              "shippingproviders.write": "Grants permission to delete shipping accounts.",
              "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",
              "apps.read": "Read the calling app's registration and granted API scopes",
              "apps.registrations.read": "Read all app registrations",
              "system.read": "Read the JTL-Wawi version and API versions",
              "application.runas": "Allows the application to execute requests on behalf of another user."
            }
          }
        }
      }
    }
  }
}
