v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

SalesOrderDomainCommand

Modifies an existing sales order.

patch/v2/salesorder/update

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

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

shippingMethodIdstring uuid

paymentMethodIdstring uuid

Example request

{
  "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "lineItems": [
    {
      "salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ]
}

Response

SalesOrder was successfully modified.