ccrz__E_SiteIndex__c

Compatibility

This reference applies to:

API Usage

Class used with: ccrz.ccApiSiteIndex

Field sizing: To specify which fields the API returns for each site index record, request a specific data size for the ccrz.ccApiSiteIndex.ENTITYNAME key in your input data:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiSiteIndex.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

Active

Whether this site index record is up-to-date and available for the storefront to reference. This field supports site index batch jobs. Records that the storefront currently uses remain active while the batch job creates updated records.

Usage	Field Name	Data Type
Input on object	ccrz__Active__c	Checkbox
Input or output with API (with SZ_S or larger)	active	Boolean

Breadcrumb

JSON data that represents the breadcrumb path for the category and any of its parent categories. For example, the following breadcrumb JSON data describes the Medium category in the Capricorn Coffee demo storefront data. The breadcrumb data includes details for the Medium category and its parent category, Coffee.

[
    {
        "friendlyUrl":"/Coffee/Medium",
        "category":{
            "sfid":"a0M3h0000007LjGEAU",
            "name":"Medium"
        }
    },
    {
        "category":{
            "name":"Coffee",
            "sfid":"a0M3h0000007LjAEAU"
        },
        "friendlyUrl":"/Coffee"
    }
]

For information about how the breadcrumbs appear on the storefront, see Show the Breadcrumb Widget.

Usage	Field Name	Data Type
Input on object	ccrz__Breadcrumb__c	Text Area (Long) (30000)
Input or output with API (with SZ_M or larger)	breadcrumb	String

Category

The category that the site index record describes.

Usage	Field Name	Data Type
Input on object	ccrz__Category__c	Lookup Relationship (ccrz__E_Category__c)
Input or output with API (with SZ_S or larger)	category	ID

CC Site Index Name

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)	The API doesn't return data for this field.

Friendly URL

The category's friendly URL path.

Usage	Field Name	Data Type
Input on object	ccrz__FriendlyURL__c	Text Area (Long) (5000)
Input or output with API (with SZ_S or larger)	friendlyURL	String

Friendly URL Hash

The result of passing the Friendly URL value through the Apex String.hashCode method. The hashed value allows for efficiently querying records by friendly URL values.

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

Locale

The locale that the site index record applies to.

Usage	Field Name	Data Type
Input on object	ccrz__Locale__c	Text (25)
Input or output with API (with SZ_S or larger)	locale	String

Site Index Id

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

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

Storefront

The storefront that the site index record applies to.

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