ccrz.ccLogicCartSetActive.refetch

Calls the ccrz.ccApiCart.fetch method for fetching the active cart record to include in the global API return data.

Compatibility

This reference applies to:

Release Managed Package Version API Version
B2B Commerce for Visualforce Winter ’21 4.13 12
B2B Commerce for Visualforce Spring ’20 4.12 11
B2B Commerce for Visualforce Summer ’19 4.11 10
B2B Commerce for Visualforce Spring ’19 4.10 9
B2B Commerce for Visualforce Summer ’18 4.9 8

Signature

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

Inputs (Required)

This method accepts the Map<String, Object> from the ccrz.ccLogicCartSetActive.updateActive method.

This method requires the following keys in the working map:

ccrz.ccApi.SIZING
Map<String, Object> that specifies options for how the method returns data. For this method to execute, this key must include ccrz.ccApi.SZ_REFETCH => true:
ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiCart.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_REFETCH => true
    }
}

This method respects any other data size keys specified in the original input's ccrz.ccApi.SIZING key.

Note

ccrz.ccApiCart.RESPONSE
Map<String, Object> that describes the status of the logic chain for this method, such as the current value of the ccrz.ccApi.SUCCESS return key.
ccrz.ccLogicCartSetActive.CARTID_ACTIVE
String that specifies the Salesforce ID of the active cart to query and include in the return data.
ccrz.ccLogicCartSetActive.CARTOWNER
String that specifies the ID of a specific user. Return only cart records where the Owner field matches this user ID.
ccrz.ccLogicCartSetActive.STOREFRONT
String that specifies the storefront for the cart query.

This method applies these parameters to a ccrz.ccApiCart.fetch query for returning the active cart.

Inputs (Optional)

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

ccrz.ccLogicCartSetActive.EFFECTIVEACCOUNT
String that specifies the ID of the selected effective account for the cart.

Outputs

This method returns the working Map<String, Object>, which includes the ccrz.ccApiCart.fetch outputs, and sets the following keys:

ccrz.ccApi.SUCCESS
Boolean
Value Usage
true The call completed.
false The call encountered errors.

B2B Commerce for Visualforce doesn't always return an exception for any errors that can occur. When this value is false, consider rolling back the API transaction to a previous savepoint.

Tip

ccrz.ccApiCart.CART_OBJLIST
List<Map<String, Object>>, where each Map<String, Object> represents an updated ccrz__E_Cart__c record that the ccrz.ccApiCart.fetch method returned.
  • This key is returned only when the input map specified ccrz.ccApi.SZ_REFETCH => true.
  • The ccrz.ccApiCart.fetch call can also return ccrz.ccApiAddress.ADDRESSLIST and ccrz.ccApiProduct.PRODUCTLIST keys. For more information about returning address and product data for a cart, see ccrz.ccApiCart.fetch.

Note