ccrz__E_Category__c

Compatibility

This reference applies to:

API Usage

Class used with: ccrz.ccApiCategory

Fetch sizing: To specify which fields the ccrz.ccApiCategory.fetch method returns for each category record, request a specific data size for the ccrz.ccApiCart.ENTITYNAME key in your input data:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiCategory.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_L
    }
}

The reference for each field indicates which data size the field is returned with.

Fields

Category ID

A unique ID that associates the record with an external system.

Usage	Field Name	Data Type
Input on object	ccrz__CategoryID__c	Text (128)
Input or output with API (with SZ_S or larger)	categoryID	String

Category Name

The name to show on the storefront for the category.

Usage	Field Name	Data Type
Input on object	Name	Text (80)
Input or output with API (with SZ_S or larger)	sfdcName	String

Child Category Count

By default, the managed package doesn't use this field.

Usage	Field Name	Data Type
Input on object	ccrz__ChildCategoryCount__c	Number (4, 0)
Input or output with API (with SZ_L or larger)	childCategoryCount	String

Data ID

The managed package only uses this field internally. Your subscriber code's unit tests developed with the ccrz.ccApiTestData class can also reference this field.

Usage	Field Name	Data Type
Input on object	ccrz__DataId__c	Text (255)
Input or output with API (with any data size)	The API doesn't return data for this field.

End Date

The last day when the category is available on the storefront.

Usage	Field Name	Data Type
Input on object	ccrz__EndDate__c	Date
Input or output with API (with SZ_XL)	endDate	Date

Long Description

By default, the managed package doesn't use this field.

Usage	Field Name	Data Type
Input on object	ccrz__LongDescRT__c	Text Area (Rich) (5000)
Input or output with API (with SZ_M or larger)	longDesc	String

Parent Category

The parent category for the current category.

Usage	Field Name	Data Type
Input on object	ccrz__ParentCategory__c	Lookup Relationship (ccrz__E_Category__c)
Input or output with API (with SZ_L or larger)	parentCategory	ID

Product Count

Formula that calculates the number of products assigned to the current category.

Usage	Field Name	Data Type
Input on object	ccrz__ProductCount__c	Roll-Up Summary (COUNT ccrz__E_ProductCategory__c)
Input or output with API (with SZ_L or larger)	productCount	Integer

SEO ID

A unique, URL-safe string (up to 255 characters) for the category's friendly URL path. For usage, see https://help.salesforce.com/articleView?id=b2b_commerce_seo_product_category.htm.

The SEO ID field doesn't support the following special characters:

Tip

Usage	Field Name	Data Type
Input on object	ccrz__SEOId__c	Text (255)
Input or output with API (with SZ_S or larger)	SEOId	String

Sequence

Order of the category under the parent category, relative to other categories assigned to the same parent category. Lower values display first.

Usage	Field Name	Data Type
Input on object	ccrz__Sequence__c	Number (8, 0)
Input or output with API (with SZ_M or larger)	sequence	Integer

Short Description

The description for the category that displays on the Product List page. For usage, see https://help.salesforce.com/articleView?id=b2b_commerce_page_product_list_subcategory.htm.

Usage	Field Name	Data Type
Input on object	ccrz__ShortDescRT__c	Text Area (Rich) (2000)
Input or output with API (with SZ_M or larger)	shortDesc	String

Start Date

The first day when the category is available on the storefront.

Usage	Field Name	Data Type
Input on object	ccrz__StartDate__c	Date
Input or output with API (with SZ_XL)	startDate	Date

Deprecated Fields

The following fields exist on the object but aren't used by the managed package. Don't use these fields in any development or customization.

Related Lists

A record of the ccrz__E_Category__c object can have multiple related lists that relate the category to other types of records, such as product assignments or category media. The ccrz.ccApiCategory.fetch method can return data from these related records, depending on the requested data size in the input map.

The reference for each related list indicates which data size the list is returned with by default. You can also use the ccrz.ccApi.SZ_REL flag in your input map to request a particular list, regardless of requested data size:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiCategory.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_S,
        ccrz.ccApi.SZ_REL => New List<String>{'Category_Medias__r'}
    }
}

categoryMediasS

List<Map<String, Object>> of ccrz__E_CategoryMedia__c.

Consideration	Value
Default data size returned with	SZ_L or larger
ccrz.ccApi.SZ_REL request value	Category_Medias__r

productCategoriesS

List<Map<String, Object>> of ccrz__E_ProductCategory__c.

Consideration	Value
Default data size returned with	SZ_M or larger
ccrz.ccApi.SZ_REL request value	Product_Categories__r