Returns a list of groups under a Master/Enterprise (Mega) quote or order, specific for a member-type.
<!-- Section title is the name of the method followed by "Method". If appropriate, precede the method name with the class name and a colon.-->
Class
<!-- broken link-->
<!-- Link(s) to the class(es) to which this method belongs. If more than one class implements the same interface, use an itemized list. Don't use a link if the class itself isn't documented for users, but do list the class name.-->
Input Parameters
<!-- If this method has separate input and output parameters, split this section into two sections titled "Input Parameters" and "Output Parameters". Some methods of classes that implement VlocityOpenInterface2 might require an "Options Parameters" section as well.-->
| Parameter |
Required |
Description |
| parentId |
Required |
Opportunity ID. |
| contextId |
Required |
Parent cart ID (Master or Enterprise quote or order ID). |
| pageSize |
Optional: Defaults to 20 |
Page size for pagination. |
| offset |
Optional: Defaults to 0 |
Offset for pagination. |
| cartType |
Optional: Defaults to Quote |
Quote or order. |
| memberType |
Optional: Defaults to return all the types |
CPQ Group Member Type Name. For example: ServicePoint. |
| isGroupAssociatedWithCart |
Optional: Defaults to true |
True value will try to fetch and return the corresponding Group-Cart record as well. |
| searchBy |
Optional |
Sub-string to search within the group and it’s members. Returns matching search results as a response. |
Output Parameters
| Parameter |
Description |
| result |
JSONResult with Group and corresponding Cart record (If applicable). Please see sample output for details. |
Example Input Data
<!-- This is usually JSON, but it could be XML or a single value. For methods of classes implementing VlocityOpenInterface2 that have options parameters, include those here.-->
{"parentId":"0060b00000vGbYbAAK","contextId":"0Q00b000000znTYCAY","pageSize":20,"offset":0,"memberType":"ServicePoint","cartType":"Quote"}
Example Output Data
<!-- This is usually JSON, but it could be XML or a single value. Salesforce uses Return Type, but this takes care of that.-->
{"totalSize":0,"records":[{"actions":{"getGroupedServices":{"rest":{"params":{},"method":null,"link":null},"remote":{"params":{"methodName":"getGroupedServices","groupCartId":"0Q00b000000znTiCAI","offset":0,"pageSize":20,"contextId":"0Q00b000000znTYCAY","parentId":"0060b00000vGbYbAAK","groupId":"a4M0b000002CWMGEA4"}},"client":{"params":{}}},"getGroupMembers":{"rest":{"params":{},"method":null,"link":null},"remote":{"params":{"methodName":"getGroupMembers","offset":0,"pageSize":20,"contextId":"0Q00b000000znTYCAY","parentId":"0060b00000vGbYbAAK","groupId":"a4M0b000002CWMGEA4"}},"client":{"params":{}}}},"displaySequence":-1,"groupId":"a4M0b000002CWMGEA4","itemsCount":1,"groupName":"Group-1","groupCartId":"0Q00b000000znTiCAI","groupCartURL":"apex/h_cpq_ecomm__MultiServiceHybridCPQ?id=0Q00b000000znTiCAI&parentId=0060b00000vGbYbAAK&groupCart=true&groupId=a4M0b000002CWMGEA4&contextId=0Q00b000000znTYCAY&cartType=Quote","groupCart":{"attributes":{"type":"Quote","url":"/services/data/v49.0/sobjects/Quote/0Q00b000000znTiCAI"},"h_cpq_ecomm__IsPriced__c":false,"h_cpq_ecomm__IsValidated__c":false,"Id":"0Q00b000000znTiCAI","RecordTypeId":"0120b000000hxEhAAI"},"hasUnappliedGroupItems":true,"Id":{"value":"a4M0b000002CWMGEA4","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MemberCount__c":{"value":1,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__LockedBy__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"Name":{"value":"Group-1","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__Description__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MemberType__c":{"value":"ServicePoint","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MultiServiceMessageData__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__LockedFor__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__AsyncJobId__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__AsyncOperation__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__HasUnappliedGroupItems__c":{"value":true,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__GroupCartId__c":{"value":"0Q00b000000znTiCAI","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__GroupCartId__r":{"h_cpq_ecomm__IsValidated__c":false,"h_cpq_ecomm__IsPriced__c":false,"h_cpq_ecomm__TrackingNumber__c":null,"h_cpq_ecomm__MultiServiceMessageData__c":null,"h_cpq_ecomm__DefaultServicePointId__c":null}}],"data":{"groupTotalCount":1}}"masterCartId":"0Q04x000000gZbWCAU","error":"OK"}
