Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Sales Order

Import sales order

Import a sales order from external marketplace

post/api/v1/salesOrders/actions/import

Request body

desiredDeliveryDatestring date nullable
reservationDatestring date nullable
desiredDeliveryDateAsCalendarWeekboolean

Flag indicating whether a calendar week should be printed on documents

editorstring

Creator of the Sales Order

salesRepresentativeIdinteger

The ID of the sales representative

datestring date required
externalOrderNumberstring

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

externalOrderIdstring

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

transactionNumberstring

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.

customerOrderNumberstring

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

autoCreateDocuments'deliveryNote+invoice' | 'deliveryNote' | 'invoice'

Sets documents created by autoshippment.

vatCheckboolean

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

bodyIntroductionstring

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

bodyOutroductionstring

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

internalDesignationstring

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

commentstring

Internal comment. Rich-Text capable.

Example request

{
  "tags": [
    {
      "id": "17"
    }
  ],
  "customer": {
    "id": "1337"
  },
  "project": {
    "id": "1337"
  },
  "salesChannel": {
    "id": "1337"
  },
  "language": {
    "iso2": "DE"
  },
  "financials": {
    "paymentMethod": {
      "id": "3"
    },
    "currency": "EUR"
  },
  "delivery": {
    "shippingCosts": [
      {
        "id": "17",
        "shippingCostProduct": {
          "id": "17",
          "freeFields": [
            {
              "id": "17"
            }
          ]
        },
        "tax": {
          "vatCategory": "reduced",
          "rate": 0.5,
          "taxText": "Tax Text"
        },
        "price": {
          "amount": "13.37",
          "currency": "EUR"
        }
      }
    ],
    "shippingMethod": {
      "id": "1337"
    },
    "deliveryTerms": {
      "id": "1337"
    }
  },
  "positions": [
    {
      "id": "17",
      "product": {
        "id": "17",
        "freeFields": [
          {
            "id": "17"
          }
        ]
      },
      "tax": {
        "vatCategory": "reduced",
        "rate": 0.5,
        "taxText": "Tax Text"
      },
      "price": {
        "amount": "13.37",
        "currency": "EUR"
      }
    }
  ],
  "discountPositions": [
    {
      "discountProduct": {
        "id": "17",
        "freeFields": [
          {
            "id": "17"
          }
        ]
      },
      "tax": {
        "vatCategory": "reduced",
        "rate": 0.5,
        "taxText": "Tax Text"
      },
      "value": {
        "amount": "13.37",
        "currency": "EUR"
      }
    }
  ]
}

Response

Resource successfully created response