Export Orders from Visualsoft
This task will export orders from Visualsoft in an XML format. See below for a sample output file.
Settings
Connection
Required
The Visualsoft connection to use. See the Connecting to Visualsoft article if you require more information on how to create/manage connections.
Channel
Required Select a specific channel to export orders from, or select 'All' to export from all channels. Please note that this setting only takes effect when the 'Export Modified, New or All Records' setting is set to 'NotNotified'.
Export Settings > Export From
Required
When the 'Export Modified, New or All Records' setting is set to 'New' or 'Modified', only new or modified orders after this date will be exported. This date will update automatically each time the task runs.
Export Settings > Export Modified, New or All Records
Required
Choose which orders should be exported. The available options are:
- New - This will perform a GetOrdersByDateRange request. By default this will only return successful orders, created since the date shown in the 'Export From' setting.
- Modified - This will perform a GetUpdatedOrders request, using the date shown in the 'Export From' setting. By default, this returns orders with a payment received order state that have already been notified (marked as downloaded) which have been modified since the date shown in the 'Export From' setting, excluding Visualsoft test orders.
- NotNotified - This will perform a GetNewOrders request. By default, this returns orders with a payment received order state that have not been notified (marked as downloaded), excluding Visualsoft test orders. Use this option in conjunction with the Notify Orders to Visualsoft task to control which orders are exported.
The default behaviour of the requests mentioned above can be changed, by contacting Visualsoft support.
Order IDs
Optional
Specify specific order IDs to export from Visualsoft. Multiple IDs can be specified using a comma separated list. Use of this setting will override the 'Export Modified, New or All Records' and 'Channel' settings.
Page Size
Required
The number of records to download per page. Defaults to 50.
Timeout
Required
The amount of time (in seconds) to wait for the Visualsoft API to respond to each request. Defaults to 100.
Output File
Required
The name of the file to export the orders to.
Zynk Settings
See Common Task Settings.
Examples
A sample output file is shown below.
<?xml version="1.0" encoding="utf-8"?>
<WEB_ORDERS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<WEB_ORDER>
<ORDER>
<ORDER_ID>2561</ORDER_ID>
<WEBSITE_ID>1</WEBSITE_ID>
<ORDER_REFERENCE>WEB2561</ORDER_REFERENCE>
<ORDER_STATUS_ID>2</ORDER_STATUS_ID>
<ORDER_STATUS>Processing Order</ORDER_STATUS>
<AMAZON_PRIME>N</AMAZON_PRIME>
<IS_SPLIT_PARENT>N</IS_SPLIT_PARENT>
<PARENT_ORDER_ID>123</PARENT_ORDER_ID>
<ORDER_FRAUD_STATE_ID>1</ORDER_FRAUD_STATE_ID>
<ORDER_DATE>2018-07-08 10:01:04</ORDER_DATE>
<UPDATED_DATE>2018-07-09 10:32:35</UPDATED_DATE>
<DISPATCH_DATE />
<DELIVERY_DATE />
<ESTIMATED_DELIVERY_DATE />
<DOWNLOADED>Y</DOWNLOADED>
<DOWNLOADED_DATE>2018-07-08 10:03:11</DOWNLOADED_DATE>
<PRODUCT_TOTAL_INC>10.488</PRODUCT_TOTAL_INC>
<PRODUCT_TOTAL_EX>8.740</PRODUCT_TOTAL_EX>
<PRODUCT_TOTAL_VAT>1.748</PRODUCT_TOTAL_VAT>
<SHIPPING_TOTAL_INC>7.5</SHIPPING_TOTAL_INC>
<SHIPPING_TOTAL_EX>6.250</SHIPPING_TOTAL_EX>
<SHIPPING_TOTAL_VAT>1.250</SHIPPING_TOTAL_VAT>
<DISCOUNT_TOTAL_INC>1.5</DISCOUNT_TOTAL_INC>
<DISCOUNT_TOTAL_EX>1.250</DISCOUNT_TOTAL_EX>
<DISCOUNT_TOTAL_VAT>0.250</DISCOUNT_TOTAL_VAT>
<GRAND_TOTAL_INC>16.488</GRAND_TOTAL_INC>
<GRAND_TOTAL_EX>13.74</GRAND_TOTAL_EX>
<GRAND_TOTAL_VAT>2.748</GRAND_TOTAL_VAT>
<TAX_COLLECTION_ID />
<CURRENCY_RATE_USED>1.00000</CURRENCY_RATE_USED>
<ORDER_CURRENCY>GBP</ORDER_CURRENCY>
<ORDER_CUSTOMER_COMMENTS>Leave by the door</ORDER_CUSTOMER_COMMENTS>
<ORDER_NOTES />
<ORDER_TYPE>WEB</ORDER_TYPE>
<ORDER_REFERER />
<DELIVERY_METHOD>UK Standard Delivery</DELIVERY_METHOD>
<GIFTWRAP_TOTAL_INC>0</GIFTWRAP_TOTAL_INC>
<GIFTWRAP_TOTAL_NET>0</GIFTWRAP_TOTAL_NET>
<GIFTWRAP_TOTAL_VAT>0</GIFTWRAP_TOTAL_VAT>
<NUMBER_PRODUCTS>1</NUMBER_PRODUCTS>
<MULTICHANNEL_SOURCE>
<MULTICHANNEL_SOURCE_ID>5</MULTICHANNEL_SOURCE_ID>
<MULTICHANNEL_SOURCE_NAME>Mobile</MULTICHANNEL_SOURCE_NAME>
</MULTICHANNEL_SOURCE>
<COURIER_STOCK_SYSTEM_REFERENCE_CODE />
<PO_NUMBER>98765</PO_NUMBER>
<CUSTOMER_DELIVERY_NOTES />
<BRANCH_INTERNAL_REFERENCE />
<TRACKING_INFO>
<TRACKING_REF>123456789</TRACKING_REF>
<TRACKING_COURIER>Royal Mail</TRACKING_COURIER>
</TRACKING_INFO>
<ORDER_IS_GIFT>N</ORDER_IS_GIFT>
</ORDER>
<CUSTOMER>
<CUSTOMER_ID>5642</CUSTOMER_ID>
<IDENTIFY_USING />
<BILLING_COMPANY_NAME>Zynk Software</BILLING_COMPANY_NAME>
<BILLING_TITLE>Mr</BILLING_TITLE>
<BILLING_FIRSTNAME>John</BILLING_FIRSTNAME>
<BILLING_LASTNAME>Smith</BILLING_LASTNAME>
<BILLING_ADDRESS1>Office 4</BILLING_ADDRESS1>
<BILLING_ADDRESS2>6-8 Charlotte Square</BILLING_ADDRESS2>
<BILLING_TOWN>Newcastle-upon-Tyne</BILLING_TOWN>
<BILLING_COUNTY>Tyne & Wear</BILLING_COUNTY>
<BILLING_COUNTRY_ID>1</BILLING_COUNTRY_ID>
<BILLING_COUNTRY>UK - Mainland</BILLING_COUNTRY>
<BILLING_COUNTRY_CODE>GB</BILLING_COUNTRY_CODE>
<BILLING_POSTCODE>Ne1 4XF</BILLING_POSTCODE>
<BILLING_TELEPHONE>0191 820 1484</BILLING_TELEPHONE>
<BILLING_EMAIL>[email protected]</BILLING_EMAIL>
<DELIVERY_COMPANY_NAME>Zynk Software</DELIVERY_COMPANY_NAME>
<DELIVERY_TITLE>Mr</DELIVERY_TITLE>
<DELIVERY_FIRSTNAME>John</DELIVERY_FIRSTNAME>
<DELIVERY_LASTNAME>Smith</DELIVERY_LASTNAME>
<DELIVERY_ADDRESS1>Office 4</DELIVERY_ADDRESS1>
<DELIVERY_ADDRESS2>6-8 Charlotte Square</DELIVERY_ADDRESS2>
<DELIVERY_TOWN>Newcastle-upon-Tyne</DELIVERY_TOWN>
<DELIVERY_COUNTY>Tyne & Wear</DELIVERY_COUNTY>
<DELIVERY_COUNTRY_ID>1</DELIVERY_COUNTRY_ID>
<DELIVERY_COUNTRY>UK - Mainland</DELIVERY_COUNTRY>
<DELIVERY_COUNTRY_CODE>GB</DELIVERY_COUNTRY_CODE>
<DELIVERY_POSTCODE>NE1 4XF</DELIVERY_POSTCODE>
<DELIVERY_TELEPHONE>0191 820 1484</DELIVERY_TELEPHONE>
<CUSTOMER_ACCOUNT_NUMBER>ZYN001</CUSTOMER_ACCOUNT_NUMBER>
<EMAIL_ADDRESS>[email protected]</EMAIL_ADDRESS>
<INTERNAL_CUSTOMER_REFERENCE>ZYN001</INTERNAL_CUSTOMER_REFERENCE>
<CUSTOMER_GROUP />
<IS_EXPRESS_CUSTOMER>N</IS_EXPRESS_CUSTOMER>
<DATE_OF_BIRTH>2000-01-01 00:00:00</DATE_OF_BIRTH>
<VAT_REGISTRATION_NUMBER />
</CUSTOMER>
<PRODUCTS>
<PRODUCT>
<ORDER_PRODUCT_ID>12115</ORDER_PRODUCT_ID>
<PRODUCT_ID>17524</PRODUCT_ID>
<PARENT_PRODUCT_REFERENCE>OB-HD</PARENT_PRODUCT_REFERENCE>
<CHILD_PRODUCT_REFERENCE>OB-HD</CHILD_PRODUCT_REFERENCE>
<PRODUCT_REFERENCE>OB-HD</PRODUCT_REFERENCE>
<MODEL />
<CHILD_PRODUCT_MODEL />
<EAN />
<MANUFACTURER_NAME>Genware</MANUFACTURER_NAME>
<TITLE>Pizza Oven Brush Handle</TITLE>
<SUMMARY />
<CATEGORIES>
<CATEGORY_LEVEL_1>Cleaning Equipment</CATEGORY_LEVEL_1>
<CATEGORY_LEVEL_2>Cleaning & Hygiene</CATEGORY_LEVEL_2>
<CATEGORY_LEVEL_3>Sponges & Scourers</CATEGORY_LEVEL_3>
</CATEGORIES>
<QUANTITY>2</QUANTITY>
<PRICE_INC>5.244</PRICE_INC>
<PRICE_EX>4.37</PRICE_EX>
<PRICE_VAT>0.874</PRICE_VAT>
<DISCOUNT_PRICE_INC>0</DISCOUNT_PRICE_INC>
<DISCOUNT_PRICE_EX>0</DISCOUNT_PRICE_EX>
<DISCOUNT_PRICE_VAT>0</DISCOUNT_PRICE_VAT>
<TAX_RATE>20</TAX_RATE>
<GIFT_WRAP_METHOD />
<GIFT_WRAP_COST_INC />
<GIFT_WRAP_COST_NET />
<GIFT_WRAP_TAX />
<GIFT_WRAP_MESSAGE />
<PERSONALISATIONS />
<COMPONENTS />
<ACTIVE>Y</ACTIVE>
<WEIGHT>0.33</WEIGHT>
<COMMODITY_CODE />
<CUSTOMS_DESCRIPTION />
<COUNTRY_OF_ORIGIN />
<STOCK_MESSAGE>
<STOCK_MESSAGE_ID />
<STOCK_MESSAGE_NAME />
<STOCK_MESSAGE_SHORT_NAME />
</STOCK_MESSAGE>
<PICK_LOCATION>NEV</PICK_LOCATION>
<STOCK_LOCATION>
<STOCK_LOCATION_ID />
<STOCK_LOCATION />
</STOCK_LOCATION>
<BRANCH_FULFILMENT>
<BRANCH_ID />
<BRANCH_NAME />
</BRANCH_FULFILMENT>
<SUPPLIER>John Smith & Co</SUPPLIER>
</PRODUCT>
</PRODUCTS>
<PAYMENT>
<PAYMENT_AMOUNT>16.49</PAYMENT_AMOUNT>
<PAYMENT_DATE>2018-07-08 10:01:05</PAYMENT_DATE>
<PAYMENT_TYPE>Credit or Debit Card</PAYMENT_TYPE>
<CARD_HOLDER>Zynk Software</CARD_HOLDER>
<AUTH_CODE>123456</AUTH_CODE>
<SECURITY_REFERENCE>FB5DD57FBCDD9948B77C64357B76BBCDE2E3D38FD</SECURITY_REFERENCE>
<TRANSACTION_REFERENCE>1234567890</TRANSACTION_REFERENCE>
<CV2_AVS />
<NOTES>9: The payment has been accepted.</NOTES>
</PAYMENT>
<TRANSACTION_BREAKDOWN>
<PAYMENT>
<PAYMENT_AMOUNT>16.490</PAYMENT_AMOUNT>
<PAYMENT_DATE>2018-07-08 10:01:05</PAYMENT_DATE>
<PAYMENT_TYPE>Credit or Debit Card</PAYMENT_TYPE>
<CARD_HOLDER>Zynk Software</CARD_HOLDER>
<VENDOR_TX_CODE>12345678</VENDOR_TX_CODE>
<AUTH_CODE>123456</AUTH_CODE>
<SECURITY_REFERENCE>FB5DD57FBCDD9948B77C64357B76BBCDE2E3D38FD</SECURITY_REFERENCE>
<TRANSACTION_REFERENCE>1234567890</TRANSACTION_REFERENCE>
<CV2_AVS />
<NOTES>9: The payment has been accepted.</NOTES>
</PAYMENT>
</TRANSACTION_BREAKDOWN>
<DISCOUNTS>
<DISCOUNT>
<ID>36</ID>
<CODE />
<NAME>Genware £5 Carriage</NAME>
<DISCOUNT_EX_VAT>1.250</DISCOUNT_EX_VAT>
<DISCOUNT_INC_VAT>1.500</DISCOUNT_INC_VAT>
<DISCOUNT_VAT>0.250</DISCOUNT_VAT>
</DISCOUNT>
</DISCOUNTS>
<COLLECTPLUS>
<SITE_CODE />
<SITE_NUMBER />
<CONTACT_STRATEGY />
<SERVICE_CODE />
<COLLECTPLUS_LABEL>
<SERVICE />
<BARCODE />
<DEPOT />
<ROUTE />
</COLLECTPLUS_LABEL>
</COLLECTPLUS>
<ORDER_TAGS>
<ORDER_TAG>new</ORDER_TAG>
</ORDER_TAGS>
</WEB_ORDER>
</WEB_ORDERS>