Quickstart
Basic steps to configure Product Catalog for initial use
Before any items are entered or imported into Product Catalog for the first time, it must be configured to classify and categorize your products. This guide details the following steps which are required to prepare Product Catalog for initial data entry.
- Create Attributes
- Map Attributes
- Create Category
- Create Attribute Groups
- Create first item
This guide assumes there is no data currently in Product Catalog. Once the required attributes are mapped in the initial setup, they cannot be modified.
Step 1: Create required product attributes
Product attributes are used to define a product characteristic. For example, a product name, an identity number, and a product description are common attributes of any product. Attributes are key-value pairs (e.g. Color: red) that hold information for each property of the product.
The first step for configuring Product Catalog is to create the basic attributes that are needed for the items. This list contains the five required attributes.
NOTE: The five required attributes are the minimal set needed to get Product Catalog operational. It is best practice to enter as many applicable attributes as possible during this setup phase to reduce the number of steps to get Product Catalog configured for your specific deployment.
| Name | Attribute specifications | Function in Product Catalog |
|---|---|---|
| SKU (Mandatory) | Each SKU value must be unique | This attribute serves as the primary identifier for items to be created in Product Catalog |
| Title | A text type attribute is recommended | This attribute helps Product Catalog identify the display name of the product |
| Primary Image | A text type attribute is recommended | This attribute helps Product Catalog identify the main image of the product for thumbnail purposes |
| Active (Mandatory) | Must be a Boolean type attributeName the attribute to Active which can be set to TRUE/FALSE | Required to maintain the status of item to Active/Disabled |
| Variant Attribute | A text type attribute is recommended | This attribute helps fabric applications identify the attributes that drive variants for items (for example - color, size) |
Create attribute
Expand the Attributes menu in the left navigation and select Product Catalog.
Click the New Attribute button on the top of the page.
In the Create product attribute dialog box that appears, complete the following.
Select attribute type section
- Click on button for relevant attribute type
Title and description section
- Provide the Attribute Title you want to appear when assigning to items
- Enter a Description for your reference
- Complete other options such as Subtype or Date format if applicable
Business validations section
- Enter any relevant Business validations and customizations dependent on the attribute selected.
Click Save.
Step 2: Configure Attribute Mapping
The second step for configuring Product Catalog is to map the basic mandatory attributes to the attributes used by the merchant. For example, Product Catalog uses terms like “SKU” to refer to a unique product identifier while some merchants use the terms “UPC” or “Part Number.” Each of the basic attributes must be mapped to exactly one attribute from the following list of attributes.
| Attribute name | Attribute Type | Attribute specs |
|---|---|---|
| SKU | Text | Serves as the primary identifier for items to be created in Product Catalog Each SKU value must be unique Must be set to mandatory |
| Product title | Text | Identifies the display name of the product with the Product Catalog user interface Is recommended for use on the storefront as the item title Is recommended to be set to mandatory |
| Primary product image | Text | Serves as the thumbnail image in Product Catalog Can be set as optional. Product Catalog will display a blank image placeholder in the user interface if no value is given. |
| Active | Maintains the status of an item as Active/Inactive on your storefront (only items where status is set to Active=TRUE will be available for the commerce API to consume) Recommended name is Active Must be set to Mandatory | |
| Variant | Text | This attribute helps fabric applications identify the attributes that drive variants for items, for example - color or size. |
Map product attributes
Expand the Settings menu in the left navigation, then select Attribute mapping.
Use each dropdown under Map Product Attributes to select the product attribute to map to a Product Catalog basic attribute.
Click on the Save button.
Step 3: Create Categories
The third step is to set up your categories. Their role is to organize your products into categories and subcategories that share common product attributes. Each item in your List will be assigned to a single Category so creating logical categories gives you greater control over what attributes are required or optional for all items assigned to each Category.
For example, if the category for couches is Furniture > Living Room > Sofas, you can add attributes to each of these categories to control what information will appear on the product detail page for items that belong to the Category, Furniture > Living Room > Sofas.
Create Category
Select Categories in the left-hand navigation.
Click the + circle in the the vertical menu.
Add a Title to the empty category.
Click Enter/Return and the category will be created.
Click the newly-created Category name to add subcategories. A new level will appear to the right of the selected category.
Repeat the steps above for each the new category and subcategory.
NOTE: For first-time Product Catalog users, a blank screen appears with a single empty category.
Step 4: Create Attribute Groups
Attribute groups enable merchants to cluster various attributes together to make it easier to manage large volumes of product information. Attribute groups are not required, however they are highly beneficial if you plan to use more than15 product attributes for your List.
Example attribute groups are:
- Basic info such as product title, description, and primary image
- Media such as product animations
Attributes not specifically included in a group will appear in the Others attribute group.
Step 5: Create First Item
The last step for configuring Product Catalog is to enter the data for your first item. This will ensure the basic configuration is complete. After verifying the initial entry, you will have the option to load more individually or perform bulk imports of data.
Create item
Expand the List menu in the left-hand navigation and then select Items.
Click New Item at the top of the page.
Browse to or search the relevant subcategory from the Select a category node dialog box. Selecting a subcategory of the Category (LEVEL: 0) is required and only the last subcategory in the category can be selected.
Click Next.
Select Attribute Group, then click on the Edit button in the attribute panel.
Populate the attribute value fields in each attribute group section. At a minimum, the SKU is required to create and save an item in Product Catalog. The required values for each attribute group will vary based on the Category node selected in the beginning of the process and all mandatory attribute fields must be entered to publish the item to your storefront.
Here are a few example attribute fields that will vary based on how you configured Product Catalog.
- SKU - the unique identifier assigned to the item. This is required to create and save the item.
- Product Title - title that will appear when item is visible on a webpage
- Product Image - URL of the image to represent the product or service
Click Save.
When all mandatory attribute values have been entered, the attribute group status indicator will change from Not Started to Completed.
Continue adding attribute values to each attribute group included in that item.
Once all mandatory attribute values have been populated, the Publish button will be enabled. When Publish is clicked, the item will be live. This indicates the content is available for the commerce API to consume and display the product details on your website.