Promotion Wrapper API

The Promotion Wrapper API takes the promotion Id (offerId) as input in the URI and populates the promotion wrapper in the cache. You must execute this API for each Promotion offerId that you received in the response of the Catalog Profile API. The promotion Wrapper API is required if you have promotions.

If you are not using any promotions in your catalog, you do not need to perform this API call.

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

Precondition

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

URI

/services/apexrest/{namespace}/v3/admin/offers/{offerId}/promotionWrapper

HTTP Method

GET

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/promotionWrapper?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;
2
3Map<String, Object> input = new Map<String, Object>();
4Map<String, Object> output = new Map<String, Object>();
5Map<String, Object> options = new Map<String, Object>();
6
7// Setting remote parameters
8methodName = 'getPromotionWrapper';
9input.put('methodName', methodName);        // required
10input.put('apiName', 'CMPromotionWrapper'); // required
11input.put('offers', 'a3S4W000002aAUhUAM');  // required
12input.put('effectiveStartTime', null);      // optional
13input.put('expirationTime', null);          // optional
14input.put('requestURL', '/v3/admin/offers/01t4W00000BgaKvQAJ/promotionWrapper'); // required
15
16//remote action invocation
17vlocity_cmt.CpqAppHandler appHandler = new vlocity_cmt.CpqAppHandler();
18appHandler.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/offers/offer1/promotionwrapper
2THREAD2 -  GET /services/apexrest/{namespace}/v3/admin/offers/offer2/promotionwrapper
3......
4THREAD10 -  GET /services/apexrest/{namespace}/v3/admin/offers/offer10/promotionwrapper
5THREAD11 -  GET /services/apexrest/{namespace}/v3/admin/offers/offer11/promotionwrapper
6......
7THREAD100 -  GET /services/apexrest/{namespace}/v3/admin/offers/offer/promotionwrapper

HTTP Headers

Header	Description
Content-Type	application/json

Response Body

This example contains promotion offer IDs.

1{
2  "cacheKey": "demopromo",
3  "apiResponse": {
4    "promotion": {
5      "attributes": {
6        "type": "vlocity_cmt__Promotion__c",
7        "url": "/services/data/v52.0/sobjects/vlocity_cmt__Promotion__c/a3S4W000002aAUhUAM"
8      },
9      "Id": "a3S4W000002aAUhUAM",
10      "Name": "demopromo",
11      "vlocity_cmt__Code__c": "demopromo",
12      "vlocity_cmt__IsActive__c": true,
13      "vlocity_cmt__IsOrderable__c": true,
14      "vlocity_cmt__PriceListId__c": "a3C4W00000P3RfDUAV"
15    },
16    "promoItemWrappers": [
17      {
18        "promoItem": {
19          "attributes": {
20            "type": "vlocity_cmt__PromotionItem__c",
21            "url": "/services/data/v52.0/sobjects/vlocity_cmt__PromotionItem__c/a3R4W000005M6E1UAK"
22          },
23          "Id": "a3R4W000005M6E1UAK",
24          "Name": "PromotionItem__ca3F6g0000001ugP",
25          "vlocity_cmt__ActionType__c": "Add/Update",
26          "vlocity_cmt__IsActive__c": true,
27          "vlocity_cmt__IsUndoable__c": false,
28          "vlocity_cmt__MaxQuantity__c": 4,
29          "vlocity_cmt__MinQuantity__c": 1,
30          "vlocity_cmt__ProductHierarchyPath__c": "01t4W00000BgKvFQAV",
31          "vlocity_cmt__ProductId__c": "01t4W00000BgKvFQAV",
32          "vlocity_cmt__PromotionId__c": "a3S4W000002aAUhUAM",
33          "vlocity_cmt__Quantity__c": 1,
34          "vlocity_cmt__UpdateScope__c": "Update Item Only"
35        },
36        "lastRealParentHierarchyPath": null,
37        "appliedPromoItemWrappers": [
38          {
39            "productHierarchyPath": "01t4W00000BgKvFQAV",
40            "lineItem": {
41              "attributes": {
42                "type": "OrderItem"
43              },
44              "vlocity_cmt__Product2Id__c": "01t4W00000BgKvFQAV",
45              "PricebookEntryId": "01u4W000009zh0VQAQ",
46              "vlocity_cmt__ProvisioningStatus__c": "New",
47              "vlocity_cmt__Action__c": "Add",
48              "vlocity_cmt__LineNumber__c": "0001",
49              "vlocity_cmt__CurrencyPaymentMode__c": "Currency",
50              "vlocity_cmt__InCartQuantityMap__c": null,
51              "vlocity_cmt__SequenceNumber__c": 1,
52              "UnitPrice": 0,
53              "Quantity": 1,
54              "vlocity_cmt__ProductHierarchyPath__c": "01t4W00000BgKvFQAV",
55              "vlocity_cmt__JSONAttribute__c": null
56            },
57            "compiledAttributeOverride": null,
58            "appliedPromoItem": {
59              "attributes": {
60                "type": "vlocity_cmt__OrderAppliedPromotionItem__c"
61              },
62              "vlocity_cmt__AppliedAction__c": "Add",
63              "vlocity_cmt__MaxQuantity__c": 4,
64              "vlocity_cmt__MinQuantity__c": 1
65            },
66            "adjustments": [
67              {
68                "attributes": {
69                  "type": "vlocity_cmt__OrderPriceAdjustment__c"
70                },
71                "vlocity_cmt__PromotionId__c": "a3S4W000002aAUhUAM",
72                "vlocity_cmt__Action__c": "Add",
73                "vlocity_cmt__PriceListEntryId__c": "a3B4W00000MsXI7UAN",
74                "vlocity_cmt__AdjustmentValue__c": -11,
75                "vlocity_cmt__Amount__c": null,
76                "vlocity_cmt__AddedByUserId__c": "0054W00000BUE7wQAH",
77                "vlocity_cmt__PricingElementGlobalKey__c": "40ebefe6-d244-15fa-9f3a-0a0f10a42aec",
78                "vlocity_cmt__PricingElementVersionId__c": "a3E4W00000KmbYxUAJ",
79                "vlocity_cmt__PricingVariableId__c": "a3I4W000003Bj1OUAS",
80                "vlocity_cmt__Source__c": "Promotion",
81                "vlocity_cmt__TimePlanId__c": null,
82                "vlocity_cmt__TimePolicyId__c": null
83              }
84            ]
85          }
86        ]
87      }
88    ],
89    "id": "a3S4W000002aAUhUAM",
90    "code": "demopromo",
91    "appliedPromo": {
92      "attributes": {
93        "type": "vlocity_cmt__OrderAppliedPromotion__c"
94      },
95      "vlocity_cmt__Action__c": "Add",
96      "vlocity_cmt__PromotionId__c": "a3S4W000002aAUhUAM",
97      "vlocity_cmt__PromotionId__r": {
98        "attributes": {
99          "type": "vlocity_cmt__Promotion__c",
100          "url": "/services/data/v52.0/sobjects/vlocity_cmt__Promotion__c/a3S4W000002aAUhUAM"
101        },
102        "Id": "a3S4W000002aAUhUAM",
103        "Name": "demopromo",
104        "vlocity_cmt__Code__c": "demopromo",
105        "vlocity_cmt__IsActive__c": true,
106        "vlocity_cmt__IsOrderable__c": true,
107        "vlocity_cmt__PriceListId__c": "a3C4W00000P3RfDUAV"
108      }
109    }
110  },
111  "errorCode": "INVOKE-200",
112  "error": "OK"
113}

HTTP Response Codes

Code	Description
200	OK
500	Internal Server Error