Skip to main content

Voyado Engage

Receipt XML import

API is the preferred way of creating and updating contacts in Voyado. However, there are scenarios when file-based imports are applicable, for example when another system is master and immediate updates are not crucial.

Voyado stores all purchases on a contact which can later be used for segmentation and analysis. The transaction object is partly adaptable in order to fulfill the client’s specific needs.

This means that in addition to the standard fields, it is possible to add up to 10 extra string fields and up to 5 extra date fields which can be used for segmentation. However, remember to only include fields that are necessary since every additional field could affect the overall performance in Voyado. Read more about transactions here.

Please read the Technical overview for file based integrations before going any further!

Naming the files

Files sent to the FTP server should follow this naming convention:[Timestamp]_[sequence number OR store id] _transactions.xml

  • [Timestamp] should be formatted as: YYYYMMDDHHmmss

  • the sequence or store id is only necessary if several applications might send XML files at the exact same time

FTP location

[base ftp-url]/integration/transactionImport

Scheme and field definitions

Download the basic XSD scheme here (used for the XML import) here.

Find the complete list of Field definitions here.

Register a purchase

Please read more about registering a purchase here.

<?xml version="1.0" encoding="utf-8"?>
<transactions xmlns="http://voyado.Schemas.ImportReceipts">
  <transaction>
    <contact>
      <matchKey>90154424</matchKey>
      <matchKeyType>memberNumber</matchKeyType>
      <contactType>Member</contactType>
    </contact>
    <uniqueReceiptId>14534304434293</uniqueReceiptId>
    <receiptNumber>87684684684</receiptNumber>
    <createdDate>2019-07-23T09:02:01+02:00</createdDate>
    <storeExternalId>12313</storeExternalId>
    <currency>SEK</currency>
    <exchangeRateToGroupCurrency>1.1</exchangeRateToGroupCurrency>
    <totalGrossPrice>200.00</totalGrossPrice>
    <paymentMethods>
      <paymentMethod>
        <type>bonuscheck</type>
        <description>25kr bonuscheck</description>
        <value>25.00</value>
      </paymentMethod>
      <paymentMethod>
        <type>creditcard</type>
        <description>Mastecard</description>
        <value>175.00</value>
        <extraData>
          <item name="cardNumber">489456*</item>
          <item name="cardIssuer">ICA Banken</item>
        </extraData>
      </paymentMethod>
    </paymentMethods>
    <usedBonusChecks>
      <usedBonusCheck>
        <checkNumber>45343</checkNumber>
      </usedBonusCheck>
    </usedBonusChecks>
    <usedPromotions>
      <usedPromotion>
        <couponId>625bafb8-00ee-44c1-aacc-aa9400a77cbb</couponId>
      </usedPromotion>
    </usedPromotions>
    <items>
      <item>
        <type>PURCHASE</type>
        <quantity>2</quantity>
        <grossPaidPrice>200.00</grossPaidPrice>
        <taxAmount>40.00</taxAmount>
        <taxPercent>25.00</taxPercent>
        <sku>23424123456</sku>
        <articleNumber>123456</articleNumber>
        <articleName>Stickad tröja V-neck</articleName>
        <articleGroup>Tröjor</articleGroup>
        <marginPercent>25.00</marginPercent>
        <awardsBonus>false</awardsBonus>
        <datespare1>2019-07-23T09:02:01+02:00</datespare1>
        <discounts>
          <discount>
            <type>325</type>
            <description>50% rabatt nedsatt vara</description>
            <value>-200.00</value>
          </discount>
        </discounts>
      </item>
    </items>
  </transaction>
</transactions>
Register a return

Please read about registering a return here.