File format for uploading catalog data

WebSphere Commerce provides sample files for uploading catalog business objects, such as categories, catalog entries, and attribute dictionary attributes. Use the samples as a starting point to create our own CSV files so that you follow the correct data format.

We can also load this data in XML format. If you choose to create and use an XML formatted file, ensure that your file uses the CSV column names as the XML element names.

When we are creating your CSV or XML file, ensure that you follow the tips and recommendations for CSV and XML files included in Data Load utility best practices.


Catalog business object keywords and column definitions

The following table lists the catalog business object types available for use.

Note: The sample files do not include all the available column or element names for the catalog business object types. For a complete list of the available columnor element names for the catalog business object types, see Data Load utility CSV column and XML element definitions.

To upload... Keyword with CSV column and XML element definitions Sample input file
Master or sales catalog, and optionally its description. Catalog CSV

XML

Catalog descriptions in multiple languages. CatalogDescription CSV

Categories, optionally the categories description, and the parent and child category relationships. CatalogGroup CSV

XML

Merchandising associations between categories. CatalogGroupAssociation CSV

Category descriptions (language-dependent). CatalogGroupDescription CSV

Parent-child relationship between categories. CatalogGroupRelationship CSV

Catalog entries such as products, SKUs, bundle or kits, and optionally the catalog entries description. Also the product and SKU relationships. CatalogEntry CSV

XML

Merchandising associations between catalog entries. CatalogEntryAssociation CSV

Multiple relationships between the parent kit (package, bundle, and dynamic kit) and its child catalog entries CatalogEntryComponent CSV

Catalog entry descriptions (language-dependent). CatalogEntryDescription CSV

(Enterprise) Catalog entry description overrides - this CSV creates catalog entry descriptions specific for an extended site store by overriding inherited asset store catalog entry descriptive information. (Enterprise) CatalogEntryDescriptionOverride (Enterprise) CSV

XML

Descriptive attributes and values for a product or SKU (non-attribute dictionary). CatalogEntryDescriptiveAttributeAndValue CSV

Catalog entry offer price. CatalogEntryOfferPrice CSV

Parent-child relationships between categories and catalog entries. CatalogEntryParentCatalogGroupRelationship CSV

Product and SKU relationships between catalog entries. CatalogEntryParentProductRelationship CSV

Updates to catalog entries. When you specify this keyword, the Catalog Upload updates only the new or changed information. The remaining catalog entry information is not changed during the upload operation.

For example, use this keyword to update only the name for a catalog entry and do not want to change any other information.

You do not need to include values for every field in your input file. The upload process does not change any field that does not include a value in the input file.

CatalogEntryUpdate

When you specify this keyword, we can include values for the same catalog entry information that can be included in a file that uses the keyword CatalogEntry.

CSV

Updates to catalog entry descriptions. When you specify this keyword, the Catalog Upload updates only the new or changed information. The remaining descriptive information for the catalog entry does not change during the upload operation.

For example, use this keyword to update only the short description for a catalog entry and do not want to change any other information.

You do not need to include values for every field in your input file. The upload process does not change any field that does not include a value in the input file.

CatalogEntryDescriptionUpdate

When you specify this keyword, we can include values for the same catalog entry descriptive information that can be included in a file that uses the keyword CatalogEntryDescription.

CSV

Attribute and allowed values for products (non-attribute dictionary). ProductDefiningAttributeAndAllowedValues CSV

Attribute value for SKUs (non-attribute dictionary). SKUDefiningAttributeValue CSV

Attribute dictionary attribute and allowed values. AttributeDictionaryAttributeAndAllowedValues CSV

XML

Attribute dictionary attributes allowed values (in other national languages). AttributeDictionaryAttributeAllowedValues CSV

XML

Attribute dictionary attribute value for SKUs. CatalogEntryAttributeDictionaryAttributeRelationship CSV

XML

Attribute dictionary attribute and attribute folder relationship

Note: The attribute and the folder must exist within your system before we can load this relationship.

AttributeDictionaryAttributeFolderRelationship CSV

XML

We can also upload the following catalog business object types. However, the business objects are not visible within the Catalogs tool unless your business customizes the Management Center to display these business objects.
Catalog entry search engine optimization (SEO) URL and page information. CatalogEntrySEO CSV

Category search engine optimization (SEO) URL and page information. CatalogGroupSEO CSV

Catalog entry calculation code. There are calculation codes for different calculation usages. The provided calculation usages include discount, shipping, sales tax, shipping tax, coupon, surcharge, and shipping adjustment. (Enterprise)

Note: In an extended sites model, we must load catalog calculation codes into the appropriate asset store.

  • Catalog calculation codes are stored in the Storefront Asset store.

CatalogEntryCalculationCode CSV

Category calculation code. There are calculation codes for different calculation usages. The provided calculation usage includes discount, shipping, sales tax, shipping tax, coupon, surcharge, and shipping adjustment. (Enterprise)

Note: In an extended sites model, we must load catalog calculation codes into the appropriate asset store.

  • Catalog calculation codes are stored in the Storefront Asset store.

CatalogGroupCalculationCode CSV

Catalog entry inventory (non-ATP). CatalogEntryInventory CSV

XML

Catalog entry inventory (ATP). CatalogEntryATPInventory CSV

XML

Notes:


Related concepts
Catalog Upload