Importing Collections
Collections serve as an alternative to categories for organizing products, especially useful for short-term merchandising campaigns. This topic covers the process of importing multiple collections with a CSV file. You can also add collections individually.
We highly recommend that you download the template file to use as a guide when creating your CSV file for import to minimize errors during the import process.
CSV File Guidelines
You can import collections using CSV files only; Product Catalog doesn’t support any other data or file formats. Here are the key points to consider:
- The headers, represented in the first row of the CSV file, should match the attributes of the collection.
- While collection titles aren’t case-sensitive, maintaining case consistency with the original collection titles is recommended.
- Empty rows and columns are ignored.
Collection Data Formatting
When preparing your CSV file for import, ensure that the collection data format aligns with the column requirements. Different columns have specific data input requirements:
- Action: Accepts one of the following commands:
- Create adds a new collection.
- Update replaces the details of an existing collection.
- Upsert creates a new collection or replaces the details of an existing collection. Note that if no action is specified for a row, upsert is considered the default.
- Node ID: Represents the Collection ID.
- Parent Collection: Unless you are creating a primary or root collection, specify the parent category for the new collection you want to create or update.
- Node Name: Name of the root, branch, or leaf collection that you are creating or updating.
- Order: The order in which a given collection must appear among sibling collections. If multiple collections are assigned the same order, the newly added collections appear in alphabetical order.
- Category Attributes: Attributes that are assigned to the Collection.
- Categories Included: Categories to include when creating the collection.
- Categories Excluded: Categories to exclude when creating the collection.
- Product Attribute Filters: Attribute conditions that filter the eligible products for the Collection node. Filter operations are dependent on the attribute type.
| Attribute Type | Available Operations |
|---|---|
| Text | Contains, Doesn’t contain, Is exact match |
| Number | Is equal to, Is less than, Is greater than |
| List of Value | Includes, Excludes |
| Boolean | Yes, No |
| Date | Is equal to, Is less than, Is greater than |
| Serial | Is equal to, Is less than, Is greater than |
Example file
| Action | Node Id | Parent Collection | Node Name | Order | Category Attributes | Categories Included | Categories Excluded | Product Attribute Filters |
|---|---|---|---|---|---|---|---|---|
| Create | 12345645648689 | Import-collection | 1 | Collection SEO=SEO Value | category date YYYY-MM-DD=2024-03-22; | |||
| Import-collection | Parent-1 | 1 | Furniture,Accessories | |||||
| Import-collection->Parent-1 | Child 1 | 1 | Furniture>Desks | name=Description; op=CONTAINS; value=furniture | ||||
| Import-collection->Parent-1 | Child 2 | 2 | Furniture>Chairs | name=Color; op=ISEXACTMATCH; value=Brown |
Prerequisites
Before initiating the item import, ensure that:
- You have created at least one category with items and attributes assigned to it. For more information about creating categories, see the Categories section.
- The CSV file adheres to the guidelines.
Procedure
- In the left menu, click Product Catalog > Collections. The Collections page is displayed.
- Click Import Collection. The Import CSV file window is displayed.
- (Optional) To download the template, click template here. The template is downloaded.
- To import a CSV file, do one of the following:
- Drag and drop the file into the window.
- Click Select a File from your computer.
- Click Import file.
The CSV file is imported and the collection is created.
To track the import status, go to Product Catalog > Background Jobs > Imports page.
Related Topics
Was this page helpful?