Order Documents

Short description

The ERP Cache OrderDocument interface facilitates the upload of order documents into the ERP Cache.

These documents can then be retrieved in the order history overview of the shop.

Delivery method

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

Filetype: Zipped XML

Filename: [SHOPNAME]_ErpCache_OrderDocument_[INDEXNUMBER](_[SUBNUMBER]).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_OrderDocument</Importer>
        <Version>1.0</Version>
    </ImportSettings>
    <OrderDocuments>
        <OrderDocument>
            <AccountNumber></AccountNumber>
            <OrderNumber></OrderNumber>
            <DocumentType></DocumentType>
            <ExternalId></ExternalId>
            <Name></Name>
            <MimeType></MimeType>
            <Content></Content>
            <Date></Date>
            <Delete></Delete>
        </OrderDocument>
    </OrderDocuments>
</Import>

Fields XML

Import element:

Name	Description	Type	Required/Optional
ImportSettings	Container element for importsettings	Element	Required
Documents	Container element for document data	Element	Required

ImportSettings element:

Name	Description	Type	Required/Optional
Importer	Name of the importer. Should be ErpCache_Document.	Text	Required
Version	Version of the import xml. Must be 1.0.	Text	Required

Document element:

Name	Description	Type	Required/Optional
AccountNumber	Customer's account number	Text	Required
OrderNumber	Order number to which the document will be attached	Text	Required
DocumentType	Type of the document	DocumentType	Required
ExternalId	External Id of the document. To be used for document changes.	Text	Required
Name	Name of the document	Text	Optional
MimeType	Determines the mimetype of the download link in the shop	MimeType	Required
Content	The actual document	Base64Binary	Optional
Date	Date to be displayed with the document	Date	Optional
Delete	Indicates if the document has to be deleted	Boolean	Optional

Types:

Type	Values
Base64Binary	Base64 encoded equivalent of an array of 8-bit unsigned integers
Boolean	False, True
Date	yyyy-MM-dd
DocumentType	Photo, PackingSlip
MimeType	Png, Jpeg, Pdf