ccrz__E_ProductCategory__c

Compatibility

This reference applies to:

API Usage

Class used with: ccrz.ccApiCategory

Fetch sizing: The ccrz.ccApiCategory.fetch method returns the productCategoriesS related list when you request at least a large data size for the ccrz.ccApiCategory.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
    }
}

To request this related list even with a smaller data size, add the ccrz.ccApi.SZ_REL key to your input map:

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>{'Product_Categories__r'}
    }
}

Each record returned in this list always includes the same fields, regardless of the requested data size.

Fields

Category

The category assigned to the product.

Usage	Field Name	Data Type
Input on object	ccrz__Category__c	Master-Detail Relationship (ccrz__E_Category__c)
Input or output with API (with any data size)	category	ID

End Date

The last day that the product's category assignment is active on the storefront.

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

Product

The product with the assigned category.

Usage	Field Name	Data Type
Input on object	ccrz__Product__c	Master-Detail Relationship (ccrz__E_Product__c)
Input or output with API (with any data size)	product	ID

Product Category Id

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

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

ProductCatAutoNumber

A unique, automatically assigned ID for the record.

Usage	Field Name	Data Type
Input on object	Name	Auto Number
Input or output with API (with any data size)	sfdcName	String

Sequence

Order of the product within the category, relative to other products assigned to the same 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 any data size)	sequence	Integer

Start Date

The first day that the product's category assignment is active on the storefront.

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

Canonical Path

Whether the assigned category is the authoritative category for search engine optimization. For usage, see https://help.salesforce.com/articleView?id=b2b_commerce_seo_product_category.htm.

Usage	Field Name	Data Type
Input on object	ccrz__IsCanonicalPath__c	Checkbox
Input or output with API (with any data size)	isCanonicalPath	Boolean