# Order Export

## Short description

If the Realtime PlaceOrder interface is not an option, the Order XML export can be used to place an XML document with the submitted order contents in an FTPS folder.

For validation purposes of the Exported XML an XSD document is available. The current version of the XSD document is: OrderXmlExport\_v9.xsd

{% file src="<https://content.gitbook.com/content/LTud4MGAPIqTSZsTsTJL/blobs/OP9tG2j0cMT4A7JrauES/OrderXmlExport_v9.xsd>" %}

## Delivery method

**Update Frequency**: When the order is submitted

**Incremental or complete set:** Incremental

**Filetype:** XML

**Filename: order**\_**\[ordernumber]**.xml\
**Transport:** over FTPS, FTPS Vendisto server hosted by INTEGRACE, file will be placed on FTPS server by the shop.

**Location within FTP root:** \ShoxlPro\Orders\\

### Changes from Order XML 1.0 to 1.1

* An ExportSettings element is added containing an Exporter and Version element
* InvoiceAddress and DeliveryAddress elements are introduced in order to group the corresponding fields
* StreetAddress1 and StreetAddress2, as well as DeliveryStreetAddress1 and DeliveryStreetAddress2 are replaced by AddressLine1, Street, HouseNumber, HouseNumberAddition, AddressLine2 and StreetAddressType of the correspoding address group. StreetAddressType determines which fields must be used when reading the address.
* ExternalAddressId and DeliveryExternalAddressId are moved to the corresponding InvoiceAddress or DeliveryAddress elements.
* PostalCode, City, Country and DeliveryPostalCode, DeliveryCity and DeliveryCountry are moved to the corresponding InvoiceAddress or DeliveryAddress elements. Country and DeliveryCountry are replaced by a CountryCode element.
* The InvoiceAddress and DeliveryAddress elements contain a new introduced RegionCode field. This field can contain the code of a province or a state.
* DeliveryCompanyName, DeliveryFirstName, DeliveryMiddleName, DeliveryLastName, DeliveryEmailAddress and DeliveryPhoneNumber are moved to the corresponding fields under the DeliveryAddress element
* CompanyName, FirstName, MiddleName and LastName and PhoneNumber are now available on both order level and on InvoiceAddress level.
* InvoiceEmailAddress is moved to the InvoiceAddress/Email element.
* CurrencyCode was introduced.

## Structure XML

```markup
<?xml version="1.0" encoding="utf-8"?>
<OrderInformation>
    <ExportSettings>
        <Exporter>OrderExport</Exporter>
        <Version>1.1</Version>
    </ExportSettings>
    <OrderId> </OrderId>
    <OrderNumber></OrderNumber>
    <CustomerId/>
    <DebtorNumber></DebtorNumber>
    <CompanyName></CompanyName>
    <CompanyVatNumber></CompanyVatNumber>
    <CocNumber></CocNumber >
    <Reference/>
    <PreferredDeliveryDate></PreferredDeliveryDate>
    <DeliveryMethod></DeliveryMethod>
    <PaymentMethod></PaymentMethod>
    <Gender></Gender>
    <FirstName></FirstName>
    <MiddleName/>
    <LastName></LastName>
    <UseSeparateDeliveryAddress></UseSeparateDeliveryAddress>
    <InvoiceAddress>
        <CompanyName></CompanyName>
        <FirstName></FirstName>
        <MiddleName/>
        <LastName></LastName>
        <AddressLine1></AddressLine1>
        <Street></Street>
        <HouseNumber></HouseNumber>
        <HouseNumberAddition></HouseNumberAddition>
        <AddressLine2></AddressLine2>
        <StreetAddressType></StreetAddressType>
        <PostalCode></PostalCode>
        <City></City>
        <RegionCode></RegionCode>
        <CountryCode></CountryCode>
        <ExternalId></ExternalId>
        <Email></Email>
        <PhoneNumber></PhoneNumber>
    </InvoiceAddress>
    <DeliveryAddress>
        <CompanyName></CompanyName>
        <FirstName></FirstName>
        <MiddleName/>
        <LastName></LastName>
        <AddressLine1></AddressLine1>
        <Street></Street>
        <HouseNumber></HouseNumber>
        <HouseNumberAddition></HouseNumberAddition>
        <AddressLine2></AddressLine2>
        <StreetAddressType></StreetAddressType>
        <PostalCode></PostalCode>
        <City></City>
        <RegionCode></RegionCode>
        <CountryCode></CountryCode>
        <ExternalId></ExternalId>
        <Email></Email>
        <PhoneNumber></PhoneNumber>
    </DeliveryAddress>
    <Comments/>
    <PhoneNumber></PhoneNumber>
    <MobilePhoneNumber/>
    <EmailAddress></EmailAddress>
    <PaymentReference/>
    <TotalPriceWithoutTax></TotalPriceWithoutTax>
    <TotalPrice></TotalPrice>
    <TotalTax></TotalTax>
    <CurrencyCode></CurrencyCode>
    <CostLines>
        <CostLineInformation>
            <ArticleNumber/>
            <CostLineType></CostLineType>
            <Description/>
            <Quantity></Quantity>
            <Price></Price>
            <PriceWithoutTax></PriceWithoutTax>
            <Tax></Tax>
            <DiscountPercentage/>
        </CostLineInformation>
    </CostLines>
    <OrderLines>
        <OrderLineInformation>
            <ArticleNumber></ArticleNumber>
            <ArticleDescription></ArticleDescription>
            <Quantity></Quantity>
            <Price></Price>
            <PriceWithoutTax></PriceWithoutTax>
            <DiscountPrice/>
            <DiscountPercentage/>
            <Unit></Unit>
            <DeliveryDate></DeliveryDate>
        </OrderLineInformation>
    </OrderLines>
</OrderInformation>

```

