Import sales order

post

https://{xentralId}.xentral.biz/api/v1/salesOrders/actions/import

Import a sales order from external marketplace

Body Params

Sales order import request payload

desiredDeliveryDate

date | null

reservationDate

date | null

desiredDeliveryDateAsCalendarWeek

boolean

Flag indicating whether a calendar week should be printed on documents

editor

string

Creator of the Sales Order

salesRepresentativeId

integer

The ID of the sales representative

date

required

externalOrderNumber

string

Customer-facing sales order number in the originating shop system / platform (e.g. Shopify, Amazon, etc)

externalOrderId

string

technical sales order ID in the originating shop system / platform (e.g. Shopify, Amazon, etc). This ID is used to sync status updates & tracking info back to the originating shop / platform

transactionNumber

string

transaction number typically used to identify payment transactions in the originating shop system / platforms (e.g. Shopify, Amazon, etc). This ID is typically used for financial reconciliation of payment transactions with sales orders / invoices in Xentral.

customerOrderNumber

string

Purchase Order number from the customer’s purchase order system, typically used in B2B context.

autoCreateDocuments

string

enum

Sets documents created by autoshippment.

Allowed:

vatCheck

boolean

Sets whether the provided VAT-ID has been checked already and is considered valid.

bodyIntroduction

string

Text displayed on the PDF print-out above the positions table. Rich-Text capable.

bodyOutroduction

string

Text displayed on the PDF print-out below the positions table. Rich-Text capable.

internalDesignation

string

Internal designation which is also displayed as grey text in the sales order list in the application. Unformatted string only.

comment

string

Internal comment. Rich-Text capable.

201Resource successfully created response

400IETF RFC 9457 Problem API compliant response