---
title: "Import sales order"
method: POST
path: "/api/v1/salesOrders/actions/import"
tags: ["Sales Order"]
---

# Import sales order

`POST /api/v1/salesOrders/actions/import`

Import a sales order from external marketplace

## Request body

- object
  - `desiredDeliveryDate` string, date, nullable
  - `reservationDate` string, date, nullable
  - `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` string, 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` 'deliveryNote+invoice' | 'deliveryNote' | 'invoice' — Sets documents created by autoshippment.
  - `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.
  - `tags` object[]
    - `id` string — Resource identifier.
  - `customer` object, required — Reference to another resource
    - `id` string, required — Resource identifier.
  - `project` object, required — Reference to another resource
    - `id` string, required — Resource identifier.
  - `salesChannel` object — Reference to another resource
    - `id` string, required — Resource identifier.
  - `language` object — Language information for a Sales Order
    - `iso2` string, nullable, required — ISO 639-1 Code
  - `financials` object, required — Financial information for a Sales Order
    - `paymentMethod` object, required — Reference to another resource
      - `id` string, required — Resource identifier.
    - `currency` string, required
    - `costCenter` object, nullable
      - `id` string, required — Resource identifier.
      - `number` string, nullable, required
    - `billingAddress` object
      - `type` 'mr' | 'mrs' | 'company' | 'other'
      - `name` string, required
      - `title` string
      - `contactPerson` string
      - `department` string
      - `subDepartment` string
      - `street` string
      - `zipCode` string
      - `city` string
      - `fax` string
      - `state` string
      - `country` string, required
      - `addressSupplement` string
      - `gln` string
      - `phoneNumber` string
      - `mobile` string
      - `salutation` string
      - `email` string, email
    - `tax` object
      - `taxation` 'domestic' | 'eu' | 'export' | 'taxfreedomestic'
      - `vatId` string
      - `taxDisplay` 'gross' | 'net' | 'auto'
      - `noTaxInfoText` boolean
      - `normalTaxRate` number, float
      - `reducedTaxRate` number, float
    - `paymentTerms` object
      - `paymentTargetDiscount` number, float
      - `paymentTargetDays` integer
      - `paymentTargetDiscountDays` integer
      - `directDebitDate` string, date, nullable — Earliest date for direct debit
  - `delivery` object, required
    - `autoShipping` boolean
    - `fastLane` boolean
    - `shippingCosts` object[]
      - `id` string — Resource identifier.
      - `quantity` number, double, required
      - `comment` string
      - `shippingCostProduct` object, required
        - `id` string, required — Resource identifier.
        - `name` string
        - `description` string
        - `freeFields` object[], nullable
          - `id` string, required — Resource identifier.
          - `value` string, required
        - `number` string, nullable
      - `tax` object
        - `vatCategory` 'reduced' | 'normal' | 'exempt', nullable — VAT category. When importing a position only one of `rate` or `vatCategory` must be used.
        - `rate` number, float, nullable — VAT rate. When importing a position only one of `rate` or `vatCategory` must be used.
        - `taxText` string, nullable, required — Tax Text
      - `price` object — Money object with amount and currency
        - `amount` string, float — A string representing the amount
        - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
      - `discount` number, float — percentage discount to be applied to the position, expressed as a decimal value (<code>0.15</code> = 15% discount)
      - `webId` string — technical position ID in the originating shop system / platform (e.g. Shopify, Amazon, etc). This ID is used to sync info back to the originating shop / platform
    - `storageCountry` string, nullable — Only use preferredWarehouse OR storageCountry. You cannot use both at the same time. Use storageCountry for external fulfillment without delivery notes to set the country of fulfillment. If using delivery notes, do not use storageCountry.
    - `preferredWarehouse` object, nullable — Use preferredWarehouse for fulfillment with delivery notes to define which warehouse should be used.
      - `id` string
    - `shippingAddress` object
      - `type` 'mr' | 'mrs' | 'company' | 'other'
      - `name` string, required
      - `department` string
      - `contactPerson` string
      - `subDepartment` string
      - `street` string
      - `zipCode` string
      - `city` string
      - `state` string
      - `country` string, required
      - `addressSupplement` string
      - `gln` string
      - `title` string
      - `email` string, email
    - `shippingMethod` object, required — Reference to another resource
      - `id` string, required — Resource identifier.
    - `deliveryTerms` object, nullable — Nullable reference to another resource
      - `id` string, required — Resource identifier.
  - `positions` object[], required
    - `id` string — Resource identifier.
    - `quantity` number, double, required
    - `comment` string
    - `product` object, required
      - `id` string, required — Resource identifier.
      - `name` string
      - `description` string
      - `freeFields` object[], nullable
        - `id` string, required — Resource identifier.
        - `value` string, required
      - `number` string, nullable
    - `tax` object
      - `vatCategory` 'reduced' | 'normal' | 'exempt', nullable — VAT category. When editing/creating a position only one of `rate` or `vatCategory` must be used.
      - `rate` number, float, nullable — VAT rate. When editing/creating a position only one of `rate` or `vatCategory` must be used.
      - `taxText` string, nullable — Tax Text
    - `price` object — Money object with amount and currency
      - `amount` string, float — A string representing the amount
      - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
    - `discount` number, float — percentage discount to be applied to the position, expressed as a decimal value (<code>0.15</code> = 15% discount)
    - `webId` string — technical position ID in the originating shop system / platform (e.g. Shopify, Amazon, etc). This ID is used to sync info back to the originating shop / platform
    - `desiredDeliveryDate` string, date, nullable
    - `desiredDeliveryDateAsCalendarWeek` boolean — Flag indicating whether a calendar week should be printed on documents
    - `desiredQualityControlAttributes` object, nullable
      - `batch` string, nullable
      - `bestBeforeDate` string, date, nullable
  - `discountPositions` object[]
    - `quantity` number, double, required
    - `discountProduct` object, required
      - `id` string, required — Resource identifier.
      - `name` string
      - `description` string
      - `freeFields` object[], nullable
        - `id` string, required — Resource identifier.
        - `value` string, required
      - `number` string, nullable
    - `tax` object
      - `vatCategory` 'reduced' | 'normal' | 'exempt', nullable — VAT category. When editing/creating a position only one of `rate` or `vatCategory` must be used.
      - `rate` number, float, nullable — VAT rate. When editing/creating a position only one of `rate` or `vatCategory` must be used.
      - `taxText` string, nullable, required — Tax Text
    - `value` object — Money object with amount and currency
      - `amount` string, float — A string representing the amount
      - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
    - `webId` string — technical position ID in the originating shop system / platform (e.g. Shopify, Amazon, etc). This ID is used to sync info back to the originating shop / platform
  - `setTotalAmount` object, nullable
    - `isActive` boolean — isActive
    - `maximumDifferenceToCalculatedSum` number, float — maximumDifferenceToCalculatedSum
    - `totalGrossAmountFromExternal` number, float — totalGrossAmountFromExternal

## Response `201`

Resource successfully created response

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)