Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
SalesOrderDomainCommand

Creates a new sales order.

post/v2/salesorder/create

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Request body

disableAutomaticWorkflowsboolean

Indicates whether automatic workflows should be disabled for this sales order.

useBillingAddressAsShipmentAddressboolean

Indicates whether the billing address should be used as the shipment address. If no shipment address is provided and the flag ist not set, the billing address will also be used as shipment address. If the shipment address is provided, this flag will be ignored.

cartonItemIdstring uuid
companyIdstring uuid

Represents a key for identifying a firm within the application.

customerIdstring uuid

Represents a unique key for identifying a customer in the JTL system.

onHoldReasonIdstring uuid
paymentMethodIdstring uuid
processColourIdstring uuid

Represents a key for identifying a color entity in the system.

processStatusIdstring uuid
customerSalesOrderNumberstring

The SalesOrder CustomerSalesOrderNumber

itemDescriptionType0 | 1 | 2

0 = None, 1 = Brief, 2 = Long

languageIsostring

The SalesOrder LanguageISO

readOnlyType0 | 1 | 2

0 = ChangesAllowed, 1 = InvoicedExternally, 2 = ChangesForbidden

salesOrderDatestring date-time

The SalesOrder Date

salesOrderNumberstring

The SalesOrder SalesOrderNumber

shippingMethodIdstring uuid
vatIdstring

The SalesOrder VATId

Example request

{
  "cartonItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "processColourId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "processStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "lineItems": [
    {
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "parentSalesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "variants": [
        {
          "itemVariantId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
          "itemVariantValueId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
        }
      ]
    }
  ],
  "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

Response

Sales order created successfully