Order history

Short description

The ERP Cache Order interface is used to keep a record of the orders in the ERP system. The Orders in the ERP Cache are used to show order history to the user.

Delivery method

Update Frequency: Batch at least once a day Incremental or complete set: Incremental

Filetype: Zipped XML

Filename: [SHOPNAME]_ErpCache_Order_[INDEXNUMBER].xml Transport: over FTPS, FTPS Vendisto server hosted by INTEGRACE, file will be placed on FTPS server by ERP party.

Location within FTP root: \ErpCache\

Structure XML

<?xml version="1.0" encoding="utf-8"?>
<Import>
    <ImportSettings>
        <Importer>ErpCache_Orders</Importer>
        <Version>1.0</Version>
    </ImportSettings>
    <Orders>
        <Order>
            <OrderNumber></OrderNumber>
            <JobNumber></JobNumber>
            <BillingAddress1></BillingAddress1>
            <BillingCity></BillingCity>
            <BillingCountry></BillingCountry>
            <BillingName1></BillingName1>
            <BillingName2></BillingName2>
            <BillingPostalCode></BillingPostalCode>
            <ExternalOrderNumber></ExternalOrderNumber>
            <OrderedBy></OrderedBy>
            <OrderDate></OrderDate>
            <OrderState></OrderState>
            <PaymentMethodCode></PaymentMethodCode>
            <Reference></Reference>
            <ShipmentMethodCode></ShipmentMethodCode>
            <ShippingAddress1></ShippingAddress1>
            <ShippingCity></ShippingCity>
            <ShippingCountry></ShippingCountry>
            <ShippingName1></ShippingName1>
            <ShippingName2></ShippingName2>
            <ShippingPostalCode></ShippingPostalCode>
            <ShippingTransportInstruction></ShippingTransportInstruction>
            <TotalPriceExclVat></TotalPriceExclVat>
            <TotalPriceInclVat></TotalPriceInclVat>
            <TotalVat></TotalVat>
            <OrderLines>
                <OrderLine>
                    <LineNumber></LineNumber>
                    <Carrier></Carrier>
                    <DiscountAmountExclVat></DiscountAmountExclVat>
                    <DiscountDescription></DiscountDescription>
                    <DiscountPercentage></DiscountPercentage>
                    <IsExternal></IsExternal>
                    <GrossPriceExclVat></GrossPriceExclVat>
                    <NettoPriceExclVat></NettoPriceExclVat>
                    <OrderLineStatus></OrderLineStatus>
                    <OrderLineType></OrderLineType>
                    <ProductDescription></ProductDescription>
                    <ProductNumber></ProductNumber>
                    <Quantity></Quantity>
                    <RemainingQuantity></RemainingQuantity>
                    <SubTotalPriceExclVat></SubTotalPriceExclVat>
                    <TrackAndTraceReference></TrackAndTraceReference>
                    <VatCode></VatCode>
                    <NettoPriceInclVat></NettoPriceInclVat>
                    <SubTotalPriceInclVat></SubTotalPriceInclVat>
                    <BaseUnit></BaseUnit>
                    <PriceUnit></PriceUnit>
                </OrderLine>
            </OrderLines>
        </Order>
    </Orders>
</Import>

Fields XML

Import element:

Name

Description

Type

Required/Optional

ImportSettings

Container element for importsettings

Element

Optional

Orders

Container element for Order data

Element

Required

ImportSettings element:

Name

Description

Type

Required/Optional

Importer

Name of the importer. Should be ErpCache_Orders.

Text,

default ErpCache_Orders

Optional

Version

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

Text, default 1.0

Optional

Order element:

Name

Description

Type

Required/Optional

OrderNumber

The order number of the ERP system

Text

Required

JobNumber

Legacy field

Text

Optional

BillingAddress1

Street and housenumber of the billing address

Text

Optional

BillingCity

The city of the billing address

Text

Optional

BillingCountry

The country of the billing address

Text

Optional

BillingName1

Name of the billing address (department)

Text

Optional

BillingName2

Contains the company name

Text

Optional

BillingPostalCode

The postalcode of the billing address

