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

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

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

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 invoice contact person

string

1..1

MiddleName

of the invoice contact person

string

0..1

LastName

of the invoice contact person

string

1..1

StreetAddress1

Invoice address

string

1..1

StreetAddress2

Invoice address

string

1..1

PostalCode

Invoice address

string

1..1

City

Invoice address

string

1..1

Country

Invoice address

string

1..1

ExternalAddressId

ERP sytem's invoice address Id

string

0..1

UseSeparateDeliveryAddress

If false, order must be delivered at invoice address

boolean

1..1

DeliveryCompanyName

Delivery address

string

0..1

DeliveryFirstName

Delivery address contact person

string

0..1

DeliveryMiddleName

Delivery address contact person

string

0..1

DeliveryLastName

Delivery address contact person

string

0..1

DeliveryStreetAddress1

Delivery address

string

0..1

DeliveryStreetAddress2

Delivery address

string

0..1

DeliveryPostalCode

Delivery address

string

0..1

DeliveryCity

Delivery address

string

0..1

DeliveryCountry

Delivery address

string

0..1

DeliveryExternalAddressId

ERP sytem's delivery address Id

string

0..1

DeliveryEmailAddress

Order delivery contact email address

string

0..1

DeliveryPhoneNumber

Order delivery contact phone number

string

0..1

Comments

string

1..1

PhoneNumber

Order contact phone number

string

1..1

MobilePhoneNumber

Order contact mobile phone number

string

1..1

EmailAddress

Order contact email address

string

1..1

InvoiceEmailAddress

Invoice 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

CostLines

Container element for CostlineInformation elements

Element

0..1

OrderLines

Container element for OrderLineInformation elements

Element

1..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

Date

Must be a string of eight positions formatted as: yyyyMMdd

Last updated 1 year ago

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

Structure XML

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

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 invoice contact person

string

1..1

MiddleName

of the invoice contact person

string

0..1

LastName

of the invoice contact person

string

1..1

StreetAddress1

Invoice address

string

1..1

StreetAddress2

Invoice address

string

1..1

PostalCode

Invoice address

string

1..1

City

Invoice address

string

1..1

Country

Invoice address

string

1..1

ExternalAddressId

ERP sytem's invoice address Id

string

0..1

UseSeparateDeliveryAddress

If false, order must be delivered at invoice address

boolean

1..1

DeliveryCompanyName

Delivery address

string

0..1

DeliveryFirstName

Delivery address contact person

string

0..1

DeliveryMiddleName

Delivery address contact person

string

0..1

DeliveryLastName

Delivery address contact person

string

0..1

DeliveryStreetAddress1

Delivery address

string

0..1

DeliveryStreetAddress2

Delivery address

string

0..1

DeliveryPostalCode

Delivery address

string

0..1

DeliveryCity

Delivery address

string

0..1

DeliveryCountry

Delivery address

string

0..1

DeliveryExternalAddressId

ERP sytem's delivery address Id

string

0..1

DeliveryEmailAddress

Order delivery contact email address

string

0..1

DeliveryPhoneNumber

Order delivery contact phone number

string

0..1

Comments

string

1..1

PhoneNumber

Order contact phone number

string

1..1

MobilePhoneNumber

Order contact mobile phone number

string

1..1

EmailAddress

Order contact email address

string

1..1

InvoiceEmailAddress

Invoice 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

CostLines

Container element for CostlineInformation elements

Element

0..1

OrderLines

Container element for OrderLineInformation elements

Element

1..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

Date

Must be a string of eight positions formatted as: yyyyMMdd