Reference > Data load utility CSV column definitions
Catalog group
Use the CatalogGroup keyword to load categories, and optionally the categories description, the categories calculation code, and the parent and child category relationships into the database using a CSV file. The CSV file contains column definitions specifying the characteristics of the catalog business object type.
CSV file column 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.
- 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 empty for top-level 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 the new category is being added to.
- ParentStoreUniqueId
- (Integer) The internal unique reference number of the store that owns the parent category.
- TopGroup
- (Boolean) Indicates if this is a top-level category, meaning there are not parent categories.
- TRUE
- top-level category
- FALSE or blank
- subcategory
- Sequence
- (Decimal) An optional number used to control the order in which child categories are displayed in a parent category.
- LanguageId
- (String) The language ID for language sensitive fields (Name, ShortDescription, LongDescription, Thumbnail, FullImage, Published and Keyword). For example: -1 for English, -2 for French.
- Name
- (String) The language sensitive display name of this category.
- ShortDescription
- (String) A language sensitive short description of this category.
- LongDescription
- (String) A language sensitive long description of this category.
- Thumbnail
- (String) The language sensitive thumbnail image path of this category. Use forward slashes (/) in the path, for example images/G1.jpg.
- FullImage
- (String) The language sensitive full image path of this catalog. The forward slash '/' should be used in the path. Do not use backward slash '\'. For example, images/G1.jpg .
- Published
- (Integer) The language sensitive value that determines whether to display this category on the storefront.
- 1
- Published. The default value. The category is displayed in the storefront.
- 0
- Not published
- Keyword
- (String) A language sensitive keyword used for searching. Enclose multiple keywords in double quotation marks separated by commas, for example "keyword 1, keyword 2, keyword3".
- Note
- (String) Use this field to add language sensitive 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.
- ShipCalculationCode
- (String) The category shipping calculation code.
- ShipCalculationCodeUniqueId
- (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.
- ShipTaxCalculationCode
- (String) The category shipping tax calculation code.
- ShipTaxCalculationCodeUniqueId
- (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.
- ShipAdjustmentCalculationCode
- (String) The category shipping adjustment calculation code.
- ShipAdjustmentCalculationCodeUniqueId
- (Integer) The unique reference number of the category shipping adjustment calculation code.
- Delete
- (String) Indicates whether to delete. If you are performing a delete operation, specify this column. A value of "1" indicates that the row should be deleted.