Import and export filters
On this page
You can use a specially-formatted spreadsheet to import or export the filter data. We use CSV (comma-separated value) files to perform this kind of task.
How to export filter options?
You can export your products to a CSV file to help with several tasks:
Creating a backup of your filter group. Editing your filter options in bulk using a spreadsheet.
Any changes that you make to the filter in your filter CSV file appears in your storefront if you import your filter CSV file into the app admin dashboard.
1. Navigate to Filters in the Admin dashboard. Click on the filter group you want to export data.
2. From the dialog box, choose the filter options you want to export:
- All filter options
- Filters you have selected
3. Click Export Filters
A CSV file containing only those filters you selected will export.
After you make changes to your exported filter CSV, you can import the edited CSV file back into our system.
How to import filter options?
Importing filters is useful if you want to make any changes to your current filter options. When importing, our system will overwrite your existing filter options from the CSV file.
- Before you start your import, make sure that you have a backup of your filter group data.
- Each filter group has a unique GroupID, and each filter options in that group have a unique Id generated by our system.
- You can not create a new filter option by adding data in the spreadsheet.
- Navigate to Filters in the Admin dashboard. Click on the filter group you want to import data from.
Click Import filters
Click Upload a file in the pop-up window.
Locate your CSV file, then click Open.
Click Upload file. Select the field you want to import. Then click Import.
How to use Filter CSV files?
What is CSV file
CSV stands for comma-separated values, a file format (.csv) for spreadsheets. You can use CSV files to import filter options data, including Display mode, Label, Tag Prefix, Multiple Selection, etc.
They can be useful in many situations, such as when you need to bulk edit filter options of a filter group by using a spreadsheet.
Your CSV files must use UTF-8 encoding.
If you are updating a CSV file export, then remember to confirm the UTF-8 encoding to avoid generating unwanted special characters in your file. If you save your file after forgetting to confirm its UTF-8 encoding, then your data will be corrupted when you upload it as a new spreadsheet. We can't recover corrupted files for you.
We recommend that you use Google Sheets to work with your CSV files. To use Google Sheets, you must import the CSV file into the program. After you've made your changes, export the CSV file to your computer. Special characters don't always work correctly in CSV files that are exported, edited with another spreadsheet program, and then re-imported into our app.
The CSV looks like this in a spreadsheet program:
Our filter CSV file format
Active: Valid values are TRUE if the filter option is published on your online store or FALSE if the filter is hidden from your online store.
CircleSwatch: Values are TRUE if you want to use Swatch in circle, or FALSE if you want to use Swatch in rectangle.
CollapseOnMobile: Don't change the value as our filter is optimized on mobile.
CollapseOnMobile: Values are TRUE if you make the filter option collapsed by default or FALSE if you want the filter option expanded by default.
DisplayMode: Value equals the number 0 (List), 1(Box), 2 (Range), 3(Swatch)Collection filter only has display mode as List. The display mode depends on the value data type. With the Text number data type, you can select List, Box, or Swatch. The Number data type (Price, Percent sales) allows you to display it as List or range slider.
DisplayToolTip: TRUE if you want to use tooltip for that filter option, FALSE if you don't use tooltip.
ExcludedValues: The values you want to exclude in that filter option. Example: ["style-casual","style-formal"]
FacetName: The filter option type. Valid values are: weight, price, stockStatus, vendor, reviewRating, collections, productType, tags, option:Color, percentSale, option:Size
GroupId & Id: the Id for filter group and fitler options generated by our system. Please don't edit these fields.
Label: The name of filter options displayed in the storefront.
LabelPrefix: Use this for filter by tags.
ManualValues: The values you want to exclude in that filter option. Example: ["modern","classic"]
Multiple: Valid values are TRUE if you allow users to select multiple values of the same option or FALSE if you allow users to select one value in that filter option.
Narrow: Only applied for filter by tags and Multiple is TRUE. Valid values are TRUE if products in the results must have the selected filter values. FALSE if products in the results must not have the selected filter values
For example: you have some products in 100% cotton, some in 70% cotton and 30% polyester, and some in 100% polyester. If Narrow is TRUE, users can select cotton and polyester to see products that have both attributes. If Narrow is FALSE, users can find products that have either cotton or polyester.
Ordinal: the position of the filter options in the group.
Do not sort or add any more columns to your CSV as it can affect the data on our system.