Skip to main content
The Catalogs template for the import/export tools is the largest of the import/export template files, and is likely the one you will use the most. Together, the sheets of the Catalogs template represent your entire catalog structure for all the sites on your tenant. You can use this template to add or update master catalogs, sub-catalogs, product types, product attributes and options, images, inventory, and discounts. If you are preparing your initial data import for a new tenant, import contacts before you import products. As you work with this file, you will enter information about a single product across multiple sheets. A a combination of IDs, codes, names, and catalog information are used to make the proper data connections. For example, most sheets require a ProductCode to bind the data the sheet contains to the correct product. Catalogs template file content with example data

Access the Tools

With the Import-Export Application installed and enabled, go to Main > Catalog > Import/Export in the Admin.

Supported File Formats

  • CSV (.csv): Each sheet is a separate CSV file. For both imports and exports, sheets are compressed into a ZIP file. When importing, the ZIP file can have any file name but each individual CSV file name must match the export file name and the sheet. You can remove CSV files for data you do not want to import.
These CSV files should not be opened in Excel, as that may cause errors with their formatting. Instead, use a different CSV editing program to make changes to the data. You should only use the default Windows zipper to zip the files, as using different software may cause errors. You can upload multiple files at once as long as they all are zipped.

Template Key

For each sheet, we define each column and describe valid values for the column. If you have questions or concerns specific to your data, please contact your integration partner or Kibo Support.

Sheets

Attributes

Corresponding REST API Resource: commerce/catalog/admin/attributedefinition/attributes Required With: AttributeValues Product attributes are the variable properties that define a product. Attributes can be options (such as size or color), properties (such as the brand of the product), or extras (such as custom printing or warranties). Because many products share common attributes, you define general attributes before you apply them to specific products.

AttributeValues

Corresponding REST API Resource: commerce/catalog/admin/attributedefinition/attributes Required With: Attributes Attribute values define what customers see for a given attribute. A single attribute can have multiple values. For example, if an attribute has an InputType of List in the Attributes sheet, every item in the list is a value of the attribute. Attribute values are mapped to attributes by the AttributeCode.

ProductContent

Corresponding REST API Resource: commerce/catalog/admin/products Required With: NA This template contains localized product and SEO content for locales other than the default master catalog locale. For more information about this catalog structure, see the Multi-Locale Catalogs documentation.

ProductTypes

Corresponding REST API Resource: commerce/catalog/admin/attributedefinition/producttypes Required With: ProductTypeAttributes, ProductTypeAttributeValues A product type is a template of settings and attributes you create for a specific set of products. Every product in your catalog has a single product type associated with it. The ProductTypes sheet simply specifies the usage type(s) and master catalog for the product type. You specify details for product types on the ProductTypeAttributes and ProductTypeAttributeValues sheets. A single product type can support multiple usage types. For example, a shirt can be Configurable and a Component of a larger Bundle.

ProductTypeAttributes

Corresponding REST API Resource: commerce/catalog/admin/attributedefinition/producttypes Required With: ProductTypes, ProductTypeAttributeValues Attributes are linked to products at the product type level. The ProductTypeAttributes sheet ties the attributes you define on the Attributes and AttributeValues sheets to the product types you define in the ProductTypes sheet. You must define your attributes, either on the Attributes sheet or from the UI itself, before you can connect them to product types. Multiple product types can share the same attributes.

ProductTypeAttributeValues

Corresponding REST API Resource: commerce/catalog/admin/attributedefinition/producttypes Required With: ProductTypes, ProductTypeAttributes The attribute values you specify for a given product type define what users and customers see for that product type. These values might differ from the values defined on the AttributeValues sheet. For example, your store might include a line of shirts that are only available in sizes Small, Medium, and Large. However, your Size attribute from the AttributeValues sheet has possible values of XS, S, M, L, and XL. You can still use your Size attribute for the shirts by giving them their own ProductType and only enabling the three relevant values for Size on this sheet.

CategoriesContent

Corresponding REST API Resource: commerce/catalog/admin/categories Required With: NA This template contains localized category and SEO content for locales other than the default master catalog locale. For more information about this catalog structure, see the Multi-Locale Catalogs documentation.

Categories

Corresponding REST API Resource: commerce/catalog/admin/categories Required With: NA Product categories group similar items so that you can display them together in sections on your site. Categories help you create faceted navigation for your customers. For example, Women’s Apparel can be its own category as well as a parent category of Shirts, Pants, and Dresses. Categories map to catalogs, and you can define them on the master catalog or only on a specific sub-catalog. A single product can belong to multiple categories. This template contains category content for the default master catalog locale. To define localized category content used for other locales in multi-locale catalog setups, use the CategoriesContent sheet.

CategoryImages

Corresponding REST API Resource: commerce/catalog/admin/categories Required With: NA Category images are the images associated to a product category. Images display with the category on the storefront depending on how you set up your theme. Each image includes a name, label, alt text, and other properties.

Products

