# 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\_v7.xsd

{% file src="https://753303667-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLJDwkqph4LVPFmGfGmm0%2Fuploads%2FTdTlTz2ykLkWDpOu7Ob0%2FOrderXmlExport_v7.xsd?alt=media&token=707a0a8b-8fd3-483a-b2fe-3e98b89265f5" %}

## 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\\

## Structure XML

```markup
<?xml version="1.0" encoding="utf-8"?>
<OrderInformation>
    <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>
    <StreetAddress1></StreetAddress1>
    <StreetAddress2/>
    <PostalCode></PostalCode>
    <City></City>
    <Country></Country>
    <UseSeparateDeliveryAddress></UseSeparateDeliveryAddress>
    <DeliveryCompanyName></DeliveryCompanyName>
    <DeliveryFirstName/>
    <DeliveryMiddleName/>
    <DeliveryLastName/>
    <DeliveryStreetAddress1></DeliveryStreetAddress1>
    <DeliveryStreetAddress2/>
    <DeliveryPostalCode/>
    <DeliveryCity/>
    <DeliveryCountry></DeliveryCountry>
    <DeliveryEmailAddress></DeliveryEmailAddress>
    <DeliveryPhoneNumber></DeliveryPhoneNumber>
    <Comments/>
    <PhoneNumber></PhoneNumber>
    <MobilePhoneNumber/>
    <EmailAddress></EmailAddress>
    <InvoiceEmailAddress/>
    <PaymentReference/>
    <TotalPriceWithoutTax></TotalPriceWithoutTax>
    <TotalPrice></TotalPrice>
    <TotalTax></TotalTax>
    <CostLines>
        <CostLineInformation>
            <ArticleNumber/>
            <CostLineType></CostLineType>
            <Description/>
            <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>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 invoice contact person</td><td>string</td><td>1..1</td></tr><tr><td>MiddleName</td><td>of the invoice contact person</td><td>string</td><td>0..1</td></tr><tr><td>LastName</td><td>of the invoice contact person</td><td>string</td><td>1..1</td></tr><tr><td>StreetAddress1</td><td>Invoice address</td><td>string</td><td>1..1</td></tr><tr><td>StreetAddress2</td><td>Invoice address</td><td>string</td><td>1..1</td></tr><tr><td>PostalCode</td><td>Invoice address</td><td>string</td><td>1..1</td></tr><tr><td>City</td><td>Invoice address</td><td>string</td><td>1..1</td></tr><tr><td>Country</td><td>Invoice address</td><td>string</td><td>1..1</td></tr><tr><td>ExternalAddressId</td><td>ERP sytem's invoice address Id </td><td>string</td><td>0..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>DeliveryCompanyName</td><td>Delivery address</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryFirstName</td><td>Delivery address contact person</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryMiddleName</td><td>Delivery address contact person</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryLastName</td><td>Delivery address contact person</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryStreetAddress1</td><td>Delivery address</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryStreetAddress2</td><td>Delivery address</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryPostalCode</td><td>Delivery address</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryCity</td><td>Delivery address</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryCountry</td><td>Delivery address</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryExternalAddressId</td><td>ERP sytem's delivery address Id </td><td>string</td><td>0..1</td></tr><tr><td>DeliveryEmailAddress</td><td>Order delivery contact email address</td><td>string</td><td>0..1</td></tr><tr><td>DeliveryPhoneNumber</td><td>Order delivery contact phone number</td><td>string</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>Order contact phone number</td><td>string</td><td>1..1</td></tr><tr><td>MobilePhoneNumber</td><td>Order contact mobile phone number</td><td>string</td><td>1..1</td></tr><tr><td>EmailAddress</td><td>Order contact email address</td><td>string</td><td>1..1</td></tr><tr><td>InvoiceEmailAddress</td><td>Invoice 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>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>

**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>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 |
| Date           | Must be a string of eight positions formatted as: yyyyMMdd                                                                                                                                                                                                                         |
