The information in this thread might be outdated
If the solution did not help, please, check our Help Portal or contact Ecwid Team.
Thread Tools Display Modes
Old 08-07-2014, 08:25 AM
Wendy's Avatar
Wendy is offline
Ecwid Team
Join Date: Jun 2014
Posts: 1,123

"Product Filters/Faceted Search API" feature

Good news, everyone!

We are happy to inform you about brand new amazing feature in Ecwid: Faceted search (faceted navigation / filtered search) is now available for you and your customers in your Ecwid store.

What is the faceted search, and How does it work?

Faceted search allows filtering and showing products in Ecwid storefront by the following parameters:
  • prices
  • categories
  • attributes’ values
  • keywords

You can use this new feature to:
- add a "smart" search (e.g. "find all products with keyword "chair" from the "Furniture" category")
- build new dynamic store pages, i.e. new custom store navigation (e.g. "show all t-shirts which have Gender attribute = Male and where price is between $10 and $50").

How it works

In order to use the faceted search you should form a special URL containing necessary parameters in the hash-part, i.e. the part of URL that goes after "#".

Here is an example illustrating how such a query looks like:
All parameters are surely optional and only one parameter would be mandatory. If you specify more than one parameter, you should link them with AND (displayed as &) - it will indicate that all the conditions in the URL are to be met. See more examples of the queries below.

List of search parameters:
  • priceFrom: the minimum products’ price (base price). The decimal separator is dot. No currency symbol.
  • priceTo: the maximum products’ price (base price). The decimal separator is dot. No currency symbol.
  • category: the category ID, to which products belong. This partially duplicates functions of the Categories widget and provides you with the more flexible results. For example, you can mix several parameters: to select all the products which cost less than $30 and belong to the ‘t-shirt’ category. Instructions: How to get category ID
  • withSubcategory: whether to show products from subcategories, if the "category" parameter is indicated. Possible values: true, any other value is treated as false.
  • field{Name}=param[,param]: search by product attributes. "Name" is the attribute name (spaces will work). "Param" is the attribute value.
    You can place several values separated by comma. In that case values will be connected through "OR", and if the product has at least one of them it will be shown.
    Important note: if you need to search for an exact attribute value you should enclose it in the quotation marks.
    Detailed information about product attributes:
  • field{id}=param[,param]: it is the same parameter as field[Name] but attribute ID is used instead attribute name. In this case you need to get the attribute ID number through the API. It is more complex but resistant to attributes renaming.
  • keywords: it is a search string. The search result will be products with title, description, or some other fields containing these keywords.


A very good example of how Faceted search may work can be viewed on this site with Ecwid store:

All products under $10:!/~/search/priceTo=10

All products from the "Top 10" category:!/...bcategory=true
NOTE: the "withSubcategory" parameter is used with value "true" to show products from subcategories as a search result.

All products from the "Top 10" category which price is from $10 to $30:!/...=10&priceTo=30

All products of the "Optimum" brand (Brand=Optimum):!/...dBrand=Optimum

All tablets (Form=Tablets):!/...ldForm=Tablets

All tablets for muscle building (Form=Tablets AND Supported Goal=Build Muscle):!/...ld%20Muscle%22

Capsules for muscle building under $40 (Form=Capsules AND Supported Goal = Build Muscle AND price < $40 ):!/...%22&priceTo=40

Capsules for muscle building from the "Top10" category (Form=Capsules AND Supported Goal = Build Muscle AND category = Top10 incl. subcategories):!/...bcategory=true

All products which contain the word "Protein" from the "Top10" category (Match the "Protein" word AND category = Top10 incl. subcategories):!/...bcategory=true

How I can use it on my site?

1. You can create links with a specific search query manually and place them on your site, or share them with your customers. For example, you can create a page listing all brands available in your store and link each brand's logo to a store page containing products that belong to this very brand only.

2. You can use our Product and JavaScript APIs to build such links automatically to to expand functionality of Ecwid's widgets. For example, create several drop down menus and place them next to your Product browser and make each value in the drop down box open a page with products filtered by this value.

3. Check out ready applications in Ecwid App Market: Clickable Brand and Product Search Enhancer. They use Ecwid REST API and Product Filters functionality of storefront to provide enhanced experience for your customers.

Hope you'll enjoy the feature. If you have any questions, feel free to post them on the forums.
Ecwid Customer Care Team
Help Center

⬇ Please click Thanks if my reply helped you.

Last edited by Vitaliy G; 02-29-2016 at 09:25 AM.
The Following 19 Users Say Thank You to Wendy For This Useful Post:
3dPrintronics (08-07-2014), Anna Kreyman (02-27-2015), Arthur Belostotsky (08-07-2014), chad5 (11-09-2015), Clara K (01-22-2015), ginger (10-13-2014), Heathersue (03-13-2015), My Store 12345 (05-27-2015), Ksenya Merkulova (04-17-2015), Mike (08-07-2014), Olivier2 (02-15-2015), Orly Segal (08-26-2014), valdemar_absatz (09-12-2014), Qetzal (08-07-2014), river (03-25-2015), Stacy_P (11-29-2016), Suranas Jewelove (09-22-2014), Viktor D. (09-02-2014), Rick G (08-07-2014)
The information in this thread might be outdated
If the solution did not help, please, check our Help Portal or contact Ecwid Team.

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

All times are GMT. The time now is 03:29 AM.
Powered by vBulletin® Version 3.8.11. Copyright ©2000 - 2021, Jelsoft Enterprises Ltd.