🔒 Update sales order V3

patch

https://{xentralId}.xentral.biz/api/v3/salesOrders/{id}

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: salesOrder:update.

Update a sales order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

Indicates that the entity has a deviating shipTo address.

address

object

The business partner the document is issued to. Re-pointing it to a different partner re-derives every partner-dependent value from the new partner: documentAddress, project, language, taxation, tax rates, payment method and terms, VAT ID, delivery terms, shipping method, preferred warehouse, sales representative, editor, and the line item discounts. Line item prices and the document currency are deliberately kept unchanged, so negotiated prices survive the change. Fields sent in the same request take precedence over the derived values; a project sent alongside also replaces the one the new partner would bring, and the project-dependent values derive from it. Passing the id the document already has has no effect. Write-protected documents are rejected.

documentDate

date

Date of the document

documentAddress

object

The recipients postal address of the document

project

The project associated with the document. Set to null to remove project association.

internalDesignation

string

length ≤ 255

Internal designation, might be displayed in the letterhead

bodyIntroduction

string

Introduction text for the body of the document

bodyOutroduction

string

Outroduction text for the body of the document

vatId

string

length ≤ 255

VAT ID of the business partner

deliveryTerms

string

Delivery terms for the document

internalComment

string

Internal comment for the document

language

string

Language of the document in an ISO-639-1 format.

printSettings

object

Print settings for the document

editor

object

Editor information

tags

customFields

array of objects

Custom field values for the document. Only custom fields configured for this document in your Xentral instance are accepted here; the customField1 to customField40 keys exist on line items only. Listed keys are written, keys that are not listed are left untouched. Pass value: null to clear a single field.

customFields

costCenter

string

length ≤ 255

Cost center for the document

financials

object

preferredWarehouse

object

The preferred warehouse.

sales

object

Sales information

shippingMethod

object

Reference to the shipping method used for this document. Defaults to the address, project or company shipping method when omitted.

deviatingShipToAddress

masterReferenceNumber

string

length ≤ 255

Master reference number for the sales order.

commissionConsignmentStorageLocation

object | null

Commission/consignment storage location for the sales order. This is used by the commission/consignment module.

customerOrderNumber

string

length ≤ 255

Purchase order number provided by the customer, typically used in a B2B context.

externalOrderNumber

string

length ≤ 255

External order number of the sales order, e.g. from a webshop.

externalOrderId

string

length ≤ 255

External order ID of the sales order, e.g. from a webshop or external system. This is not the same as the external order number. The external order ID is often used for integration purposes, and is typically a technical identifier from an upstream system.

transactionNumber

string

length ≤ 255

Transaction number of the sales order, e.g. for payment processing.

salesChannel

object | null

Sales channel of the sales order. This is typically used to indicate the webshop or sales platform from which the order originated.

desiredDeliveryDate

date

Desired delivery date of the sales order. This is the date when the customer expects the order to be delivered.

desiredDeliveryDateAsCalendarWeek

boolean

Indicates if the desired delivery date is expressed as a calendar week. If true, the desiredDeliveryDate should be interpreted as the start of the calendar week.

earliestFulfillmentDate

date

Earliest fulfillment date of the sales order ("Liefertermin"). The order is not expected to be fulfilled before this date.

reservationDate

date

Reservation date of the sales order. Stock is reserved for this order as of this date.

isSalesOrderToSupplier

boolean

Marks the document address as a supplier rather than a customer. The address must have a supplier number.

autoDispatch

boolean

Indicates if the sales order is available for auto dispatch.

createDocuments

string

enum

Indicates the type of documents that will be created if this sales order is processed using auto dispatch.

Allowed:

manualPaymentApproval

boolean

Use this field to manually approve the payment of the sales order. Depending on the payment method configuration, this might be required before the sales order can be dispatched.

manualShippingCostApproval

boolean

Use this field to manually approve the shipping costs of the sales order. Depending on the shipping method configuration, this might be required before the sales order can be dispatched.

manualDeliveryBlockApproval

boolean

Use this field to manually approve the delivery block of the sales order. If this is true, the sales order can be dispatched despite having a delivery block.

vatChecked

boolean

Indicates if the sales order has been checked for export / VAT compliance. For non-domestic sales orders, if this is false, the sales order cannot be dispatched.

fastLane

boolean

Indicates if the sales order is a fast lane order. Fast lane orders are processed with higher priority during auto dispatch, and stock is allocated preferentially to them.

disableCancellationEmail

boolean

Indicates if the cancellation email should be disabled for this sales order. If true, no cancellation email will be sent when the sales order is cancelled.

disableTrackingEmail

boolean

Indicates if the tracking email should be disabled for this sales order. If true, no tracking email will be sent when the sales order is dispatched.

disablePaymentEmail

boolean

Disables payment notification / reminder emails for this sales order. Mirrors the "Keine Zahlungseingangsmail" checkbox in the legacy sales order UI (stored as the sentinel value 2 in the dunning counter).

directDebitDate

date

Direct debit date of the sales order. If the sales order is paid via direct debit, the direct debit will not be executed before this date.

paymentMethod

object

Reference to the payment method used for this sales order.

trafficLights

array of objects

Custom traffic light states to set on the sales order. Only custom traffic lights can be set; system traffic lights are computed automatically and cannot be written. Look up the available custom traffic light IDs via GET /api/v3/salesOrderTrafficLights (entries with type "custom"). Each provided entry is applied; any custom traffic light not included is left unchanged.

trafficLights

deviatingDebtorAccountNumber

string

length ≤ 32

Deviating debtor account number for accounting purposes.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Update a sales order.

400Failed validation

409Problem occurred

429Too Many Requests