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

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

<?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:

Name

Description

Type

Occurs

OrderId

The unique identifier of the order

string

1..1

ExportSettings

Container element for exportsettings

Element

1..1

OrderNumber

This the Shoxl Shop unique order number

string

1..1

CustomerId

Not in use

string

1..1

DebtorNumber

Debtor number

string

1..1

CompanyName

Name of the company

string

1..1

CompanyVatNumber

Vat number

string

1..1

CocNumber

Chamber of Commerce number

string

0..1

Reference

This is the customers reference for an order.

string

1..1

PreferredDeliveryDate

Preferred delivery date

Date

0..1

DeliveryMethod

Delivery method

DeliveryMethod

1..1

PaymentMethod

Payment method

PaymentMethod

1..1

Gender

Gender of the invoice contact person

Gender

1..1

FirstName

Of the debtor contact person

string

1..1

MiddleName

of the debtor contact person

string

0..1

LastName

of the debtor contact person

string

1..1

UseSeparateDeliveryAddress

If false, order must be delivered at invoice address

boolean

1..1

InvoiceAddress

Element

1..1

DeliveryAddress

Element

0..1

Comments

string

1..1

PhoneNumber

debtor contact phone number

string

1..1

MobilePhoneNumber

debtor contact mobile phone number

string

1..1

EmailAddress

debtor contact email address

string

1..1

PaymentReference

When using a Payment Service Provider (PSP) a reference is given from the PSP system (not yet implemented)

string

1..1

TotalPriceWithoutTax

The total price of the order excluding VAT

decimal

1..1

TotalPrice

The total price of the order including VAT

decimal

1..1

TotalTax

The total amount of VAT

decimal

1..1

CurrencyCode

Currency code

ISO 4217 3-letter currency code

1..1

CostLines

Container element for CostlineInformation elements

Element

0..1

OrderLines

Container element for OrderLineInformation elements

Element

1..1

ExportSettings element:

Name

Description

Type

Occurs

Exporter

Name of the export format

Text,

default OrderExport

1..1

Version

Version of the export xml. To be used for backward compatibility issues.

Text, default 1.1

1..1

InvoiceAddress element:

Name

Description

Type

Occurs

CompanyName

of the invoiced company

Text

0..1

FirstName

of the invoice contact person

Text

0..1

MiddleName

of the invoice contact person

Text

0..1

LastName

of the invoice contact person

Text

0..1

AddressLine1

of the invoice contact person.

Text

0..1 Element is present if StreetAddressType is Combined

Street

of the invoice contact person

Text

0..1 Element is present if StreetAddressType is Separated

HouseNumber

of the invoice contact person

Text

0..1 Element is present if StreetAddressType is Separated

HouseNumberAddition

of the invoice contact person

Text

0..1 Element is present if StreetAddressType is Separated

AddressLine2

of the invoice contact person

Text

0..1

StreetAddressType

Defines the type of the address

StreetAddressType

1..1

PostalCode

of the invoice contact person

Text

1..1

City

of the invoice contact person

Text

1..1

RegionCode

of the invoice contact person

ISO 3166-2 country subdivision code

0..1

CountryCode

of the invoice contact person

ISO 3166-1 alpha-2 Two-letter Country code

1..1

ExternalId

Address ID of the external (ERP) system

Text

0..1

of the invoice contact person

Text

0..1

PhoneNumber

of the invoice contact person

Text

0..1

DeliveryAddress element:

Name

Description

Type

Occurs

CompanyName

of the delivery company

Text

0..1

FirstName

of the delivery contact person

Text

0..1

MiddleName

of the delivery contact person

Text

0..1

LastName

of the delivery contact person

Text

0..1

AddressLine1

of the delivery contact person.

Text

0..1 Element is present if StreetAddressType is Combined

Street

of the delivery contact person

Text

0..1 Element is present if StreetAddressType is Separated

HouseNumber

of the delivery contact person

Text

0..1 Element is present if StreetAddressType is Separated

HouseNumberAddition

of the delivery contact person

Text

0..1 Element is present if StreetAddressType is Separated

AddressLine2

of the delivery contact person

Text

0..1

StreetAddressType

Defines the type of the address

StreetAddressType

1..1

PostalCode

of the delivery contact person

Text

1..1

City

of the delivery contact person

Text

1..1

RegionCode

of the delivery contact person

ISO 3166-2 country subdivision code

0..1

CountryCode

of the delivery contact person

ISO 3166-1 alpha-2 Two-letter Country code

1..1

ExternalId

Address ID of the external (ERP) system

Text

0..1

of the delivery contact person

Text

0..1

PhoneNumber

of the delivery contact person

Text

0..1

CostLineInformation element:

Name

Description

Type

Occurs

ArticleNumber

ArticleNumber that is associated in the ERP for the costline. The articlenumber is specified in the webshopsettings configuration.

string

0..1

CostLineType

Type of the costline

CostLineType

1..1

Quantity

Number of costline items. Defaults to 1 if the element does not exist.

decimal

0..1

Description

Description of the costline

string

1..1

Price

Cost including VAT

decimal

1..1

PriceWithoutTax

Cost excluding VAT

decimal

1..1

Tax

Cost VAT amount

decimal

1..1

DiscountPercentage

DiscountPercentage associated with the costline. Can be used to define a discount on the order in combination with the selected the payment type.

decimal

0..1

OrderLineInformation element:

Name

Description

Type

Occurs

ArticleNumber

Article number

string

1..1

ArticleDescription

Article description

string

1..1

Quantity

The number of items ordered

decimal

1..1

Price

Price including VAT

decimal

1..1

PriceWithoutTax

Price excluding VAT

decimal

1..1

DiscountPrice

Not in use

Empty element

0..1

DiscountPercentage

Not in use

Empty element

0..1

Unit

The base unit of the ordered quantity, eg pce or meter.

string

1..1

DeliveryDate

Preferred delivery date

Date

0..1

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

Last updated 1 year ago