## Fields XML

**OrderInformation element:**

<table data-header-hidden><thead><tr><th width="217.27177495505475">Name</th><th width="181">Description</th><th width="165">Type</th><th>Occurs</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Occurs</td></tr><tr><td>OrderId</td><td>The unique identifier of the order</td><td>string</td><td>1..1</td></tr><tr><td>ExportSettings</td><td>Container element for exportsettings</td><td>Element</td><td>1..1</td></tr><tr><td>OrderNumber</td><td>This the Shoxl Shop unique order number</td><td>string</td><td>1..1</td></tr><tr><td>CustomerId</td><td>Not in use</td><td>string</td><td>1..1</td></tr><tr><td>DebtorNumber</td><td>Debtor number</td><td>string</td><td>1..1</td></tr><tr><td>CompanyName</td><td>Name of the company</td><td>string</td><td>1..1</td></tr><tr><td>CompanyVatNumber</td><td>Vat number</td><td>string</td><td>1..1</td></tr><tr><td>CocNumber</td><td>Chamber of Commerce number</td><td>string</td><td>0..1</td></tr><tr><td>Reference</td><td>This is the customers reference for an order.</td><td>string</td><td>1..1</td></tr><tr><td>PreferredDeliveryDate</td><td>Preferred delivery date</td><td>Date</td><td>0..1</td></tr><tr><td>DeliveryMethod</td><td>Delivery method</td><td>DeliveryMethod</td><td>1..1</td></tr><tr><td>PaymentMethod</td><td>Payment method</td><td>PaymentMethod</td><td>1..1</td></tr><tr><td>Gender</td><td>Gender of the invoice contact person</td><td>Gender</td><td>1..1</td></tr><tr><td>FirstName</td><td>Of the debtor contact person</td><td>string</td><td>1..1</td></tr><tr><td>MiddleName</td><td>of the debtor contact person</td><td>string</td><td>0..1</td></tr><tr><td>LastName</td><td>of the debtor contact person</td><td>string</td><td>1..1</td></tr><tr><td>UseSeparateDeliveryAddress</td><td>If false, order must be delivered at invoice address</td><td>boolean</td><td>1..1</td></tr><tr><td>InvoiceAddress</td><td>InvoiceAddress</td><td>Element</td><td>1..1</td></tr><tr><td>DeliveryAddress</td><td>DeliveryAddress</td><td>Element</td><td>0..1</td></tr><tr><td>Comments</td><td></td><td>string</td><td>1..1</td></tr><tr><td>PhoneNumber</td><td>debtor contact phone number</td><td>string</td><td>1..1</td></tr><tr><td>MobilePhoneNumber</td><td>debtor contact mobile phone number</td><td>string</td><td>1..1</td></tr><tr><td>EmailAddress</td><td>debtor contact email address</td><td>string</td><td>1..1</td></tr><tr><td>PaymentReference</td><td>When using a Payment Service Provider (PSP) a reference is given from the PSP system (not yet implemented)</td><td>string</td><td>1..1</td></tr><tr><td>TotalPriceWithoutTax</td><td>The total price of the order excluding VAT</td><td>decimal</td><td>1..1</td></tr><tr><td>TotalPrice</td><td>The total price of the order including VAT</td><td>decimal</td><td>1..1</td></tr><tr><td>TotalTax</td><td>The total amount of VAT</td><td>decimal</td><td>1..1</td></tr><tr><td>CurrencyCode</td><td>Currency code</td><td>ISO 4217 3-letter currency code</td><td>1..1</td></tr><tr><td>CostLines</td><td>Container element for CostlineInformation elements</td><td>Element</td><td>0..1</td></tr><tr><td>OrderLines</td><td>Container element for OrderLineInformation elements</td><td>Element</td><td>1..1</td></tr></tbody></table>

