> ## 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.

# Query Sales Orders

> Query all sales orders



## OpenAPI

````yaml /openapi/2.0.json get /v2/salesOrders
openapi: 3.0.0
info:
  title: JTL-WAWI API (Cloud)
  description: "JTL-Wawi-Version: 2.1.0-beta.5195+Sha.e3d2607\r\n# Introduction\r\n\r\nWelcome to the JTL-WAWI technical API documentation. This guide is here to help developers understand how our REST API works and how it can be integrated into your existing systems. We'll delve into the details of authentication and data manipulation processes, providing clear examples along the way. Whether you're a developer or an IT professional, this documentation aims to give you a practical understanding, laying the groundwork for effectively using the JTL-WAWI API to enhance your processes.\r\n\r\n# Authentication\r\n\r\nYou register your application with the API by sending a POST request with the required information and corresponding keys. You can find the exact request details at https://developer.jtl-software.com/products/erp/swagger/appregistration. This information has to include the following:\r\n\r\n* AppId\r\n* DisplayName\r\n* Description\r\n* Version\r\n* ProviderName\r\n* ProviderWebsite\r\n* MandatoryApiScopes\r\n\r\nThis data is crucial for identifying and registering your application with the API. The API uses it to generate a temporary authentication ID that allows your application to access the necessary resources. After successful validation of this information, you will receive the API key required for future authentication and API requests.\r\n\r\nBefore you can begin the registration process, you must open JTL-Wawi (new interface) and start the registration process under 'Admin->App registration'. Only at this point are you authorised to send the first API call. This step in JTL-Wawi ensures that your application is properly registered and has permission to use the API.\r\n\r\nThe API will send you an authentication ID in the form of a token. Once you have received this token and successfully completed the registration in JTL-Wawi, you will send another request to the API by including this authentication ID in the URL path.\r\n\r\nAfter successful validation of this second request by the API and confirmation of the correct information, you will be provided with the actual API key. It is important to note that this API key will not be displayed again!\r\n\r\nThis API key will be used in the future to authenticate requests to the API. It is of utmost importance that you securely store the API key upon receipt, as it cannot be retrieved from any other location in the system."
  contact:
    name: JTL-Software-GmbH
    url: https://developer.jtl-software.com/
    email: partner@jtl-software.com
  version: '2.0'
  x-application-version: 2.1.0.0
servers:
  - url: https://api.jtl-cloud.com/erp
    description: Production Environment Cloud API Gateway
