ccrz__E_ProductIndex__c

Compatibility

This reference applies to:

API Usage

Class used with: ccrz.ccApiProductIndex

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

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiProductIndex.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 product index record is up-to-date and available for the Product List page to reference. This field supports product index batch jobs. Records that the Product List page 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_L or larger)	active	Boolean

Category

The category that the product is assigned to.

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__Category__c	Text (255)
Input or output with API (with SZ_L or larger)	category	ID

Category End Date

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

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__CategoryEndDate__c	Date
Input or output with API (with SZ_L or larger)	categoryEndDate	Date

Category Start Date

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

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__CategoryStartDate__c	Date
Input or output with API (with SZ_M or larger)	categoryStartDate	Date

CC Product 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 SZ_S or larger)	sfid	String

Filter Data

A spec and product spec value.

Usage	Field Name	Data Type
Input on object	ccrz__FilterData__c	Text Area (Long) (32768)
Input or output with API	The API doesn't return data for this field.

Index Currency

The currency code for the index price. When you use a primary index for all currencies, this field's value is GLOBAL and doesn't specify a currency.

Usage	Field Name	Data Type
Input on object	ccrz__IndexCurrency__c	Text (255)
Input or output with API (with SZ_L or larger)	indexCurrency	String

Index Price

The lowest price for the product, based on all price lists assigned to the product. This field is used only for sorting on the Product List Page, and doesn't apply to any other pricing functionality.

Usage	Field Name	Data Type
Input on object	ccrz__IndexPrice__c	Text (255)
Input or output with API (with SZ_M or larger)	indexPrice	String

Index Type

U0VBUkNI, the Base64-encoded value for the string Search.

B2B Commerce for Visualforce requires this format for identifying products assigned to multiple categories and ensuring that products appear only once in a search. When a product index record specifies U0VBUkNI for its Index Type, that product index is the record returned in search results.

Note

If you extend this field to support other values, make sure that you leave the default value U0VBUkNI unchanged.

Warning

Usage	Field Name	Data Type
Input on object	ccrz__IndexType__c	Text (255)
Input or output with API (with SZ_L or larger)	indexType	String

Last Index

Whether this product index record is the final record created for all the price lists that apply to a product.

The total number of entitled price lists can sometimes exceed the available length of the Price Lists field. In that case, the product index batch job creates another record for the overflow price lists, and sets this field on the overflow record.

Note

Usage	Field Name	Data Type
Input on object	ccrz__LastIndex__c	Checkbox
Input or output with API (with SZ_L or larger)	lastIndex	Boolean

Locale

The locale that the product index record applies to.

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

Long Description

A long description for the product.

Usage	Field Name	Data Type
Input on object	ccrz__LongDescription__c	Text Area (Long) (5000)
Input or output with API	The API doesn't return data for this field.

Price Lists

Price list IDs, separated by a space, that are assigned to the product.

Usage	Field Name	Data Type
Input on object	ccrz__PriceLists__c	Text Area (Long) (131072)
Input or output with API (with SZ_L or larger)	priceLists	String

Product

The product that the product index record applies to.

Usage	Field Name	Data Type
Input on object	ccrz__Product__c	Lookup Relationship (ccrz__E_Product__c)
Input or output with API (with SZ_S or larger)	product	ID

Product Category

The category assignment for the product. The Product List page uses this reference to sort products by the Sequence value of each product's CC Product Category related record.

Usage	Field Name	Data Type
Input on object	ccrz__ProductCategory__c	Lookup Relationship (ccrz__E_ProductCategory__c)
Input or output with API (with SZ_M or larger)	productCategory	ID

Product Category End Date

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

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__ProductCategoryEndDate__c	Date
Input or output with API (with SZ_L or larger)	productCategoryEndDate	Date

Product Category Sequence

Order of the product within the category, relative to other products assigned to the same category. Lower values display first.

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

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

Product Category Start Date

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

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__ProductCategoryStartDate__c	Date
Input or output with API (with SZ_L or larger)	productCategoryStartDate	Date

Product End Date

The last day that the product is available on the storefront.

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__ProductEndDate__c	Date
Input or output with API (with SZ_L or larger)	productEndDate	Date

Product Name

The product's name, localized for the product index record's locale.

Usage	Field Name	Data Type
Input on object	ccrz__ProductName__c	Text (255)
Input or output with API (with SZ_M or larger)	productName	String

Product Start Date

The first day that the product is available on the storefront.

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__ProductStartDate__c	Date
Input or output with API (with SZ_M or larger)	productStartDate	Date

Product Status

The product's visibility on the storefront. For supported values, see https://help.salesforce.com/articleView?id=b2b_commerce_product_create.htm.

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__ProductStatus__c	Text (255)
Input or output with API (with SZ_L or larger)	productStatus	String

SEO Keywords

Comma-separated list of the product's search keywords. For usage, see https://help.salesforce.com/articleView?id=b2b_commerce_seo_product_category.htm.

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

Short Description

The product's short description, localized for the product index record's locale.

Usage	Field Name	Data Type
Input on object	ccrz__ShortDescription__c	Text Area (Rich) (2000)
Input or output with API (with SZ_L or larger)	shortDescription	String

SKU

The product's SKU, localized for the product index record's locale.

Usage	Field Name	Data Type
Input on object	ccrz__SKU__c	Text (100)
Input or output with API (with SZ_L or larger)	SKU	String

Storefront

The storefront where the product is available.

This field is available only in B2B Commerce for Visualforce Summer '19 (version 4.11) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__Storefront__c	Picklist (Multi-select)
Input or output with API (with SZ_L or larger)	storefront	String