**ExportSettings element:**

<table data-header-hidden><thead><tr><th width="127.19390581717454">Name</th><th>Description</th><th width="188">Type</th><th>Occurs</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Occurs</td></tr><tr><td>Exporter</td><td>Name of the export format</td><td><p>Text,</p><p>default OrderExport</p></td><td>1..1</td></tr><tr><td>Version</td><td>Version of the export xml. To be used for backward compatibility issues.</td><td>Text,<br>default 1.1</td><td>1..1</td></tr></tbody></table>

**InvoiceAddress element:**

<table data-header-hidden><thead><tr><th width="173.19390581717454">Name</th><th>Description</th><th width="150">Type</th><th>Occurs</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Occurs</td></tr><tr><td>CompanyName</td><td>of the invoiced company</td><td>Text</td><td>0..1</td></tr><tr><td>FirstName</td><td>of the invoice contact person</td><td>Text</td><td>0..1</td></tr><tr><td>MiddleName</td><td>of the invoice contact person</td><td>Text</td><td>0..1</td></tr><tr><td>LastName</td><td>of the invoice contact person</td><td>Text</td><td>0..1</td></tr><tr><td>AddressLine1</td><td>of the invoice contact person.</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Combined</td></tr><tr><td>Street</td><td>of the invoice contact person</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Separated</td></tr><tr><td>HouseNumber</td><td>of the invoice contact person</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Separated</td></tr><tr><td>HouseNumberAddition</td><td>of the invoice contact person</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Separated</td></tr><tr><td>AddressLine2</td><td>of the invoice contact person</td><td>Text</td><td>0..1</td></tr><tr><td>StreetAddressType</td><td>Defines the type of the address</td><td>StreetAddressType</td><td>1..1</td></tr><tr><td>PostalCode</td><td>of the invoice contact person</td><td>Text</td><td>1..1</td></tr><tr><td>City</td><td>of the invoice contact person</td><td>Text</td><td>1..1</td></tr><tr><td>RegionCode</td><td>of the invoice contact person</td><td>ISO 3166-2 country subdivision code</td><td>0..1</td></tr><tr><td>CountryCode</td><td>of the invoice contact person</td><td>ISO 3166-1 alpha-2 Two-letter Country code</td><td>1..1</td></tr><tr><td>ExternalId</td><td>Address ID of the external (ERP) system</td><td>Text</td><td>0..1</td></tr><tr><td>Email</td><td>of the invoice contact person</td><td>Text</td><td>0..1</td></tr><tr><td>PhoneNumber</td><td>of the invoice contact person</td><td>Text</td><td>0..1</td></tr></tbody></table>

**DeliveryAddress element:**

<table data-header-hidden><thead><tr><th width="173.19390581717454">Name</th><th>Description</th><th width="150">Type</th><th>Occurs</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Occurs</td></tr><tr><td>CompanyName</td><td>of the delivery company</td><td>Text</td><td>0..1</td></tr><tr><td>FirstName</td><td>of the delivery contact person</td><td>Text</td><td>0..1</td></tr><tr><td>MiddleName</td><td>of the delivery contact person</td><td>Text</td><td>0..1</td></tr><tr><td>LastName</td><td>of the delivery contact person</td><td>Text</td><td>0..1</td></tr><tr><td>AddressLine1</td><td>of the delivery contact person.</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Combined</td></tr><tr><td>Street</td><td>of the delivery contact person</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Separated</td></tr><tr><td>HouseNumber</td><td>of the delivery contact person</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Separated</td></tr><tr><td>HouseNumberAddition</td><td>of the delivery contact person</td><td>Text</td><td>0..1<br>Element is present if StreetAddressType is Separated</td></tr><tr><td>AddressLine2</td><td>of the delivery contact person</td><td>Text</td><td>0..1</td></tr><tr><td>StreetAddressType</td><td>Defines the type of the address</td><td>StreetAddressType</td><td>1..1</td></tr><tr><td>PostalCode</td><td>of the delivery contact person</td><td>Text</td><td>1..1</td></tr><tr><td>City</td><td>of the delivery contact person</td><td>Text</td><td>1..1</td></tr><tr><td>RegionCode</td><td>of the delivery contact person</td><td>ISO 3166-2 country subdivision code</td><td>0..1</td></tr><tr><td>CountryCode</td><td>of the delivery contact person</td><td>ISO 3166-1 alpha-2 Two-letter Country code</td><td>1..1</td></tr><tr><td>ExternalId</td><td>Address ID of the external (ERP) system</td><td>Text</td><td>0..1</td></tr><tr><td>Email</td><td>of the delivery contact person</td><td>Text</td><td>0..1</td></tr><tr><td>PhoneNumber</td><td>of the delivery contact person</td><td>Text</td><td>0..1</td></tr></tbody></table>