security: []
tags:
  - name: worker
    description: Planned
  - name: wms
    description: >-
      <p data-section-id='tag/wms' class='stable_summary'></p>Query all pick
      lists for a specific wms warehouse that are not completed.
  - name: WawiApp
    description: Development
  - name: warehouse
    description: >-
      <p data-section-id='tag/warehouse' class='stable_summary'></p>Query all
      warehouses
  - name: unitsOfMeasure
    description: Development
  - name: transactionStatus
    description: >-
      <p data-section-id='tag/transactionStatus'
      class='stable_summary'></p>Query all transaction status for sales order
  - name: tax
    description: >-
      <p data-section-id='tag/tax' class='stable_summary'></p>Returns the
      Taxrate for the given Item
  - name: item
    description: >-
      <p data-section-id='tag/item' class='stable_summary'></p>Query all tax
      classes
  - name: supplier
    description: >-
      <p data-section-id='tag/supplier' class='stable_summary'></p>Query all
      suppliers
  - name: stock
    description: >-
      <p data-section-id='tag/stock' class='stable_summary'></p>Query stocks for
      a specific item, warehouse or storage location
  - name: shippingmethod
    description: >-
      <p data-section-id='tag/shippingmethod' class='stable_summary'></p>Query
      all shipping methods
  - name: shipment
    description: >-
      <p data-section-id='tag/shipment' class='stable_summary'></p>Download a
      PDF Shipping Label from database by ID
  - name: salesorder
    description: >-
      <p data-section-id='tag/salesorder' class='stable_summary'></p>Query all
      sales orders
  - name: cancellationreason
    description: Planned
  - name: salesinvoicecorrection
    description: Development
  - name: saleschannel
    description: >-
      <p data-section-id='tag/saleschannel' class='stable_summary'></p>Get all
      sales channels
  - name: return
    description: >-
      <p data-section-id='tag/return' class='beta_summary'></p>Create a new
      return with associated items and packages.
  - name: returnstate
    description: Planned
  - name: returnreason
    description: Planned
  - name: property
    description: >-
      <p data-section-id='tag/property' class='stable_summary'></p>Query all
      properties for items
  - name: printer
    description: >-
      <p data-section-id='tag/printer' class='beta_summary'></p>Returns all
      Installed Printers
  - name: paymentmethod
    description: >-
      <p data-section-id='tag/paymentmethod' class='stable_summary'></p>Query
      all payment methods
  - name: onholdreason
    description: >-
      <p data-section-id='tag/onholdreason' class='stable_summary'></p>Query all
      on hold reasons for sales orders
  - name: offer
    description: >-
      <p data-section-id='tag/offer' class='beta_summary'></p>Execute the
      printing of a Offer
  - name: Configuration
    description: Planned
  - name: manufacturer
    description: Development
  - name: label
    description: Development
  - name: duplicateItem
    description: Development
  - name: copyItem
    description: Development
  - name: invoice
    description: Planned
  - name: info
    description: >-
      <p data-section-id='tag/info' class='stable_summary'></p>Returns the
      status of the API
  - name: features
    description: >-
      <p data-section-id='tag/features' class='stable_summary'></p>Returns the
      available feature sets with release state and API version
  - name: Extensibility
    description: Planned
  - name: shipping
    description: Development
  - name: deliverynote
    description: Planned
  - name: customfields
    description: Development
  - name: customfield
    description: Development
  - name: customer
    description: >-
      <p data-section-id='tag/customer' class='stable_summary'></p>Query all
      customers
  - name: customerGroup
    description: >-
      <p data-section-id='tag/customerGroup' class='stable_summary'></p>Query
      all customer groups
  - name: customerCategory
    description: >-
      <p data-section-id='tag/customerCategory' class='stable_summary'></p>Query
      all customer categories
  - name: creditnote
    description: >-
      <p data-section-id='tag/creditnote' class='beta_summary'></p>Execute the
      printing of a CreditNote
  - name: company
    description: >-
      <p data-section-id='tag/company' class='stable_summary'></p>Query all
      companies
  - name: colorcodes
    description: >-
      <p data-section-id='tag/colorcodes' class='stable_summary'></p>Query all
      color codes for sales orders
  - name: category
    description: Development
  - name: appRegistration
    description: >-
      <p data-section-id='tag/appRegistration' class='stable_summary'></p>Send a
      registration request for an (external) application
  - name: login
    description: >-
      <p data-section-id='tag/login' class='beta_summary'></p>Sends a request to
      log in the user / dynamically assign the WAWI user. Only use this request
      if your API uses SSL.
  - name: logout
    description: >-
      <p data-section-id='tag/logout' class='beta_summary'></p>Sends a request
      to log out the user
  - name: attribute
    description: Development
  - name: accountingData
    description: Planned