Text

Optional

ExternalOrderNumber

This the Shoxl Shop unique order number

Text

Optional

OrderedBy

AccountNumber of the customer

Text

Required

OrderDate

The order date

Date

Required

OrderState

State should be derived form orderlinestates: Open means 1 or more lines have state Open or Backorder, Closed means all lines have status Shipped or Cancelled.

OrderState

Optional

OrderLines

Container element for list of OrderLine elements.

Element

Optional

PaymentMethodCode

The used payment method code, 1 = on account, 2 = PSP, 4 = zero order.

PaymentMethodCode

Optional

PaymentReference

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

Text

Optional

Reference

This is the customers reference for an order.

Text

Optional

ShipmentMethodCode

A Shipment Method Code: 0 = pickup by customer, 1 = default delivery

ShipmentMethodCode

Required

ShippingAddress1

Street and housenumber of the shipping address

Text

Optional

ShippingCity

The city of the shipping address

Text

Optional

ShippingCountry

The country of the shipping address

Text

Optional

ShippingName1

Name of the shipping address (department)

Text

Optional

ShippingName2

Contains the company name

Text

Optional

ShippingPostalCode

The postalcode of the shipping address

Text

Optional

ShippingTransportInstruction

Transport and delivery instruction for the shipping address

Text

Optional

TotalPriceExclVat

The total price of the order excluding VAT

Decimal

Required

TotalPriceInclVat

The total price of the order including VAT

Decimal

Required

TotalVat

The total amount of VAT

Decimal

Required

OrderLine element:

Name

Description

Type

Required/Optional

LineNumber

Orderline number, must be unique for order

Integer

Required

Carrier

The description of the Carrier who ships the order

Text

Optional

DiscountAmountExclVat

This field can be used to give the calculated Discount Amount using a discount percentage. Or just give a discount amount when no discount percentage is used for the calculation.

Decimal

Optional

DiscountDescription

A description of the discount from the ERP.

Text

Optional

DiscountPercentage

A percentage of the give discount on the default netto price excluding VAT. When this field is set, the field DiscountAmountExclVat is required.

Decimal

Optional

IsExternal

If the order line is added by the ERP system (for example when its an extra fee or shipping costs), this field must be set true. If Shoxl Shop adds an order line this field is set false.

Boolean

Required

GrossPriceExclVat

The gross price excluding vat

Decimal

Required

NettoPriceExclVat

The netto price excluding vat, this can be a customer-specific or even project-specific price.

Decimal

Required

OrderLineStatus

The status of the order line

OrderLineStatus

Optional

OrderLineType

Type of the OrderLine

OrderLineType, default Product

Optional

ProductDescription

The default description of the product

Text

Required

ProductNumber

The product number for the requested product details, this can be a customer-specific product number. If IsExternal=false, the ordernumber must be filled.

Text

Required

Quantity

The number of items ordered

Decimal

Required

RemainingQuantity

The number of items not yet shipped.

Decimal

Optional

SubTotalPriceExclVat

Sub Total of the order line excluding Vat

Decimal

Optional

TrackAndTraceReference

If available, a track and trace reference of the carrier. This can be an unique code or a uri.

Text

Optional

VatCode

The VAT Code of the product

VatCode

Required

NettoPriceInclVat

The netto price including vat, this can be a customer-specific or even project-specific price.

Decimal

Required

SubTotalPriceInclVat

Sub Total of the order line including Vat

Decimal

Required

BaseUnit

The base unit of the product, eg pce or meter.

Text

Optional

PriceUnit

The quantity on which price is based

Decimal

Optional

Types:

Type

Values

Boolean

False, True

Date

yyyy-MM-dd

Decimal

Number with point (.) as decimal separator character. Other separators are not allowed.

OrderLineState

Open, Backorder, Shipped, Cancelled

OrderLineType

Product, Shipping, Payment, Other, Discount, DisposalFee

OrderState

Open, Closed

PaymentMethodCode

OnAccount, PSP, ZeroOrder

ShipmentMethodCode

Pickup, Delivery

VatCode

High, Low, Zero

Last updated