Search Documentation

Overview

Product Importer Deluxe makes it almost too easy to mass import Products into your store. As with any dataset there are rules that must be adhered to:

  • Each Product belongs on its own row
  • The first row should include column headers, this will allow the importer to match up the Product detail columns automatically, if you do not include column headers ensure the “Skip the first row” checkbox remains unchecked
  • A number of Product import fields support multiple items separated by a ‘|’ (pipe) character; for instance:
    • Category (e.g. Fruit|Food|Healthy)
    • Tag e.g. (e.g. Cars|Mazda|1996|Used)
    • Images (e.g. http://www.domain.com/image-1.jpg|http://www.domain.com/image-2.jpg)
    • File Downloads (e.g. download-1.zip|download-2.zip)
    • Table Rate Prices (e.g. 1:9.95|10:7.50|100:5:95)
    • Attributes (e.g. Red|Blue|Green)
    • Related Products (e.g. APP-1|APP-2|APP-3)
  • The Category column also supports hierarchies/sub-categories separated by a ‘>’ (right arrow) character; for instance, Fruit>Apples>Red Delicious>Large>A+. Please note there is a 5 Category deep limit for heirachy support, lower depth Categories are ignored (e.g. Large in Fruit>Apples>Red Delicious>Large>A+>Export)
  • If a duplicate Product SKU is detected when generating new Products that new Product will be ignored, to update existing Products details see the Merging Product changes topic below

Sample import files

To get you started, you can download the following sample import files.

Note: Additional sample import files are currently being prepared.

Simple Products

sample-import-simple.zip – 21 Simple Products

(ZIP archive contains a single file sample-import-simple.csv)

Downloadable Products

[…]

Variable & Variation Products

sample-import-variable-variation.zip – 1 Variable Product, 2 Variations

(ZIP archive contains a single file sample-import-variable-variation.csv)

Simple Subscription Products

[…]

Note for Apple Mac users

When you are preparing your CSV file ensure you select ‘Windows CSV (Comma separated)” from the Save As prompt, failure to do this will corrupt your CSV file during the import process; kudos to Sam Slape.

Note: Better support for Mac OS users in recent Plugin updates should avoid this requirement, if you do experience missing or bunched-up columns confirm the format type as above or raise a support ticket with us.

Supported Product fields

Each e-Commerce platform for WordPress includes support for the following Product detail fields:

WooCommerce

General

  • SKU *
  • Product name *
  • Description
  • Excerpt
  • Price *
  • Sale price (Special price)
  • Weight
  • Width
  • Length
  • Height
  • Image (with automatic thumbnail generation)
  • Attributes
  • Sort Order
  • Product URL
  • Product Status
  • Comment Status

Type & Visibility

  • Type
  • Visibility
  • Featured

Categories & Tags

  • Category *
  • Tag

Tax

  • Tax Status
  • Tax Class

Inventory

  • Manage Stock
  • Quantity (Quantity limited option)
  • Allow Backorders

Jigoshop

  • SKU
  • Product Name
  • Description
  • Excerpt
  • Product Type
  • Product Group
  • Visibility
  • Featured
  • Permalink
  • Regular Price
  • Sale Price
  • Weight
  • Length
  • Width
  • Height
  • Image
  • Category *1
  • Tag
  • Tax Status
  • Tax Class
  • Manage Stock
  • Quantity
  • Stock Status
  • Allow Backorders
  • Sort Order
  • Download File
  • Download Limit
  • Product URL
  • Customizable
  • Personalized Characters
  • Attributes
  • Product Status
  • Comment Status

WP e-Commerce

  • SKU
  • Product Name
  • Description
  • Additional Description
  • Price
  • Sale Price
  • Permalink
  • Weight
  • Weight Unit
  • Height
  • Height Unit
  • Width
  • Width Unit
  • Length
  • Length Unit
  • Category *1
  • Tag
  • Image
  • Quantity
  • Notify Out of Stock
  • Unpublish Out of Stock
  • File Download
  • External Link
  • Featured
  • External Link Text
  • External Link Target
  • Taxable Amount
  • Not Taxable
  • Add Engraving
  • Add Image
  • Local Shipping Fee
  • International Shipping Fee
  • No Shipping
  • Merchant Notes
  • Product Status
  • Comment Status
  • Table Rate Price
  • Table Rate Price Status
  • Donation
  • Preview File

Third-party integration

Accepted Product column values

Description

HTML elements are allowed as well as plain text.

Visibility

  • Catalog & Search *
  • Visible *
  • Catalog *
  • Search *
  • Hidden *

Type

  • Downloadable *
  • External *
  • Grouped *
  • Simple *
  • Variable *
  • Virtual *

Featured

  • Yes, No *
  • Y, N *
  • 1, 0 *
  • On, Off *

Product Status

  • Publish, Draft *
  • On, Off *
  • 0/1

Product Comments

  • Open, Closed *
  • On, Off *

* Case insensitive

Default File Locations

WooCommerce & Jigoshop

Both WooCommerce and Jigoshop use the default WordPress Media directory for storage of Product images and file downloads.

  • If date-based indexing is turned on via Settings > Media within the WordPress Administration then this will be …/wp-content/uploads/%year%/%month%/…, otherwise
  • …/wp-content/uploads/…
WP e-Commerce 3.8
  • Depending on whether folder-based indexing is turned on via Settings > Media within the WordPress Administration Product images are stored in /wp-content/uploads/%year%/%month%/ (replacing %year% and %month%with the current year and month at time of import) or /wp-content/uploads/.
  • With the introduction of Custom Post Types in WP e-Commerce 3.8 Product image thumbnails are dynamically generated by Product Importer Deluxe, you need only upload the original Product image as thumbnails will be generated at upload time
  • Product downloadable files are stored in /wp-content/uploads/wpsc/downloadables/
WP e-Commerce 3.7 (Legacy support)
  • Product images are stored in …/wp-content/uploads/wpsc/product_images/…
  • Product image thumbnails are stored in …/wp-content/uploads/wpsc/product_images/thumbnails/…
  • Product downloadable files are stored in …/wp-content/uploads/wpsc/downloadables/…

Note: Product image filenames must match the ‘exact’ filename within the Image column of your CSV file, this is due to the related PHP functions being case sensitive. (e.g. original: SonyEricssonX1.jpg, thumbnail: SonyEricssonX1.jpg).

Uploading Products

WooCommerce, Jigoshop, WP e-Commerce
  1. Open the Product Importer Deluxe page within the WordPress Administration of your store
    • In WooCommerce open WooCommerce > Product Importer to begin
    • In Jigoshop open Jigoshop > Product Importer to begin
    • In WP e-Commerce 3.8 open Products > Product Importer to begin
  2. Set the matching drop down value beside each corresponding column in your uploaded CSV file
  3. If adding images, Under Step 3 – Import Options check ‘Are you importing images’ to enable image import support then by selecting an option choose your image import method:
    1. ‘Assigned an image column in the CSV file’ means you have a column in your CSV-formatted Product Catalog that has the filename of each product image (e.g. image-0001.jpg|camera-l4w2.jpg, etc.) and that you have manually uploaded your product images (and thumbnails for WP e-Commerce 3.7 users) via FTP prior to importing
      Check if ‘Organise my uploads into month and year-based folders’ is checked within Settings > Media of the WordPress Administration. If it is checked then upload your Product images to /wp-content/uploads/%year%/%month%/, replacing %year% and %month% with the current year and month (e.g. June 4, 2011 is /2011/06/, etc.). If the mentionedcheckbox is not ticked then upload Product images to /wp-content/uploads/… Thumbnails are automatically generated at import time.You must place the Product images via FTP or WordPress Media uploader prior to importing Products with Product Importer Deluxe.
    2. ‘Assigned an external URL column for Products in the CSV file’ means you have a column in your CSV-formatted Product Catalo that has the absolute URL of each product image (e.g. http://www.domain.com/images/image-0001.jpg|http://www.domain.com/images/camera-l4w2.jpg, etc.) and that you have manually uploaded your product images (and thumbnails for WP e-Commerce 3.7 users) via FTP prior to importing.
    3. ‘Will upload images in the next step’ means you will match each product to a product image in the following step using the product image uploader.
    4. For WP e-Commerce 3.7 users ensure the the fixed thumbnail size is set (defaults to what was defined in WP e-Commerce) within the Image width and Image height fields.
  4. If you chose ‘Will upload images in the next step’, in the following step match each product to a product image then press Save to finalise changes
  5. Click Import
  6. Once the importer progress bar has completed you can click Finish Import to review the final import report.

You can now manage Products within your respective store.

WP e-Commerce 3.7 (Legacy support)

Legacy support is provided for WP e-Commerce 3.7 series, please note though that import and customer support for such an old platform is limited and you are urged to update to the latest WP e-Commerce to maintain Products.

  1. Open Store > Upgrades > Product Importer Deluxe
  2. Set the matching drop down value beside each corresponding column in your uploaded CSV file
  3. If adding images, Under Step 3 – Import Options check ‘Are you importing images’ to enable image import support then by selecting an option choose your image import method:
    1. ‘Assigned an image column in the CSV file’ means you have a column in your CSV-formatted Product Catalog that has the filename of each product image (e.g. image-0001.jpg|camera-l4w2.jpg, etc.) and that you have manually uploaded your product images (and thumbnails for WP e-Commerce 3.7 users) via FTP prior to importingIf following the 4.1 step above and using WP e-Commerce 3.7: Upload your Product images to /wp-content/uploads/wpsc/product_images/ and thumbnails under /wp-content/uploads/wpsc/product_images/thumbnails/
    2. ‘Assigned an external URL column for Products in the CSV file’ means you have a column in your CSV-formatted Product Catalo that has the absolute URL of each product image (e.g. http://www.domain.com/images/image-0001.jpg|http://www.domain.com/images/camera-l4w2.jpg, etc.) and that you have manually uploaded your product images (and thumbnails for WP e-Commerce 3.7 users) via FTP prior to importing.
    3. ‘Will upload images in the next step’ means you will match each product to a product image in the following step using the product imageuploader.Ensure the the fixed thumbnail size is set (defaults to what was defined in WP e-Commerce) within the Image width and Image height fields.
    4. For WP e-Commerce 3.7 users ensure the the fixed thumbnail size is set (defaults to what was defined in WP e-Commerce) within the Image width and Image height fields.
  4. If you chose ‘Will upload images in the next step’, in the following step match each product to a product image then press Save to finalise changes
  5. If you provided filenames for the File download column you now need to re-open the Product Importer Deluxe initial screen and click Rehash Product Downloads

You can now manage Products within WP e-Commerce.

Upload Product Variations

Product Name Variations (Current)

Note: New documentation for this topic is currently being prepared.

The current Product Variations import method relies on the following import fields being filled:

  • Product Name
  • Product Type
  • Attribute: …

When importing new Variations it is important that the Variable Product Type row is placed above their Variations, this ensures that Variations are correctly linked to their parent Variable Product.

Product Importer Deluxe supports importing new Variations linked to Global Attributes or per-Product Attributes.

  • Global Attributes – Global Attributes can be found on the Products > Attributes screen within the WordPress Administration. Product Importer Deluxe automatically detects Global Attributes and populates Attributes within the import fields dropdown when importing.
  • Per-Product Attributes – Per-Product Attributes (also known as Custom Attributes) are created from the Edit Product screen of the WordPress Administration, within the Product Data > Attributes tab. To import Per-Product Attributes the “Custom Attributes” field within the initial Import screen at WooCommerce > Product Import needs to be populated so that Product Importer Deluxe is aware of these Per-Product Attributes.
Product Name Variations (Legacy – pre-1.9.8)

Note: The Product Variations import format has changed since the recent 1.9.8 Plugin update of Product Importer Deluxe for WooCommerce. This legacy format is no longer supported and the documentation here is provided for pre-1.9.8 users, or uses not using the WooCommerce platform.

Product Name Variations rely on the Product Name column in your CSV to link Variants to the Base Product and to generate each Variation Set/Variant. For instance to import a Red Soccer Shirt into your store you would format the Product Name column like this:

Row 1: Soccer Shirt
Row 2: Soccer Shirt|Colour|Red

Soccer Shirt = Base Product
Colour = Variation Set
Red = Variant (linked to the Variation Set)

You must generate the Base Product prior to building Variation Sets and Variants for that Product, during the import process that Base Product is scanned for and if not found will skip building those Variations.

To import a number of colours (Red, Blue, Green) of this Soccer Shirt you would format the Product Name column like this for each Variant:

Row 1: Soccer Shirt
Row 2: Soccer Shirt|Colour|Red
Row 3: Soccer Shirt|Colour|Green
Row 4: Soccer Shirt|Colour|Blue

The following Product details are support for Variants:

  • SKU
  • Description
  • Additional Description
  • Price
  • Sale Price
  • Quantity
  • Image
  • Not Taxable
  • Table Rate Price
  • Weight
  • Weight Unit
  • Height
  • Height Unit
  • Width
  • Width Unit
  • Length
  • Length Unit
  • Local Shipping Fee
  • International Shipping Fee
  • Disregard Shipping
  • Merchant Notes
  • Add Engraving
  • Add Image
  • Download Files

Multiple-Variation Set support (e.g. Colour Variant + Size Variant = unique Variant Price) has been introduced in the 1.9.8 Plugin release, please see the Product Name Variations (Current) section above.

Uploading Product Attributes

Supported in WooCommerce and Jigoshop. Coming soon to WP e-Commerce…

Product Importer Deluxe allows you to import Product Attributes against Products, to do this the importer just needs to know what Attributes you’re importing.

  1. Open Products > Attributes from within the WordPress Administration
  2. Under Add New Attributes fill in the Name and Label, name being the ‘slug’ (e.g. manufacturer) and label as the Attribute should be displayed in the storefront (e.g. Manufacturer)
  3. Select the Attribute type and hit Add Attribute
  4. Within your CSV create a column with the name of your Attribute (e.g. Manufacturer) and populate the Product values as you would any other Product detail
  5. At import time link the Attribute column from your CSV to the Attribute option within the dropdown

That’s it! To merge Product updates against Attributes do the same just ensure the ‘I am merging Product changes’ option is checked at import time.

Uploading Product images for ‘Assigned an image column in the CSV file’

Further to the instructions above regarding manually assigning Product image filenames, if you’ve defined the Product image filenames in the CSV file you’ll need to manually upload your Product images so that WP e-Commerce is ‘aware’ of them.

  1. Connect to your web server with your favourite FTP manager; I use FileZilla
  2. In WP e-Commerce 3.7, navigate to /wp-content/uploads/wpsc/product_images/. Otherwise 3.8, navigate to /wp-content/uploads/ and if using date-based indexing then the year and month.
  3. Upload your original (full size) Product images to this location, ensure all images (e.g. JPG, GIF, PNG) match the ‘exact’ filename provided in your CSV file
  4. Navigate to the ‘thumbnails’ sub-directory of the current ‘product_images’ directory
  5. Upload your resized Product image thumbnails to this location, again ensuring all thumbnails match the ‘exact’ filename provided in your CSV file

That’s it!

Uploading Download Files in WP e-Commerce

Further to the instructions above regarding uploading downloadable files, to ‘secure’ your Product download files we must ‘hash’ the filename.

Tip: Hashing means replacing the original filename of your Product download files with a ‘random’ filename that WP e-Commerce is aware of.

  1. Connect to your web server with your favourite FTP manager; I use FileZilla
  2. Navigate to /wp-content/uploads/wpsc/downloadables/
  3. Upload your Product download files to this location
  4. Open the Product Importer Deluxe front-page within WordPress Administration
  5. Hit ‘Re-hash Product Downloads’

That’s it, your hashed filename’s have been linked into WP e-Commerce and are ready to sell.

Note: Do not add a file extension, replace the Product download file filename ‘exactly’.

Uploading Wholesale Pricing details against Products

Here are some sample import rules:

  • ” (empty): Ignore Wholesale Pricing for this User Role, or if merging changes ignore Wholesale Pricing values for this User Role
  • ‘-’ (dash): Disable Wholesale Pricing for this User Role
  • ’25.00?: Set a Fixed Price of $25.00(*2) for this User Role
  • ‘+25.00?: Set a mark up of $25.00(*2) for this User Role
  • ‘-25.00?: Set a mark down of $25.00(*2) for this User Role
  • ‘+25%’: Set a mark up of 25% for this User Role
  • ‘-25%’: Set a mark down of 25% for this User Role

‘-’ (dash)

Adding a ‘-’ (dash) character to a ‘Wholesale Pricing – Role(*1)’ column will turn off Wholesale Pricing for that User Role on that specific Product.

(*1) Replace Role with a WordPress User Role; e.g. Administrator, Subscriber, Wholesaler, etc.

(*2) Wholesale Pricing will use the currency formatting from the  local currency; e.g. USD, AUD, EUR, etc.

Merging Product changes

Product Importer Deluxe allows store owners to merge changes against existing Products linked by the SKU field. At import time Product Importer Deluxe scans the store catalogue for that SKU and if detected then compares changes between the CSV row for that Product and the Product details where a difference is found the CSV’s value is used and the Product detail updated.

  1. Upload your CSV file from Tools > Import > Products within the WordPress Administration
  2. Under the Import Options dialog check the ‘Are you merging changes against existing Products?’ checkbox and link Product fields from the dropdowns above

Importing via CRON / Scheduled Imports

See our dedicated Manual CRON Exports page for Product Importer Deluxe.

Troubleshooting

See our dedicated troubleshooting page for Product Importer Deluxe.