API Reference
GuidesAPI ReferenceRoadmap
API Reference
API Reference

🔒 Create sales order V3

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

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:create.

Create a new sales order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Indicates that the entity has a deviating shipTo address.

address
object
required
project
date

Date of the document. Current date is used when omitted.

string

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

tags
array of objects

List of tags associated with the document. New tags will be automatically created if they do not exist.

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.

customFields
documentAddress
object

The recipients postal address of the document. If not provided, the address of the business partner will be used.

string
length ≤ 255

Internal designation, might be displayed in the letterhead

string

Introduction text for the body of the document

string

Outroduction text for the body of the document

string

VAT ID of the business partner. Defaults to the VAT ID of the address when omitted.

string

Delivery terms for the document. Defaults to the delivery terms of the address when omitted.

string

Internal comment for the document

printSettings
object
editor
object

Editor information

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
object
string
length ≤ 255

Master reference number for the sales order.

lineItems
array of objects

List of line items for the sales order.

lineItems
commissionConsignmentStorageLocation
object | null

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

string
length ≤ 64

Custom document number to assign to the sales order. If this field is omitted, Xentral automatically assigns the document number from the configured number range (Nummernkreis) when the sales order is released. Providing this field sets the supplied number directly without changing the status. Intended for use cases where the document number originates from an external system. The number must be unique across all sales orders.

string
length ≤ 255

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

string
length ≤ 255

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

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.

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.

date

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

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.

date

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

date

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

boolean

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

boolean

Indicates if the sales order is available for auto dispatch.

string
enum

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

Allowed:
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.

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.

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.

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.

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.

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.

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.

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

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.

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

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 1 month ago

Did this page help you?