ccrz.ccApiPriceList.fetchEntitled

Compatibility

This reference applies to:

Signature

global static Map<String, Object> fetchEntitled(Map<String, Object>)

Service Layer Classes

Logic Service Provider

ccrz.ccLogicPLEntLists

Inputs (Required)

Map<String, Object> that must include the following required keys:

ccrz.ccApi.API_VERSION

The version of the B2B Commerce for Visualforce API to reference for the method call. We recommend that you use the ccrz.ccApi.CURRENT_VERSION constant whenever possible, and only reference a specific version for compatibility if necessary.

If this key isn't specified, the method returns a ccrz.ccApi.NoApiVersionException.

Note

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApi.SIZING

Map<String, Object> that specifies the scope of data that this method returns. To return the price list and price list item records that correspond to the entitled price list IDs, include ccrz.ccApi.SZ_REFETCH => true in this key's map.

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiPriceList.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_REFETCH => true
    }
}

ccrz.ccApiPriceList.ALLWMIX

Boolean

Value	Usage
true	Allow mixed pricing queries when you filter by price group. The method tries to match the specified price group when returning price list records. If a price group match isn't available, the method falls back to the specified account's account group.
false (default)	Don't allow mixed pricing queries when you filter by price group. The method only tries to match the specified price group when returning price list records.

If this key isn't specified in the input data, the method falls back to the value of the ccrz__E_AccountSettings__c.ccrz__AllowMixedPricingCarts__c field.

ccrz.ccApiPriceList.CURRCODE

String that specifies an ISO 4217 currency code, such as USD or JPY.

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

Note

ccrz.ccApiPriceList.EFFACCTID

String that specifies an account ID record to filter entitled price lists by. The method returns only the price list records that are assigned to the specified account's account group.

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

Note

ccrz.ccApiPriceList.EFFDATE

Date to filter price lists by. The method returns only the price list records where the date is included in the Start Date and End Date range.

If the input data doesn't include this key, the method falls back to the current date.

Note

ccrz.ccApiPriceList.PRGRID

String that specifies a price group ID record to filter price lists by.

If you don't include this key, the method falls back to ccrz.cc_CallContext.priceGroupId.

Note

ccrz.ccApiPriceList.STOREFRONT

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

Outputs

Map<String, Object> that can include the following keys:

ccrz.ccApi.API_VERSION

Integer that indicates which API version was used for the query.

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.ccApiPriceList.PLIDS

Map<String, Set<String>> keyed by:

• ccrz.ccApiPriceList.PGPLIDS for price lists entitled by price group
• ccrz.ccApiPriceList.ACCTGRPPLIDS for price lists entitled by account group

ccrz.ccApiPriceList.PRICELISTS

Map<String, Map<String,Object>> keyed by the IDs of the entitled price lists.

This key is returned only when the input map includes ccrz.ccApi.SZ_REFETCH => true.

Note

ccrz.ccApiPriceList.PRICELISTITEMS

Map<String, Map<String,Object>> keyed by the IDs of the price list items that belong to the price lists in ccrz.ccApiPriceList.PRICELISTS.

This key is returned only when the input map includes ccrz.ccApi.SZ_REFETCH => true.

Note