Bundle Wrapper API

The Bundle Wrapper API takes the catalog code and offerId and populates the bundle wrapper in the cache, which consists of the in-memory order line item objects used during basket operations. You must execute this API for each product offerId that you received in the response from the Catalog Profile API.

You can obtain the offerId required in the URI of this API from the result of the apiResponse.data.catalogProductRelationDetails.Product node in the response body of the Catalog Profile API.

Precondition

You must first run the Catalog Profile API to obtain the offerId required in the request body of this API.

URI

/services/apexrest/{namespace}/v3/admin/catalogs/{catalogCode}/offers/{offerId}/bundlewrapper

HTTP Method

POST

No parameters need to be passed in the POST body.

URI Parameters

If you specify just one of these two parameters, it follows the behavior described in the table below and accepts your defined time for the parameter you specified. If you are using one or both parameters, you must specify them with the same values for all of the Populate Cache APIs in this sequence.

Parameter	Example	Default	Optional/Required	Notes
effectiveStartTime	2001-07-04T12:08:56	Current date and time	Optional	effectiveStartTime is the time that you want your cached catalog entries to be effective. It should be in the UTC date-time format. Your effectiveStartTime must occur after the current time for which you are executing the Populate Cache APIs or you will receive an error message.
expirationTime	2001-07-04T12:08:56	effectiveStartTime + TimeToLive	Optional	expirationTime is the time that you want your cached catalog entries to expire. It should also be in the UTC date-time format. Your expirationTime must occur after your effectiveStartTime or you receive an error message. TimeToLive is a custom setting created in CPQ Configuration Setup. It has a default value of 30 days.

Here is an example of how to pass the URI parameters:

1GET /services/apexrest/vlocity_cmt/v3/admin/catalogs/AS-Test-Catalog/bundlewrapper?effectiveStartTime=2021-07-04T12:08:56&expirationTime=2021-08-04T12:08:56

Remote API

This is an example of how you invoke the API using Apex:

1String methodName;
2Map<String, Object> input = new Map<String, Object>();
3Map<String, Object> output = new Map<String, Object>();
4Map<String, Object> options = new Map<String, Object>();
5// Setting remote parameters
6
7methodName = 'getOfferDetailsToBundle';
8String body = '{}' ;
9
10input.put('apiName', 'CMBundleWrapper');   // required
11input.put('methodName', methodName);       // required
12input.put('catalogCode', 'mobiles');       // required
13input.put('offers', '01t4W00000BgaKvQAJ'); // required
14input.put('effectiveStartTime', null);     // optional
15input.put('expirationTime', null);         // optional
16input.put('requestBody',body);
17input.put('requestURL', '/v3/admin/catalogs/mobiles/offers/01t4W00000BgaKvQAJ/bundlewrapper'); // required
18
19//remote action invocation
20vlocity_cmt.CpqAppHandler appHandler = new vlocity_cmt.CpqAppHandler();
21appHandler.invokeMethod(methodName, input, output, options);

Parallel Invocation

You can run this API in parallel for multiple offers. For example, if there are 10 catalogs (Catalog1, Catalog2..Catalog 10) and each catalog has 100 offers, you can run this API for all 1,000 offers in parallel threads.

1THREAD1 -  GET /services/apexrest/{namespace}/v3/admin/catalogs/catalog1/offers/offer1/bundlewrapper
2THREAD2 -  GET /services/apexrest/{namespace}/v3/admin/catalogs/catalog1/offers/offer2/bundlewrapper
3......
4THREAD10 -  GET /services/apexrest/{namespace}/v3/admin/catalogs/catalog1/offers/offer10/bundlewrapper
5THREAD11 -  GET /services/apexrest/{namespace}/v3/admin/catalogs/catalog2/offers/offer11/bundlewrapper
6......
7THREAD1000 -  GET /services/apexrest/{namespace}/v3/admin/catalogs/catalog10/offers/offer/bundlewrapper

HTTP Headers

Header	Description
Content-Type	application/json

Response Body

This example shows the catalog code, offer Id, and other details.

1{
2  "cacheKey": "7d61d12269ad083e59e84a80a7c846aa",
3  "apiResponse": {
4    "assetRefIdToItemIdMap": {},
5    "bundleContextKey": null,
6    "idToXLIMap": {
7      "8024W00000BMysKQAT": {
8        "Id": "8024W00000BMysKQAT",
9        "vlocity_cmt__AssetReferenceId__c": "3cc84430-b88e-4d5f-aebf-a058bdaf0324",
10        "vlocity_cmt__CurrencyPaymentMode__c": "currency",
11        "vlocity_cmt__Action__c": "Add",
12        "vlocity_cmt__ProvisioningStatus__c": "New",
13        "UnitPrice": 0,
14        "OrderId": "8014W00000468jiQAA",
15        "Product2Id": "01t4W00000BgaKvQAJ",
16        "vlocity_cmt__Product2Id__c": "01t4W00000BgaKvQAJ",
17        "vlocity_cmt__LineNumber__c": "0001",
18        "vlocity_cmt__ProductHierarchyPath__c": "01t4W00000BgaKvQAJ",
19        "PricebookEntryId": "01u4W00000A0GdgQAF",
20        "Quantity": 1,
21        "attributes": {
22          "url": "/services/data/v51.0/sobjects/OrderItem/8024W00000BMysKQAT",
23          "type": "OrderItem"
24        }
25      }
26    },
27    "lineItemskeyMap": {},
28    "lineItemType": "OrderItem",
29    "lineKeyToAttributeShapeMap": null,
30    "lineKeyToBundleShapeMap": null,
31    "lineKeyToPromoShapeMap": null,
32    "parentLineKeyToChildLinekeys": null,
33    "promoCodeToItemIds": {},
34    "rootItemId": null,
35    "rootLineKey": null,
36    "xliIdToAppliedPromotionItemsMap": {},
37    "xliIdToPriceAdjustmentsMap": {}
38  },
39  "catalogCode": "mobiles",
40  "errorCode": "INVOKE-200",
41  "error": "OK"
42}

HTTP Response Codes

Code	Description
200	OK
500	Internal Server Error