Export Customers from BigCommerce V3
This task will download customers registered on your BigCommerce store to an XML file.
Settings
Connection
Required
The BigCommerce connection to use. See the Connecting to BigCommerce v3 article if you require more information on how to create/manage connections.
Customer Group
Optional
Select a customer group from the list to filter the export based on customer group.
Export Addresses
Required
Set to true to include customer addresses in the export file. Defaults to True.
Export Attributes
Required
Set to true to include customer attributes in the export file. Defaults to False.
Export Form Fields
Required
Set to true to include customer form fields in the export file. Defaults to False.
Export Settings > Date Created
Required
When the 'Export Type' is set to New, only records created after this date will be downloaded. The date will update automatically each time the task runs based on the data returned.
Export Settings > Date Modified
Required
When the 'Export Type' is set to Modified, only records updated after this date will be downloaded. The date will update automatically each time the task runs based on the data returned.
Export Settings > Export Type
Required
Used to choose which records should be included in the download. The available options are: -
- New - Only records created since the task last ran will be downloaded
- Modified - Only records created or updated since the task last ran will be downloaded
- All - All records will be downloaded, regardless of whether or not they have been updated since the task last ran
Export Store Credits
Required
Set to true to include customer store credits in the export file. Defaults to False.
Output File
Required
The name of the XML file to export the data to (e.g. big_commerce_export_customers.xml).
Page Size
Required
The number of records returned per page of the request. Defaults to 50.
Zynk Settings
See Common Task Settings.
Examples
A sample output file is shown below.
For detailed documentation on the fields please see the BigCommerce Dev Center.
<?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>
<id>5</id>
<zynk_external_id>TEST0001</zynk_external_id>
<date_created>2025-06-09T14:16:46Z</date_created>
<date_modified>2025-06-09T14:22:25Z</date_modified>
<email>[email protected]</email>
<first_name>Adam</first_name>
<last_name>Wardle</last_name>
<company>Zynk Software Ltd</company>
<phone>01913037279</phone>
<registration_ip_address />
<notes>Customer created by Zynk</notes>
<tax_exempt_category />
<customer_group_id>0</customer_group_id>
<address_count>1</address_count>
<attribute_count>0</attribute_count>
<authentication>
<force_password_reset>false</force_password_reset>
</authentication>
<addresses>
<address>
<id>5</id>
<first_name>Adam</first_name>
<last_name>Wardle</last_name>
<company>Zynk Software Ltd</company>
<address1>i6 Building</address1>
<address2>6-8 Charlotte Square</address2>
<city>Newcastle upon Tyne</city>
<state_or_province>Tyne & Wear</state_or_province>
<postal_code>NE1 4XF</postal_code>
<country_code>GB</country_code>
<phone>01913037279</phone>
<address_type>commercial</address_type>
<customer_id>5</customer_id>
<country>United Kingdom</country>
<form_fields />
</address>
</addresses>
<attributes>
<attribute>
<attribute_id>1</attribute_id>
<attribute_value>TEST0001</attribute_value>
</attribute>
</attributes>
<form_fields>
<form_field>
<name>dob</name>
<value>2000-01-01</value>
</form_field>
</form_fields>
<store_credit_amounts>
<store_credit_amount>
<amount>0</amount>
</store_credit_amount>
</store_credit_amounts>
<accepts_product_review_abandoned_cart_emails>false</accepts_product_review_abandoned_cart_emails>
<origin_channel_id>1</origin_channel_id>
<trigger_account_created_notification xsi:nil="true" />
</customer>
</customers>