Cart wrapper and CartItemWrapper interface provides minimum viable functionalities to operate on cart and cart items. Use these interfaces to add your own custom steps in the pricing plan steps.
CartItemWrapper Interface:
To work with the Cart Wrapper interface:
Get the cart wrapper instance for CpqCart or CpqCartDocument using the method:
Do not use the same instance of CpqCartDocument for every pricing step. For each step, get the instance using the method mentioned below.
Note
1**For CpqCart
2CartWrapper wrapper = (CartWrapper)PricingPlanService.getFromPricingContext('Parent');
3
4** For CpqCartDocument
5CartWrapper wrapper = (CartWrapper)input.get('cartDocument');Call the Item wrapper APIs using the wrapper.call(methodName, args).
The Below table lists the supported methods for CpqCart:Item
| Method Name | Arguments | Description |
|---|---|---|
| CpqConstants.GET_CART_FIELD | CpqConstants.FIELD | Method to get the fields of the order. |
| CpqConstants.SET_CART_FIELD | CpqConstants.FIELD, CpqConstants.VALUE | Method to set the order field value. |
| CpqConstants.GET_SOBJECT_TYPE | Method to get the SObjectType of the underlying cart. | |
| CpqConstants.GET_ITEM_IDS | Method to get the item ids. | |
| CpqConstants.GET_ALL_ITEMS | CpqConstants.HIERARCHY_LEVEL(optional: -1 full hierachy) | Method to get all the line items. |
| CpqConstants.GET_CHILD_ITEMS | CpqConstants.ITEM_ID | Method to get all the child line items. |
| CpqConstants.DELETE_LINE_ITEM | CpqConstants.ITEM_ID | Method to delete a line item. |
To work with the the CartItem Wrapper interface:
The line items present in the basket can be accessed using the wrapper class of CpqCartDocumentItem or CpqCartItem. Get the cart wrapper instance for CpqCart or CpqCartDocument using the method:
1**For CpqCartItem
2Map<String, Object> result = wrapper.call('getAllItems', null);
3Map<Id, CartItemWrapper> allItems = (Map<Id, CartItemWrapper>) result.get(CpqConstants.RESULT);
4
5** For CpqCartDocumentItem
6 Map<String, Object> result = wrapper.call('getAllItems', null);
7Map<String, CartItemWrapper> allItems = (Map<String, CartItemWrapper>) result.get(CpqConstants.RESULT);Call the wrapper APIs using the wrapper.call(methodName, args).
the below table lists the supported methods for CpqCart:
| Method Name | Arguments | Description |
|---|---|---|
| CpqConstants.GET_ITEM_FIELD | CpqConstants.FIELD | Method to get an item field, or a field from the item’s related SObjects. |
| CpqConstants.SET_ITEM_FIELD | CpqConstants.FIELD, CpqConstants.VALUE | Method to set the value of an item field. |
| CpqConstants.GET_SOBJECT_TYPE | Method to get the SObjectType of the underlying cartitem. | |
| CpqConstants.GET_ITEM_FIELDS | CpqConstants.FIELDS | Method to get multiple item fields. |
| CpqConstants.SET_ITEM_FIELDS | CpqConstants.FIELD_VALUE_MAP | Method to set multiple item fields. |
| CpqConstants.GET_ITEM_ATTRIBUTES | CpqConstants.FLATTENED_ATTRIBUTE_VALUES), CpqConstants.USE_DISPLAY_TEXT_FOR_VALUES | Method to get the attribute node of the item. There are 2 parameters according to which the attribute nodes are returned. |
| CpqConstants.SET_ITEM_ATTRIBUTES | CpqConstants.ATTRIBUTE_CODE_TO_VALUE_MAP | Method to set the item attributes. |
| CpqConstants.GET_CHILD_ITEM_IDS | Method to get the child item ids. |
Sample Code
Note
1// namespace.className managed package
2
3global inherited sharing class CustomPricingPlanImplementation implements VlocityOpenInterface {
4
5 global boolean invokeMethod(String methodName, Map<String, Object> input, Map<String, Object> output, Map<String, Object> options) {
6
7 if (methodName == 'testV2CustommPricingPlanImpl'){
8 testV2CustomPricingPlan(input, output, options);
9 }
10 if (methodName == 'testV3CustommPricingPlanImpl'){
11 testV3CustomPricingPlan(input, output, options);
12 }
13 return true;
14 }
15
16 private void testV2CustomPricingPlan(Map<String, Object> input, Map<String, Object> output, Map<String, Object> options) {
17 Map<String, Object> args = new Map<String, Object>();
18
19
20 CartWrapper wrapper = (CartWrapper)PricingPlanService.getFromPricingContext('Parent');
21 Map<String, Object> result = wrapper.call('getAllItems', null);
22 if(result.containsKey(CpqConstants.RESULT)){
23
24 Map<Id, CartItemWrapper> allItems = (Map<Id, CartItemWrapper>) result.get(CpqConstants.RESULT);
25 for(Id itemId : allItems.keySet()) {
26 CartItemWrapper itemWrapper = allItems.get(itemId);
27
28 // args.put(CpqConstants.FIELD, 'vlocity_lwc8__ItemName__c');
29 // args.put(CpqConstants.VALUE, 'DummyName');
30
31 args.put(CpqConstants.FIELD, 'vlocity_lwc8__EffectiveRecurringTotal__c'); //
32 args.put(CpqConstants.VALUE, 205);
33
34 itemWrapper.call(CpqConstants.SET_ITEM_FIELD, args);
35
36 }
37
38 }
39
40 }
41
42 private void testV3CustomPricingPlan(Map<String, Object> input, Map<String, Object> output, Map<String, Object> options) {
43 Map<String, Object> args = new Map<String, Object>();
44
45
46 CartWrapper wrapper = (CartWrapper)input.get('cartDocument');
47 Map<String, Object> result = wrapper.call('getAllItems', null);
48 if(result.containsKey(CpqConstants.RESULT)){
49
50 Map<String, CartItemWrapper> allItems = (Map<String, CartItemWrapper>) result.get(CpqConstants.RESULT);
51 for(String itemId : allItems.keySet()) {
52 CartItemWrapper itemWrapper = allItems.get(itemId);
53
54 // args.put(CpqConstants.FIELD, 'vlocity_lwc8__ItemName__c');
55 // args.put(CpqConstants.VALUE, 'DummyName');
56
57 args.put(CpqConstants.FIELD, 'vlocity_lwc8__EffectiveRecurringTotal__c'); //
58 args.put(CpqConstants.VALUE, 205);
59 itemWrapper.call(CpqConstants.SET_ITEM_FIELD, args);
60
61 }
62
63 }
64 Map<String, Object> args1 = new Map<String, Object>();
65 args.put(CpqConstants.FIELD, 'vlocity_lwc8__EffectiveRecurringTotal__c');
66 args.put(CpqConstants.VALUE, 410);
67
68 wrapper.call(CpqConstants.SET_CART_FIELD, args);
69
70 }
71
72}
j