Export Customers from Visualsoft
This task will export customers from Visualsoft in an XML format. The results can be filtered if required. 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.
Date Modified
Required
When the 'Export Type' setting is set to 'Modified', only customers updated after this date will be exported. This date will update automatically each time the task runs.
Export Detailed
Required
Set to true to export detailed information about each record, or false to export a summary.
Export Type
Required
Choose which records should be exported. The available options are:
- Modified - Only customers created/updated after the date shown in the 'Date Modified' setting will be exported.
- LookupById - Only customers with the IDs specified in the 'Lookup Value' setting will be exported.
- LookupByAccountNumber - Only customers with the account number specified in the 'Lookup Value' setting will be exported.
- LookupByName - Only customers with the name specified in the 'Lookup Value' setting will be exported.
- LookupByEmail - Only customers with the email address specified in the 'Lookup Value' setting will be exported.
Lookup Value
Optional
When the 'Export Type' setting is set to LookupById, LookupByAccountNumber, LookupByName or LookupByEmail, specify the value to search for here. When using the LookupById option, you can specify multiple IDs by providing a comma separated list.
When the 'Export Type' setting is set to Modified, any value specified here will be ignored.
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 customers to.
Zynk Settings
See Common Task Settings.
Examples
A sample output file is shown below.
<?xml version="1.0" encoding="utf-8"?>
<CUSTOMERS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CUSTOMER>
<CUSTOMER_ID>5642</CUSTOMER_ID>
<WEBSITE_ID>1</WEBSITE_ID>
<CUSTOMER_ACCOUNT_NUMBER>ZYN001</CUSTOMER_ACCOUNT_NUMBER>
<INTERNAL_CUSTOMER_REFERENCE>ZYN001</INTERNAL_CUSTOMER_REFERENCE>
<EMAIL_ADDRESS>support@zynk.com</EMAIL_ADDRESS>
<DATE_OF_BIRTH />
<CUSTOMER_OCCUPATION />
<HEARD_ABOUT />
<CUSTOMER_NOTES />
<IS_EXPRESS_CUSTOMER>N</IS_EXPRESS_CUSTOMER>
<ADDRESSES>
<ADDRESS>
<CUSTOMER_TITLE>Mr</CUSTOMER_TITLE>
<CUSTOMER_FIRSTNAME>John</CUSTOMER_FIRSTNAME>
<CUSTOMER_LASTNAME>Smith</CUSTOMER_LASTNAME>
<COMPANY_NAME>Zynk Software</COMPANY_NAME>
<ADDRESS_LINE_1>Office 4</ADDRESS_LINE_1>
<ADDRESS_LINE_2>6-8 Charlotte Square</ADDRESS_LINE_2>
<TOWN>Newcastle-upon-Tyne</TOWN>
<COUNTY>Type & Wear</COUNTY>
<POSTCODE>NE1 4XF</POSTCODE>
<COUNTRY_ISO_CODE>GB</COUNTRY_ISO_CODE>
<COUNTRY_NAME>UK - Mainland</COUNTRY_NAME>
<TELEPHONE>0191 820 1484</TELEPHONE>
<MOBILE></MOBILE>
<IS_DEFAULT>Y</IS_DEFAULT>
<ADDRESS_ID>1</ADDRESS_ID>
</ADDRESS>
</ADDRESSES>
<EWALLET>
<CURRENT_BALANCE>0</CURRENT_BALANCE>
<LOGS />
</EWALLET>
<DATES>
<DATE_REGISTERED>2018-06-13 22:45:45</DATE_REGISTERED>
<DATE_LAST_LOGIN>2018-06-13 22:45:45</DATE_LAST_LOGIN>
<DATE_LAST_MODIFIED>2018-06-21 09:07:03</DATE_LAST_MODIFIED>
<DATE_EMAIL_OPT_IN>2018-06-13 22:45:45</DATE_EMAIL_OPT_IN>
<DATE_BALANCE_LAST_UPDATED>2018-06-13 22:45:45</DATE_BALANCE_LAST_UPDATED>
</DATES>
<OPT_INS>
<EMAIL>No</EMAIL>
<POST>No</POST>
<SMS>No</SMS>
<LOYALTY>Us</LOYALTY>
</OPT_INS>
<APPROVED>Y</APPROVED>
<CUSTOMER_NIF />
<FREE_DELIVERY>N</FREE_DELIVERY>
<CUSTOMER_GROUP_ID>0</CUSTOMER_GROUP_ID>
<CUSTOMER_GROUP_NAME />
<CURRENT_BALANCE />
<CREDIT_LIMIT />
<LOCK_TO_TRADE_ONLY>N</LOCK_TO_TRADE_ONLY>
<VAT_REGISTRATION_NUMBER>GB123456789</VAT_REGISTRATION_NUMBER>
<VAT_EXEMPT>N</VAT_EXEMPT>
<CUSTOMER_TYPE>BUSINESS</CUSTOMER_TYPE>
<EXTERNAL_LOYALTY_PROGRAM_NUMBER>1234</EXTERNAL_LOYALTY_PROGRAM_NUMBER>
<COMPANY_NUMBER>1234</COMPANY_NUMBER>
<COMPANY_DOMAIN>Software</COMPANY_DOMAIN>
<EORI_NUMBER>1234</EORI_NUMBER>
</CUSTOMER>
</CUSTOMERS>