paths:
  /v2/salesOrders:
    get:
      tags:
        - salesorder
      summary: Query Sales Orders
      description: Query all sales orders
      operationId: SalesOrder_QuerySalesOrdersAsync
      parameters:
        - name: x-tenant-id
          in: header
          required: true
          schema:
            type: string
            format: uuid
          description: The tenant ID for the target ERP instance.
        - name: salesOrderNumber
          in: query
          description: Search for a specific sales order number.
          schema:
            type: string
          x-position: 1
        - name: externalOrderNumber
          in: query
          description: Search for a specific external order number.
          schema:
            type: string
          x-position: 2
        - name: billingNumber
          in: query
          description: Search for a specific billing number.
          schema:
            type: string
          x-position: 3
        - name: itemId
          in: query
          schema:
            $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 4
        - name: customerId
          in: query
          description: Gets the unique identifier for the customer.
          schema:
            $ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundeKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 5
        - name: IsExisting
          in: query
          description: >-
            Gets a value indicating whether the customer key represents an
            existing customer.
          schema:
            type: boolean
          x-position: 6
        - name: paymentStatus
          in: query
          description: Search for a specific payment status.
          schema:
            $ref: >-
              #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.PaymentStatus
          x-position: 7
        - name: paymentMethodId
          in: query
          schema:
            $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 8
        - name: deliveryCompleteStatus
          in: query
          description: Search for a specific payment status.
          schema:
            $ref: >-
              #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DeliveryCompleteStatus
          x-position: 9
        - name: createdUserId
          in: query
          schema:
            $ref: '#/components/schemas/JTL.Identity.Abstractions.BenutzerKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 10
        - name: companyId
          in: query
          description: Gets the unique identifier for the firm.
          schema:
            $ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 11
        - name: salesChannelId
          in: query
          description: Search for a specific sales channel Id.
          schema:
            type: string
          x-position: 12
        - name: createdSince
          in: query
          description: Search for sales orders created after this date.
          schema:
            type: string
            format: date-time
          x-position: 13
        - name: createdUntil
          in: query
          description: Search for sales orders created before this date.
          schema:
            type: string
            format: date-time
          x-position: 14
        - name: colorId
          in: query
          description: Gets the unique identifier for the color.
          schema:
            $ref: '#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 15
        - name: ebayUsername
          in: query
          description: Search for sales orders with a specific eBay username.
          schema:
            type: string
          x-position: 16
        - name: shippingMethodId
          in: query
          schema:
            $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 17
        - name: deliveredDate
          in: query
          description: Search for sales orders delivered on this date.
          schema:
            type: string
            format: date-time
          x-position: 18
        - name: isCancelled
          in: query
          description: Determines if the sales order is cancelled.
          schema:
            type: boolean
          x-position: 19
        - name: onHoldReasonId
          in: query
          schema:
            $ref: '#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey'
            example: b45f6432-2462-4c6f-b00f-1d9d01000000
          x-position: 20
        - name: isExternalInvoice
          in: query
          description: Determines if the sales order is an external invoice.
          schema:
            type: boolean
          x-position: 21
        - name: pageNumber
          in: query
          description: Number of the page of items to fetch.
          schema:
            type: integer
            format: int32
          x-position: 22
        - name: pageSize
          in: query
          description: Size of the page that is specified by `pageNumber`.
          schema:
            type: integer
            format: int32
          x-position: 23
        - name: x-runas
          in: header
          description: >-
            The User-Id (int or uuid) on whose behalf the request is executed.
            Requires scope 'Application.RunAs'.
          schema:
            type: string
        - name: x-companyid
          in: header
          description: >-
            The Company-Id (int or uuid) of the company on whose behalf the
            request is executed.
          schema:
            type: string
      responses:
        '200':
          description: Returns all non-pending sales orders.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder
        '401':
          description: ''
          content:
            application/json: {}
        '402':
          description: No licence available or the app has not been authorised by JTL.
          content:
            application/json: {}
      security:
        - oauth2-authorization-code:
            - all.read
            - salesorders.read
        - oauth2-client-credentials:
            - all.read
            - salesorders.read
