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:

ExportSettings element:

InvoiceAddress element:

DeliveryAddress element:

CostLineInformation element:

OrderLineInformation element:

Types:

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>