Importing Customers to BigCommerce V3

This task will create new or update existing customers on your BigCommerce store.

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.

Fail File

Required
The XML file to output failed uploads to.

Input File

Required
The XML file containing the customer records. Refer to the example below for more details about the XML format.

Success File

Required
The XML file to output successful updates to.

Prevent Reprocessing

Required
Set to true to only process a record once, or set to false to always update records. Defaults to False.

Zynk Settings

See Common Task Settings.

Examples

For detailed documentation on the fields please see the BigCommerce Dev Center.

If a <customer> node contains an <id> node, it will be treated as an existing customer and the task will attempt to update it in BigCommerce.

If no <id> node is provided for the customer, existing customers will be searched for based on <email>. If a match is found the existing customer will be updated.

If a match is not found, it will be treat as a new customer and the task will attempt to create it in BigCommerce. When creating new customers, a <first_name>, <last_name> and <email> node must be provided.

Please note that the <date_created>, <date_modified>, <registration_ip_address>, <address_count> and <attribute_count> nodes are read-only and will result in an error if you try to provide them.

<?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>
    <email>[email protected]</email>
    <first_name>Adam</first_name>
    <last_name>Wardle</last_name>
    <company>Zynk Software Ltd</company>
    <phone>01913037279</phone>
    <notes>Customer created by Zynk</notes>
    <tax_exempt_category>A</tax_exempt_category>
    <customer_group_id>0</customer_group_id>
    <authentication>
      <force_password_reset>false</force_password_reset>
      <new_password>abcd1234</new_password>
    </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 &amp; 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>true</trigger_account_created_notification>
  </customer>
</customers>