ccrz.ccLogicProductFind.performProductFind

Compatibility

This reference applies to:

Signature

global virtual Map<String, Object> performProductFind(Map<String, Object>)

Inputs (Required)

This method accepts the working Map<String, Object> after the ccrz.ccLogicProductFind.processInput method completes.

This method requires one of the following keys in the working map:

ccrz.ccApiProduct.CATEGORY_IDS

Set<String> of specific category IDs whose assigned products you want to return and price.

ccrz.ccService.SEARCHSTRING

String to use for searching product records, and whose results you want to return and price.

Inputs (Optional)

If the working map includes the following keys, this method evaluates them:

ccrz.ccApiProduct.CURRENT_INDEX

Map<String, Object> that specifies the product index information for the product to use as a starting point.

Map<String, Object> findProductsStartingFrom = new Map<String, Object> {
  primary => 'String of product's sfdcName',
  secondary => CC Product Index record ID
}

ccrz.ccApiProduct.INCLUDE_COUNT

Boolean

Value	Usage
true	Return the total count of products, keyed under ccrz.ccApiProduct.COUNT.
false (default)	Don’t return product count.

ccrz.ccApiProduct.PRODUCT_FILTERS

List<Map<String, Object>>, where each Map<String, Object> specifies spec values to filter products by.

ccrz.ccApiProduct.PRODUCT_LIMIT

Integer that specifies the maximum number of product IDs to return.

If you specify a lower limit than the actual number of results, the return data includes the index information for the next indexed product. For example, if you specify a limit of five, the return data includes the index information for the sixth product that matches the find criteria.

Note

ccrz.ccApiProduct.PRODUCTLOCALE

String that specifies one of your storefront's supported locales. The method returns internationalized product values in the ccrz.ccApiProduct.PRODUCTLIST return key. The service layer translates the values from ccrz__E_ProductItemI18N__c records and handles fallback languages, if necessary.

If the input data doesn't include this key, the method falls back to ccrz.cc_CallContext.userLocale.

Note

ccrz.ccApiProduct.PRODUCTSTOREFRONT

String that specifies the name of a storefront for filtering the query.

If the input data doesn't include this key, the method falls back to ccrz.cc_CallContext.storefront.

Note

ccrz.ccService.ORDERBY

String that specifies the field to order results by. Possible values include:

• ccrz.ccApiProductIndex.BY_NAME
• ccrz.ccApiProductIndex.BY_PRICE
• ccrz.ccApiProductIndex.BY_START_DATE
• ccrz.ccApiProductIndex.BY_RELEVANCE
• ccrz.ccApiProductIndex.BY_SEQUENCE (default)

ccrz.ccService.SORTDESC

Boolean

Value	Usage
true	Sort returned products by the field that the ccrz.ccService.ORDERBY key specifies, in descending order.
false (default)	Sort returned products in ascending order.

Logic Performed

This method passes the input keys to ccrz.ccApiProductIndex.fetchEntitled, and parses that method's output.

Outputs

This method returns the working Map<String, Object>, including the ccrz.ccApiProductIndex.fetchEntitled outputs.