**CostLineInformation element:**

<table data-header-hidden><thead><tr><th>Name</th><th width="183">Description</th><th width="164">Type</th><th>Occurs</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Occurs</td></tr><tr><td>ArticleNumber</td><td>ArticleNumber that is associated in the ERP for the costline. The articlenumber is specified in the webshopsettings configuration.</td><td>string</td><td>0..1</td></tr><tr><td>CostLineType</td><td>Type of the costline</td><td>CostLineType</td><td>1..1</td></tr><tr><td>Quantity</td><td>Number of costline items. Defaults to 1 if the element does not exist.</td><td>decimal</td><td>0..1</td></tr><tr><td>Description</td><td>Description of the costline</td><td>string</td><td>1..1</td></tr><tr><td>Price</td><td>Cost including VAT</td><td>decimal</td><td>1..1</td></tr><tr><td>PriceWithoutTax</td><td>Cost excluding VAT</td><td>decimal</td><td>1..1</td></tr><tr><td>Tax</td><td>Cost VAT amount</td><td>decimal</td><td>1..1</td></tr><tr><td>DiscountPercentage</td><td>DiscountPercentage associated with the costline. Can be used to define a discount on the order in combination with the selected the payment type.</td><td>decimal</td><td>0..1</td></tr></tbody></table>

**OrderLineInformation element:**

<table data-header-hidden><thead><tr><th width="197">Name</th><th width="186.24899598393574">Description</th><th width="164">Type</th><th>Occurs</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Occurs</td></tr><tr><td>ArticleNumber</td><td>Article number</td><td>string</td><td>1..1</td></tr><tr><td>ArticleDescription</td><td>Article description</td><td>string</td><td>1..1</td></tr><tr><td>Quantity</td><td>The number of items ordered</td><td>decimal</td><td>1..1</td></tr><tr><td>Price</td><td>Price including VAT</td><td>decimal</td><td>1..1</td></tr><tr><td>PriceWithoutTax</td><td>Price excluding VAT</td><td>decimal</td><td>1..1</td></tr><tr><td>DiscountPrice</td><td>Not in use</td><td>Empty element</td><td>0..1</td></tr><tr><td>DiscountPercentage</td><td>Not in use</td><td>Empty element</td><td>0..1</td></tr><tr><td>Unit</td><td>The base unit of the ordered quantity, eg pce or meter.</td><td>string</td><td>1..1</td></tr><tr><td>DeliveryDate</td><td>Preferred delivery date</td><td>Date</td><td>0..1</td></tr></tbody></table>

**Types:**

| Type              | Values                                                                                                                                                                                                                                                                             |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| boolean           | false, true                                                                                                                                                                                                                                                                        |
| CostLineType      | Shipping, Payment, Discount, DisposalFee, Other                                                                                                                                                                                                                                    |
| DeliveryMethod    | DEFAULT, PICKUP                                                                                                                                                                                                                                                                    |
| Gender            | Unknown, Male, Female                                                                                                                                                                                                                                                              |
| GUID              | 00000000-0000-0000-0000-000000000000                                                                                                                                                                                                                                               |
| PaymentMethod     | NONE, BUY\_ON\_CREDIT, CASH\_ON\_PICKUP, CASH\_ON\_DELIVERY, BANK\_TRANSFER, DIRECT\_DEBIT, AMEX, MASTERCARD, VISA, IDEAL, MISTER\_CASH, BELFIUS\_DIRECT\_NET, CBC\_ONLINE, ING\_HOMEPAY, KBC\_ONLINE, PAYPAL, EBANKING, MAESTRO, TEST, GIROPAY, UBERWEISUNG, APPLEPAY, BANCONTACT |
| StreetAddressType | Combined, Separated                                                                                                                                                                                                                                                                |
| Date              | Must be a string of eight positions formatted as: yyyyMMdd                                                                                                                                                                                                                         |