components:
  schemas:
    JTL.Data.Contracts.Keys.ArtikelKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Data.Contracts.Keys.KundeKey:
      type: string
      description: Represents a unique key for identifying a customer in the JTL system.
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.PaymentStatus:
      type: integer
      description: 0 = UnPayed, 1 = PartialPayed, 2 = Payed
      format: int32
      x-enumNames:
        - UnPayed
        - PartialPayed
        - Payed
      enum:
        - 0
        - 1
        - 2
    JTL.Data.Contracts.Keys.ZahlungsartKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DeliveryCompleteStatus:
      type: integer
      description: >-
        0 = DeliveryNotComplete, 1 = DeliveryComplete, 2 =
        DeliveryCompleteWithoutNote
      format: int32
      x-enumNames:
        - DeliveryNotComplete
        - DeliveryComplete
        - DeliveryCompleteWithoutNote
      enum:
        - 0
        - 1
        - 2
    JTL.Identity.Abstractions.BenutzerKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Data.Contracts.Keys.FirmaKey:
      type: string
      description: Represents a key for identifying a firm within the application.
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Data.Contracts.Keys.FarbeKey:
      type: string
      description: Represents a key for identifying a color entity in the system.
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Data.Contracts.Keys.VersandartKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Data.Contracts.Keys.RueckhaltegrundKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder:
      type: object
      description: Represents a paginated list of items
      additionalProperties: false
      required:
        - TotalItems
        - PageNumber
        - PageSize
        - Items
      properties:
        totalItems:
          type: integer
          description: Gets or sets the total number of items available in the data source.
          format: int32
        pageNumber:
          type: integer
          description: Gets or sets the current page number in the paginated list.
          format: int32
        pageSize:
          type: integer
          description: Gets or sets the number of items per page in the paginated list.
          format: int32
        items:
          type: array
          description: Gets or sets the collection of items contained in the paged list.
          items:
            $ref: >-
              #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder
        totalPages:
          type: integer
          description: >-
            Gets the total number of pages based on the total number of items
            and the page size.
          format: int32
        hasPreviousPage:
          type: boolean
          description: >-
            Gets a value indicating whether there is a previous page available
            in the paginated list.
        hasNextPage:
          type: boolean
          description: Gets a value indicating whether there is a next page available.
        nextPageNumber:
          type: integer
          description: >-
            Gets the number of the next page if there is one; otherwise, returns
            the total number of pages.
          format: int32
        previousPageNumber:
          type: integer
          description: >-
            Gets the number of the previous page. If there is no previous page,
            it returns 1.
          format: int32
    JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder:
      type: object
      description: 'Model Class: SalesOrder '
      additionalProperties: false
      required:
        - Id
        - Number
        - ExternalNumber
        - BillingNumber
        - CompanyId
        - DepartureCountry
        - CustomerId
        - CustomerVatID
        - MerchantVatID
        - BillingAddress
        - Shipmentaddress
        - SalesOrderDate
        - SalesOrderPaymentDetails
        - SalesOrderShippingDetail
        - ColorcodeId
        - IsExternalInvoice
        - Comment
        - CustomerComment
        - IsCancelled
        - LanguageIso
        - CancellationDetails
        - SalesChannelId
        - UserCreatedId
        - UserId
        - TransactionStatusId
      properties:
        id:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey'
          description: Unique ID to identify a sales order file.
        number:
          type: string
          description: The number of the sales order.
        externalNumber:
          type: string
          description: The external number of the sales order.
        billingNumber:
          type: string
          description: The number of the invoice.
        companyId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey'
          description: The company of the sales order.
        departureCountry:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DepartureCountry
          description: >-
            The departure country information of the sales order. If none is
            indicated, it will be determined from the company's information.
        customerId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundeKey'
          description: The customer ID.
        customerVatID:
          type: string
          description: The VAT ID of the customer.
        merchantVatID:
          type: string
          description: The VAT ID of the merchant.
        billingAddress:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
          description: The billing address of the sales order.
        shipmentaddress:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address
          description: The shipping address of the sales order.
        salesOrderDate:
          type: string
          description: The date when the order was created.
          format: date-time
        salesOrderPaymentDetails:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderPaymentDetail
          description: Payment specific information of the sales order.
        salesOrderShippingDetail:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderShippingDetail
          description: Shipping specific information of the sales order.
        colorcodeId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey'
          description: The colour code of the sales order.
        isExternalInvoice:
          type: boolean
          description: >-
            Indicates if the invoice of the order was created in an external
            system, like Amazon VCS.
        comment:
          type: string
          description: A comment on the sales order.
        customerComment:
          type: string
          description: A customer comment on the sales order.
        isCancelled:
          type: boolean
          description: >-
            Indicates if the order has been cancelled. There is a special
            endpoint for cancelling sales orders.
        languageIso:
          type: string
          description: The language of the order.
        cancellationDetails:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderCancellationDetails
          description: The cancellation details in case the sales order has been cancelled.
        salesChannelId:
          type: string
          description: The sales channel of the sales order.
        userCreatedId:
          $ref: '#/components/schemas/JTL.Identity.Abstractions.BenutzerKey'
          description: The user who created the sales order.
        userId:
          $ref: '#/components/schemas/JTL.Identity.Abstractions.BenutzerKey'
          description: The user who is responsible for the sales order.
        transactionStatusId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VorgangsstatusKey'
          description: Unique ID to identify a transaction's status.
    JTL.Data.Contracts.Keys.VerkaufAuftragKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DepartureCountry:
      type: object
      description: 'Model Class: DepartureCountry '
      additionalProperties: false
      required:
        - CountryISO
        - State
        - CurrencyIso
        - CurrencyFactor
      properties:
        countryISO:
          type: string
          description: ISO code of the departure country.
        state:
          type: string
          description: Name of the state in the departure country.
        currencyIso:
          type: string
          description: ISO code of the currency of the departure country.
        currencyFactor:
          type: number
          description: The currency factor of the departure country.
          format: decimal
    JTL.Wawi.Rest.Contracts.Models.V1.Common.Address:
      type: object
      description: 'Model Class: Address '
      additionalProperties: false
      required:
        - Id
        - Company
        - Company2
        - FormOfAddress
        - Title
        - FirstName
        - LastName
        - Street
        - Address2
        - PostalCode
        - City
        - State
        - CountryIso
        - VatID
        - PhoneNumber
        - MobilePhoneNumber
        - EmailAddress
        - Fax
      properties:
        id:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.AdresseKey'
          description: Unique ID to identify an address
        company:
          type: string
          description: Description of the Company.
        company2:
          type: string
          description: Additional company information
        formOfAddress:
          type: string
          description: Customer form of address
        title:
          type: string
          description: Official title
        firstName:
          type: string
          description: Customer first name
        lastName:
          type: string
          description: Customer last name
        street:
          type: string
          description: Street name in the customer's address
        address2:
          type: string
          description: Additional address information
        postalCode:
          type: string
          description: Postal code of the customer's address
        city:
          type: string
          description: Name of city in the customer's address
        state:
          type: string
          description: Name of state in the customer's address
        countryIso:
          type: string
          description: Country ISO code
        vatID:
          type: string
          description: Supplier VAT ID number
        phoneNumber:
          type: string
          description: Landline phone number
        mobilePhoneNumber:
          type: string
          description: Mobile phone number
        emailAddress:
          type: string
          description: Email address
        fax:
          type: string
          description: Fax number
    JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderPaymentDetail:
      type: object
      description: 'Model Class: SalesOrderPaymentDetail '
      additionalProperties: false
      required:
        - PaymentMethodId
        - PaymentStatus
        - TotalGrossAmount
        - CurrencyIso
        - CurrencyFactor
        - DateOfPayment
        - StillToPay
        - PaymentTarget
        - CashDiscount
        - CashDiscountDays
      properties:
        paymentMethodId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey'
          description: The payment method of the sales order.
        paymentStatus:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.PaymentStatus
          description: The payment status of the sales order
        totalGrossAmount:
          type: number
          description: The total gross amount of the sales order.
          format: decimal
        currencyIso:
          type: string
          description: ISO code of the currency of the sales order.
        currencyFactor:
          type: number
          description: The currency factor in the order at the time the order is created.
          format: decimal
        dateOfPayment:
          type: string
          description: Date of payment that paid off the sales order.
          format: date-time
        stillToPay:
          type: number
          description: The amount that is left to pay for this sales order.
          format: decimal
        paymentTarget:
          type: integer
          description: The payment target of the sales order in days.
          format: int32
        cashDiscount:
          type: number
          description: The cash discount of the sales order.
          format: decimal
        cashDiscountDays:
          type: integer
          description: The days that the cash discount is valid.
          format: int32
    JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderShippingDetail:
      type: object
      description: 'Model Class: SalesOrderShippingDetail '
      additionalProperties: false
      required:
        - ShippingMethodId
        - DeliveryCompleteStatus
        - ShippingPriority
        - ShippingDate
        - EstimatedDeliveryDate
        - DeliveredDate
        - OnHoldReasonId
        - ExtraWeight
      properties:
        shippingMethodId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey'
          description: The shipping method of the sales order.
        deliveryCompleteStatus:
          $ref: >-
            #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DeliveryCompleteStatus
          description: The delivery status of the sales order.
        shippingPriority:
          type: integer
          description: The shipping priority of the sales order.
          format: int32
        shippingDate:
          type: string
          description: The notified shipping date of the sales order.
          format: date-time
        estimatedDeliveryDate:
          type: string
          description: The estimated delivery date of the sales order.
          format: date-time
        deliveredDate:
          type: string
          description: The date when the sales order was delivered.
          format: date-time
        onHoldReasonId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey'
          description: The ID of the on hold reason of the sales order.
        extraWeight:
          type: number
          description: The extra weight added to the sales order.
          format: decimal
    JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderCancellationDetails:
      type: object
      description: 'Model Class: SalesOrderCancellationDetails '
      additionalProperties: false
      required:
        - CancellationReasonId
        - CancellationComment
        - Date
      properties:
        cancellationReasonId:
          $ref: '#/components/schemas/JTL.Data.Contracts.Keys.AuftragStornogrundKey'
          description: The id of the reason for cancelling the sales order.
        cancellationComment:
          type: string
          description: A comment that adds further information to the cancellation.
        date:
          type: string
          description: The DateTime of Cancellation.
          format: date-time
    JTL.Data.Contracts.Keys.VorgangsstatusKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Data.Contracts.Keys.AdresseKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
    JTL.Data.Contracts.Keys.AuftragStornogrundKey:
      type: string
      format: uuid
      example: b45f6432-2462-4c6f-b00f-1d9d01000000
      additionalProperties: false
  securitySchemes:
    oauth2-authorization-code:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.jtl-cloud.com/oauth2/auth
          tokenUrl: https://auth.jtl-cloud.com/oauth2/token
          scopes:
            items.read: Artikel lesen
            items.write: Artikel schreiben
            accountings.read: ''
            all.read: Erlaubt der Anwendung, alle Daten zu lesen.
            authentication.updateforeignapp: ''
            cusomters.read: ''
            customers.read: ''
            customers.write: ''
            customfields.read: ''
            customfields.write: ''
            deliveries.read: ''
            deliveries.write: ''
            deliverynotes.print: ''
            deliverynotes.read: ''
            deliverynotes.write: ''
            extensibility.integration: ''
            foreignapps.manage: ''
            inventories.read: ''
            inventories.write: ''
            invoices.print: ''
            invoices.read: ''
            invoices.write: ''
            labels.read: ''
            labels.write: ''
            offers.print: ''
            offers.read: ''
            orders.read: ''
            picklists.read: ''
            picklists.write: ''
            returns.read: ''
            returns.write: ''
            saleschannels.read: ''
            salesinvoicecorrections.print: ''
            salesinvoicecorrections.read: ''
            salesinvoicecorrections.write: ''
            salesorders.print: ''
            salesorders.read: ''
            salesorders.write: ''
            suppliers.read: ''
            system.config.read: ''
            system.config.write: ''
            system.read: ''
            system.worker.read: ''
            system.worker.write: ''
            taxes.read: ''
            warehouse.read: ''
            wawiapp.all: Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.
            currencies.read: Grants read access to currencies.
            jera.read: Grants read access to JERA internal endpoints.
            paymentmethods.read: Grants read access to payment methods.
            salesinvoices.read: Grants read access to sales invoices.
            salesinvoices.write: Grants write access to sales invoices.
            salesquotations.read: Grants read access to sales quotations.
            salesquotations.write: Grants write access to sales quotations.
            resources.read: Ressourcen lesen
            resources.write: Ressourcen schreiben
            pps.read: Produktionsdaten lesen
            pps.write: Produktionsdaten schreiben
            inventory.read: Lagerbestand lesen
            inventory.write: Lagerbestand schreiben
            taxes.write: Steuern schreiben
            application.runas: >-
              Ermöglicht der Anwendung, Anfragen im Namen eines anderen
              Benutzers auszuführen.
    oauth2-client-credentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.jtl-cloud.com/oauth2/token
          scopes:
            items.read: Artikel lesen
            items.write: Artikel schreiben
            accountings.read: ''
            all.read: Erlaubt der Anwendung, alle Daten zu lesen.
            authentication.updateforeignapp: ''
            cusomters.read: ''
            customers.read: ''
            customers.write: ''
            customfields.read: ''
            customfields.write: ''
            deliveries.read: ''
            deliveries.write: ''
            deliverynotes.print: ''
            deliverynotes.read: ''
            deliverynotes.write: ''
            extensibility.integration: ''
            foreignapps.manage: ''
            inventories.read: ''
            inventories.write: ''
            invoices.print: ''
            invoices.read: ''
            invoices.write: ''
            labels.read: ''
            labels.write: ''
            offers.print: ''
            offers.read: ''
            orders.read: ''
            picklists.read: ''
            picklists.write: ''
            returns.read: ''
            returns.write: ''
            saleschannels.read: ''
            salesinvoicecorrections.print: ''
            salesinvoicecorrections.read: ''
            salesinvoicecorrections.write: ''
            salesorders.print: ''
            salesorders.read: ''
            salesorders.write: ''
            suppliers.read: ''
            system.config.read: ''
            system.config.write: ''
            system.read: ''
            system.worker.read: ''
            system.worker.write: ''
            taxes.read: ''
            warehouse.read: ''
            wawiapp.all: Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.
            currencies.read: Grants read access to currencies.
            jera.read: Grants read access to JERA internal endpoints.
            paymentmethods.read: Grants read access to payment methods.
            salesinvoices.read: Grants read access to sales invoices.
            salesinvoices.write: Grants write access to sales invoices.
            salesquotations.read: Grants read access to sales quotations.
            salesquotations.write: Grants write access to sales quotations.
            resources.read: Ressourcen lesen
            resources.write: Ressourcen schreiben
            pps.read: Produktionsdaten lesen
            pps.write: Produktionsdaten schreiben
            inventory.read: Lagerbestand lesen
            inventory.write: Lagerbestand schreiben
            taxes.write: Steuern schreiben
            application.runas: >-
              Ermöglicht der Anwendung, Anfragen im Namen eines anderen
              Benutzers auszuführen.

````