Corresponding REST API Resource: commerce/catalog/admin/products Required With: ProductCatalog, ProductOptions, ProductExtras, ProductBundles, ProductImages, ProductPropertyLocale, ProductOptionsLocale, ProductContent Once you have created attributes, product types, and categories, you can add products to your store. Do not try to add products to your store before building out the catalog infrastructure that the previous tabs describe. Your products will be missing required data and the import will not work. However, once your catalog infrastructure is set, you can fill out just the product-related sheets when you are adding or updating product data. This template contains product content for the default master catalog locale. To define localized product and SEO content used for other locales in multi-locale catalog setups, use the ProductContent sheet. When you export Products, the Import-Export Application provides a Filters pane that allows you to filter which products to export based on catalog, product name, product type, price range, and other properties.

ProductPropertyLocale

Corresponding REST API Resource: commerce/catalog/admin/products Required With: Products, ProductCatalog, ProductOptions, ProductExtras, ProductBundles, ProductImages, ProductOptionsLocale This sheet allows you to specify different product property values across locales.

ProductCatalog

Corresponding REST API Resource: commerce/catalog/admin/products Required With: Products, ProductOptions, ProductExtras, ProductBundles, ProductImages, ProductPropertyLocale, ProductOptionsLocale This sheet maps product codes to catalogs within a master catalog. The ProductCode must match the product definition in the master catalog, or as specified on the Products sheet. All other data can differ from the master catalog. For example, in a specific sub-catalog, a product could belong to different categories or have different prices.

ProductBundles

Corresponding REST API Resource: commerce/catalog/admin/products Required With: Products, ProductCatalog, ProductOptions, ProductExtras, ProductImages, ProductPropertyLocale, ProductOptionsLocale This sheet defines products that are bundles, or collections of other products.

ProductOptions

Corresponding REST API Resource: commerce/catalog/admin/products Required With: Products, ProductCatalog, ProductExtras, ProductBundles, ProductImages, ProductPropertyLocale, ProductOptionsLocale The sheet defines the options, such as different sizes or colors, that a customer can select for a product. Every product option creates a variation of the base product. Note that you must upload all possible combinations of a configurable product when updating values on variants, even if all possible variants are not enabled. In addition to the columns described in the following table, the ProductOptions sheet includes columns for all the attributes you create that can be options on a product (IsOption is Yes on the Attributes sheet).

ProductExtras

Corresponding REST API Resource: commerce/catalog/admin/products Required With: Products, ProductCatalog, ProductOptions, ProductBundles, ProductImages, ProductPropertyLocale, ProductOptionsLocale This sheet defines the extras, such as monograms, warranties, and so on, that a customer can add to a product. Each product code can have multiple extras.

ProductOptionLocalization

Corresponding REST API Resource: commerce/catalog/admin/products Required With: Products, ProductCatalog, ProductExtras, ProductBundles, ProductImages, ProductPropertyLocale The sheet defines how options may differ across different locales.

ProductImages

Corresponding REST API Resource: commerce/catalog/storefront/products Required With: Products, ProductCatalog, ProductOptions, ProductExtras, ProductBundles, ProductPropertyLocale, ProductOptionsLocale This sheet maps images and videos to product codes so you can use the media on the product pages of your storefront. A single product code can have multiple images and videos associated with it. For import operations, this sheet handles file-mapping only. Use the Images sheet to upload actual image files to the CMS.

LocationTypes

Corresponding REST API Resource: commerce/catalog/admin/locationtypes Required With: NA This sheet associates product codes with location types, which you use to manage the types of locations your tenant maintains, such as warehouses, physical storefronts, and kiosks.

Locations

Corresponding REST API Resource: commerce/catalog/admin/locations Required With: NA This sheet manages physical locations associated with a tenant, so you can specify the relevant addresses, shipment types, and inventory settings for each location.

LocationGroup

Corresponding REST API Resource: commerce/catalog/admin/locationgroups This sheet describes location groups on a per-location basis.

LocationGroupConfiguration

Corresponding REST API Resource: commerce/catalog/admin/locationgroupconfiguration This sheet describes location group configurations on a per-location basis.

LocationGroupConfigurationBoxType

Corresponding REST API Resource: commerce/catalog/admin/locationgroupconfiguration This sheet describes location group box type configurations on a per-location basis.

LocationGroupConfigurationCarrier

Corresponding REST API Resource: commerce/catalog/admin/locationgroupconfiguration Required With: NA This sheet describes location group carrier configurations on a per-location basis.

LocationInventory

Corresponding REST API Resource: commerce/catalog/admin/locationinventory Required With: NA This sheet describes inventory levels on a per-location basis. Locations can be either warehouses or brick and mortar businesses with stock on-hand. This sheet associates product codes and quantities with the locations. You cannot use this sheet to create locations. Use the Locations sheet before you try to import new or updated inventory.

Images

Corresponding REST API Resources: commerce/catalog/storefront/products, commerce/catalog/storefront/categories, content/documentlists/documents Required With: NA This sheet describes all the image files that exist in the database for your tenant. You can use this sheet independent of other sheets to upload new images to your tenant. Use the ProductImages and Categories sheets to associate images with specific products or categories. Because images can be large files, uploading them can add significant time to an import operation. If you are updating products and know that you do not need to add or change media, clear this sheet prior to importing the file.