Skip to main content
PATCH
Modifies an existing sales order.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

salesorders.write
oauth2-authorization-code

Grants permission to create and modify sales orders.

salesorders.write
oauth2-client-credentials

Grants permission to create and modify sales orders.

Headers

x-companyid
string

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

Idempotency-Key
string

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.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

salesOrderId
string<uuid>
required
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Body

application/json

Request parameters

Modifies an existing sales order. - Request

disableAutomaticWorkflows
boolean

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

useBillingAddressAsShipmentAddress
boolean

Indicates whether the billing address should be used as the shipment address.

cartonItemId
string<uuid>

The SalesOrder CartonItemId

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

companyId
string<uuid>

Unique ID of the company.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

customerId
string<uuid>

The ID of the customer associated with the sales order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

onHoldReasonId
string<uuid>

The SalesOrder OnHoldReasonId

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

paymentMethodId
string<uuid>

The ID of the payment method for the sales order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

processColourId
string<uuid>

The SalesOrder ProcessColourId

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

processStatusId
string<uuid>

The SalesOrder ProcessStatusId

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

shippingMethodId
string<uuid>

The ID of the shipping method for the sales order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

billingAddress
object

SalesOrderBillingAddress

shipmentAddress
object

SalesOrderShipmentAddress

departureCountry
object

DepartureCountry

externalDetails
object

ExternalDetails

lineItems
object[]

The line items included in the sales order.

paymentDetails
object

PaymentDetails

paymentInfo
object

SalesOrderPaymentInfo

shippingDetails
object

ShippingDetails

taxDetails
object

TaxDetails

text
object

SalesOrderText

customerSalesOrderNumber
string

The SalesOrder CustomerSalesOrderNumber

itemDescriptionType
enum<integer>

The SalesOrder ItemDescriptionType

Available options:
0,
1,
2
languageIso
string

The SalesOrder LanguageISO

readOnlyType
enum<integer>

The SalesOrder ReadOnlyType

Available options:
0,
1,
2
salesOrderDate
string<date-time>

The SalesOrder Date

vatId
string

The SalesOrder VATId

Response

SalesOrder was successfully modified.

Modifies an existing sales order. - Response

salesOrderId
string<uuid>
required

Unique ID of the modified sales order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"