Get a Free Live Demo

Getting started with PicCommerce

Welcome to PicCommerce

"Getting Started" Guide

At PicCommerce, our top priority is to get you up and running as soon as possible. Just follow the simple instructions on this page, and add color and similar products search to your store in as fast as 10 minutes!

Sign Up & Log In

Sign Up

If you have not completed the signup process, do it here.

Log In

When finished with the signup process, log in to the admin panel here.


Set up your store

Basic Setup

Log in to the administrator's panel here.

Fill in your store's name.

Choose indexing type, using one of the following options:



    • Web Crawler - will configure PicCommerce to run a process simulating a human user, who is browsing all the pages in your store. This crawler will automatically identify product pages and insert product images to the image and color search databases.
    • CSV file - will allow the store owner to upload a spreadsheet in CSV format, containing URLs of product pages and product images, which PicCommerce will use to index products in its database.
    • Magento - will configure PicCommerce to connect to your Magento-based store and automatically discover and index product images and URLs of product pages.

Configure Indexing

Refer to one of the following options, based on your choice of indexing method chosen at the basic setup.

Web Crawler set up explained:

Website URL: Your store's homepage, the URL where the crawler will start.

Image Edge Size: The minimum width or height (in pixels) of a standard product image in your store.

NOTE: Usually, setting this parameter to 180 pixels should be sufficient, but please take time to review its fit for your particular store.

If set too low, the PicCommerce database might become cluttered with irrelevant graphics from your site, which were bigger than the minimum and therefore considered by the crawling engine to be product images.

If set too high, the crawling engine might "miss" some product images because they will not pass the minimum size filter. In this case, your store's PicCommerce database might end up containing fewer products than expected.

Base product page URL: only URLs beginning with this string will be considered by the crawler to contain product information. For example you may use:

Restricted directory: URLs beginning with this string will not be crawled. These may be general pages in your store not containing product information such as news items, FAQ, etc. For example:

CSV file explained:

A CSV file is a file format in which each line contains a number of values separated by commas (CSV = Comma-separated values). Many store maintenance and management applications use this type of file, which is usually sent by stores to various aggregator services.

If you have an inventory spreadsheet, you may easily create a CSV file from it using excel or other spreadsheet editors (Save As > CSV).


csv explained


The following fields should be present in the CSV (with or without title row - both are accepted), in this exact order:

  • Image URL (link to the product image)
  • Page URL (link to the product page in your store)
  • Product name
  • Category ID (numeric)
  • Extended data 1 (usually product brand, if different brands are sold at your store)
  • Extended data 2 (usually product condition, or other relevant information by which PicCommerce may in the future sort your items)
  • Extended data numeric (usually price)

Magento explained:

Magento is a popular open-source eCommerce platform. If you have a Magento-based store, this is the preferred indexing option for you; however, you may use the other two indexing options if you wish. If your store is based on a platform other than Magento, we might consider developing plugins for more platforms. But, currently it is advised that you use our crawler or CSV and skip the Magento option.

Follow Magento set-up instructions below to learn how to fill in the fields.

Configure Image Type

Choose the image type applicable for your store.

After hitting the "submit" button, the indexing process will start immediately and may take up to 24 hours to finish.

Please make sure to use the correct "image type" setting to avoid re-indexing; you must wait until the full cycle is complete before you can re-index.

Product with background


If images in your store show your product, such as clothes, shoes, and /or accessories, over a background, choose this option. PicCommerce will then filter out the background and visually analyze only the product within the image.



If products in your store take up the entire product image with hardly any background, choose this option. This configuration is ideal for stamps, paintings, stock photography, and wallpaper. PicCommerce will analyze the entire product image and index it for similarity and/or color search.


Set up the color search widget

Configuring Widget Style

Select the desired style from the dropdown boxes.

A sample image and HTML code will be automatically displayed.

HTML Widget Setup

After selecting widget type, copy the code that appears in the box at the bottom.



Paste the code within your store's template HTML in the position where you would like the widget to appear.

If you have selected the "toolbar" widget, paste the code right before the closing tag.

Testing the Widget

That's it! Now check your store to verify that the installation has succeeded!


Set Up PicCommerce on Magento

Step 1 - On PicCommerce’s admin panel, configure the Magento Indexing as follows:

PicCommerce admin


Step 2 - Set up a new role for PicCommerce on your Magento store

1. Enter the Roles section via the menu (System → Permissions → Roles)


2. Click the “Add New Role” button


3. Set the Role Name (e.g. “api_role”)


4. Check the “Catalog” section in the Role Resources


5. Click the “Save Role” button

Step 3 - Set up a new user for PicCommerce on your Magento store

1. Enter the Users section via the menu (System → Permissions → Users)


2. Click the “Add New User” button


3. Fill in the user information according to the following image


4. Assign the previously defined Role to the User in the User Role section


5. Click the “Save User” button

Step 4 - Installing the PicCommerce extension on your Magento store

1.Log out from your Magento store’s admin panel.

2.Download the Magento extension here.

3.Extract the extension in your Magento’s root folder (e.g. /var/www/magento).

4.Log in to your Magento store’s admin panel.

5.Clear the Magento cache via the menu (System → Cache Management → Flush Magento Cache).

Step 5 - Configuring the PicCommerce extension

1. In your store’s admin panel, go to the PicCommerce extension configuration via the menu (System → Configuration → PicCommerce Configuration)


Configuration sidebar

2. In the PicCommerce Configuration panel set the following configuration:

    • Set your widget state to “Active”
    • Set your widget location as desired
    • Configure your desired widget style (see instructions above) and copy the code to the box as demonstrated in the following image:


4. Click the “Save Config” button

That’s it! Now check your store to verify that the installation has succeeded!