ccrz__E_ProductGuide__c

Compatibility

This reference applies to:

API Usage

Class used with: ccrz.ccApiProduct

Fetch sizing: The ccrz.ccApiProduct.fetch method returns the EProductGuidesS related list when you request at least a large data size for the ccrz.ccApiProduct.ENTITYNAME key in your input data:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiProduct.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.ccApiProduct.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_S,
        ccrz.ccApi.SZ_REL => New List<String>{'E_ProductGuides__r'}
    }
}

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

Fields

Display Type

Whether a buyer can select one or many products in the group and whether a buyer can modify quantities:

Single-Select

A buyer can select only one product from a group, and can't modify the quantity of the selected product before checkout.

Single-Select Quantity

A buyer can select only one product from a group, but can modify the quantity of the selected product before checkout.

Multi-Select

A buyer can select multiple products from a group, and can't modify quantities of selected products before checkout.

Multi-Select Quantity

A buyer can select multiple products from a group, but can modify quantities of selected products before checkout.

Usage	Field Name	Data Type
Input on object	ccrz__DisplayType__c	Picklist
Input or output with API (with any data size)	displayType	String

Product

The dynamic kit that the product guide applies to.

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 Guide Auto Number

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

Product Guide Auto Number

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

Usage	Field Name	Data Type
Input on object	ccrz__ProductGuideId__c	Text (10)
Input or output with API (with any data size)	productGuideId	String

Related Product Group

The related product group that the product guide applies to.

Usage	Field Name	Data Type
Input on object	ccrz__RelatedProductGroup__c	Lookup Relationship (ccrz__E_RelatedProductGroup__c)
Input or output with API (with any data size)	relatedProductGroup	ID

Required

Whether a buyer must select a product from the product group.

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

Sequence

The order of the product guide among all product guides shown on a dynamic kit's Product Detail page. Lower Sequence values display first.

Usage	Field Name	Data Type
Input on object	ccrz__Sequence__c	Number (18, 0)
Input or output with API (with any data size)	sequence	Integer