Skip to content

Importing Products to BigCommerce V3

This task will update existing or create new products in 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 product updates. These should be stored in the same format as products downloaded using the 'Export Products' task. Sample XML is provided below.

Success File

Required
The XML file to output successful updates to.

Match Product Variants

Required
Set to true to have the task search for existing product variants to update in BigCommerce, based on <sku>. If no match is found, a new variant will be created.

When set to false, you will need to provide the <id> of any product variants that you want to update in the XML. Any variants without an <id> will be treated as new, and will be created.

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 <product> node contains an <id> node, it will be treated as an existing product and the task will attempt to update it in BigCommerce. If no <id> node is provided for the product, the task will try to find an existing product based on <sku>.

If a match is found the existing product will be updated. When updating existing products, please note that the <rating_total>, <rating_count>, <number_sold>, <date_created>, <date_modified>, <date_last_imported> and <custom_url> nodes are read-only and will result in an error if you try to update them.

If no match found, it will be treated as a new product and the task will attempt to create it in BigCommerce. When creating new products, a <name>, <price>, <categories>, <type>, <availability>, and <weight> node must be provided, and the <rating_total>, <rating_count>, <number_sold>, <date_created>, <date_modified>, <date_last_imported> and <custom_url> cannot be provided as they are read-only.

<?xml version="1.0" encoding="utf-8"?>
<products>
  <!-- New product -->
  <product>
    <name>FX010 Plain Paper Fax</name>
    <type>physical</type>
    <sku>FAX001</sku>
    <description>FX010 Plain Paper Fax</description>
    <price>15.0000</price>
    <cost_price>0.0000</cost_price>
    <retail_price>0.0000</retail_price>
    <sale_price>0.0000</sale_price>
    <is_visible>false</is_visible>
    <is_featured>false</is_featured>
    <weight>0.0000</weight>
    <categories>
      <category>18</category>
    </categories>
    <tax_class_id>0</tax_class_id>
    <availability>available</availability>
    <inventory_tracking>variant</inventory_tracking>
    <inventory_level>12</inventory_level>
  </product>
  <!-- Update for an existing product -->
  <product>
    <id>101</id>
    <name>Product with Variants</name>
    <type>physical</type>
    <sku>VAR001</sku>
    <description>Product with Variants</description>
    <price>16.0000</price>
    <cost_price>0.0000</cost_price>
    <retail_price>0.0000</retail_price>
    <sale_price>0.0000</sale_price>
    <is_visible>false</is_visible>
    <is_featured>false</is_featured>
    <weight>0.0000</weight>
    <categories>
      <category>18</category>
    </categories>
    <tax_class_id>0</tax_class_id>
    <inventory_tracking>variant</inventory_tracking>
    <availability>available</availability>
    <variants>
      <variant>
        <id>282</id>
        <sku>VAR001-RED</sku>
        <price>16.00</price>
        <inventory_level>18</inventory_level>
        <option_values>
          <option_value>
            <label>Red</label>
            <option_display_name>Colour</option_display_name>
          </option_value>
        </option_values>
      </variant>
      <variant>
        <id>283</id>
        <sku>VAR001-BLUE</sku>
        <price>16.00</price>
        <inventory_level>15</inventory_level>
        <option_values>
          <option_value>
            <label>Blue</label>
            <option_display_name>Colour</option_display_name>
          </option_value>
        </option_values>
      </variant>
  </product>
</products>