CatalogGroup

Use the CatalogGroup keyword to load categories, and optionally the categories description, the categories calculation code, and the parent and child category relationships.

Previously, you could load this data only in CSV formatted files. We can now load information in a CSV or XML formatted input file. Your input file must contain CSV column or XML element names and definitions that specify the characteristics of the business object type we are loading into the database.

CSV column and XML element definitions

GroupIdentifier

(String) The category identifier. This field cannot be null in Insert or Replace, and it must be unique. In Delete, either this field or the GroupUniqueId is required.

CatalogIdentifier

(String) The catalog identifier.

GroupUniqueId

(Integer) The internal unique reference number of the category. In Delete, either this field or the GroupIdentifier is required.

ParentGroupIdentifier

(String) The parent identifier of this category. Leave this column empty if this column is a top category.

ParentGroupUniqueId

(Integer) The internal unique reference number of the parent category.

ParentStoreIdentifier

(String) The identifier of the store that owns the parent category. Use this field when using the extended sites model, where the parent store is different from the store your new category is being added to.

ParentStoreUniqueId

(Integer) The internal unique reference number of the store that owns the parent category.

TopGroup

(Boolean) Indicates whether this column is a top category or a subcategory. Top categories do not have parent categories. Set the column value to be true for a top category. Set the column value to be false or null for a subcategory. Default is false. Any value other than true automatically defaults to false.

Sequence

(Decimal) An optional number used to control the order in which child categories are displayed in a parent category. This number can include decimal places, for example, 1.1. Child categories are displayed in a parent category in ascending sequence. For example, if A is 1.1 and B is 2.0, then A is displayed before B.

LanguageId

(String) The language ID for language-specific fields (Name, ShortDescription, LongDescription, Thumbnail, FullImage, Published, and Keyword). For example: -1 for English, -2 for French.

Name

(String) The language-specific display name of this category.

ShortDescription

(String) The language-specific short description of this category.

LongDescription

(String) The language-specific long description of this category.

Thumbnail

(String) The path to the language-specific thumbnail image for this category. For example, images/G1_thumbnail.jpg.

FullImage

(String) The path to the language-specific full image for this category. For example, images/G1_fullimage.jpg.

Published

(Integer) A number that indicates whether to display this category on the storefront.

1

Published – the category is displayed in the storefront.

0

Not published – the category is not displayed on the storefront.

Keyword

(String) Language-specific keywords that describe the category. Enclose multiple keywords in double quotation marks that are separated by commas, for example "keyword 1, keyword 2, keyword3".

Note

(String) A field to add language-specific footnotes or extended long descriptions for this category.

Field 1

(String) A user-defined field available for customization purposes.

Field 2

(String) A user-defined field available for customization purposes.

DiscountCalculationCode

(String) The category discount calculation code.

DiscountCalculationCodeUniqueId

(Integer) The unique reference number of the category discount calculation code.

ShippingCalculationCode

(String) The category shipping calculation code.

ShippingCalculationCodeUniqueId

(Integer) The unique reference number of the category shipping calculation code.

SalesTaxCalculationCode

(String) The category sales tax calculation code.

SalesTaxCalculationCodeUniqueId

(Integer) The unique reference number of the category sales tax calculation code.

ShippingTaxCalculationCode

(String) The category shipping tax calculation code.

ShippingTaxCalculationCodeUniqueId

(Integer) The unique reference number of the category shipping tax calculation code.

CouponCalculationCode

(String) The category coupon calculation code.

CouponCalculationCodeUniqueId

(Integer) The unique reference number of the category coupon calculation code.

SurchargeCalculationCode

(String) The category surcharge calculation code.

SurchargeCalculationCodeUniqueId

(Integer) The unique reference number of the category surcharge calculation code.

ShippingAdjustmentCalculationCode

(String) The category shipping adjustment calculation code.

ShippingAdjustmentCalculationCodeUniqueId

(Integer) The unique reference number of the category shipping adjustment calculation code.

Delete

(String) A flag that indicates whether to delete the category. Specify 1 to delete the row.