Offer Details API

The Offer Details API takes an offer’s ID as input and populates its details in the cache. The entry contains information about the product, such as its hierarchy, price-keys, attribute details, etc. 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 combined result of the apiResponse.data.catalogProductRelationDetails.Product and apiResponse.data.catalogProductRelationDetails.Promotion nodes 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}/offerdetails

HTTP Method

POST

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/offerdetails?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;
2String requestBodyJSON;
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 = 'getOfferDetails';
9input.put('apiName', 'CMOfferDetails');     // required
10input.put('methodName', methodName);        // required
11input.put('catalogCode', 'TestCatalog');    // required
12input.put('offerId', '01t4x000000x269AAA'); // required
13input.put('effectiveStartTime', null);      // optional
14input.put('expirationTime', null);          // optional
15input.put('requestURL', '/v3/admin/catalogs/{catalogCode}/offers/{offerId}/offerdetails'); //required
16
17//remote action invocation
18vlocity_cmt.CpqAppHandler appHandler = new vlocity_cmt.CpqAppHandler();
19appHandler.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 - POST /services/apexrest/{namespace}/v3/admin/catalogs/catalog1/offers/offer1/offerdetails
2THREAD2 - POST /services/apexrest/{namespace}/v3/admin/catalogs/catalog1/offers/offer2/offerdetails
3......
4THREAD100 - POST /services/apexrest/{namespace}/v3/admin/catalogs/catalog1/offers/offer100/offerdetails
5THREAD101 - POST /services/apexrest/{namespace}/v3/admin/catalogs/catalog2/offers/offer101/offerdetails
6......
7THREAD1000 - POST /services/apexrest/{namespace}/v3/admin/catalogs/catalog10/offers/offer1000/offerdetails

HTTP Headers

Header	Description
Content-Type	application/json

Response Body

This example contains an offer and its associated details.

1{
2  "offerDetails": {
3    "offer": {
4      "offerType": "Promotion",
5      "childProducts": [
6        {
7          "priceKeys": [
8            "01t5g000002vVZPAA2;;;a3D5g000000HAiNEAW",
9            "01t5g000002vVZPAA2;;a3T5g000000CvgkEAC;a3D5g000000HAiNEAW"
10          ],
11          "IsActive": true,
12          "pr_dc_002__IsOrderable__c": true,
13          "pr_dc_002__EndOfLifeDate__c": null,
14          "pr_dc_002__SellingEndDate__c": null,
15          "pr_dc_002__SellingStartDate__c": null,
16          "Description": null,
17          "Id": "01t5g000002vVZPAA2",
18          "AttributeCategory": {
19            "records": [
20              {
21                "productAttributes": {
22                  "records": [
23                    {
24                      "userValues": null,
25                      "values": [
26                        {
27                          "disabled": false,
28                          "readonly": false
29                        }
30                      ],
31                      "isNotTranslatable": false,
32                      "cloneable": true,
33                      "hidden": false,
34                      "hasRules": false,
35                      "displaySequence": 1,
36                      "label": "DateForBuyBack2",
37                      "attributeId": "a0X5g000000GZNkEAO",
38                      "filterable": true,
39                      "disabled": false,
40                      "readonly": false,
41                      "required": false,
42                      "multiselect": false,
43                      "cacheable": true,
44                      "inputType": "date",
45                      "dataType": "date",
46                      "code": "DateForBuyBack2"
47                    },
48                    {
49                      "userValues": null,
50                      "values": [
51                        {
52                          "disabled": false,
53                          "readonly": false
54                        }
55                      ],
56                      "isNotTranslatable": false,
57                      "cloneable": true,
58                      "hidden": false,
59                      "hasRules": false,
60                      "displaySequence": 1,
61                      "label": "DateTimeForDelivery2",
62                      "attributeId": "a0X5g000000GZNlEAO",
63                      "filterable": true,
64                      "disabled": false,
65                      "readonly": false,
66                      "required": false,
67                      "multiselect": false,
68                      "cacheable": true,
69                      "inputType": "datetime",
70                      "dataType": "datetime",
71                      "code": "DateTimeForDelivery2"
72                    }
73                  ],
74                  "totalSize": 2
75                },
76                "id": "a0W5g0000009UidEAE",
77                "Name": "BASIC",
78                "Code__c": "BASIC",
79                "displaySequence": 1
80              },
81              {
82                "productAttributes": {
83                  "records": [
84                    {
85                      "userValues": null,
86                      "values": [
87                        {
88                          "displaySequence": 1,
89                          "defaultSelected": false,
90                          "value": "false",
91                          "disabled": false,
92                          "readonly": false,
93                          "label": "false",
94                          "name": "8a8b4ef3-765a-6933-b99a-8d64dc2194a0",
95                          "id": "8a8b4ef3-765a-6933-b99a-8d64dc2194a0"
96                        },
97                        {
98                          "displaySequence": 2,
99                          "defaultSelected": false,
100                          "value": "true",
101                          "disabled": false,
102                          "readonly": false,
103                          "label": "true",
104                          "name": "34c72160-5234-5a70-432b-e2382fcae4f5",
105                          "id": "34c72160-5234-5a70-432b-e2382fcae4f5"
106                        }
107                      ],
108                      "isNotTranslatable": false,
109                      "cloneable": true,
110                      "hidden": false,
111                      "hasRules": false,
112                      "displaySequence": 1,
113                      "label": "IsValueForMoney2",
114                      "attributeId": "a0X5g000000GZNmEAO",
115                      "filterable": true,
116                      "disabled": false,
117                      "readonly": false,
118                      "required": false,
119                      "multiselect": false,
120                      "cacheable": true,
121                      "inputType": "dropdown",
122                      "dataType": "text",
123                      "code": "IsValueForMoney2"
124                    },
125                    {
126                      "userValues": null,
127                      "values": [
128                        {
129                          "disabled": false,
130                          "readonly": false
131                        }
132                      ],
133                      "isNotTranslatable": false,
134                      "cloneable": true,
135                      "hidden": false,
136                      "hasRules": false,
137                      "displaySequence": 1,
138                      "label": "Networth2",
139                      "attributeId": "a0X5g000000GZNnEAO",
140                      "filterable": true,
141                      "disabled": false,
142                      "readonly": false,
143                      "required": false,
144                      "multiselect": false,
145                      "cacheable": true,
146                      "inputType": "number",
147                      "dataType": "currency",
148                      "code": "Networth2"
149                    },
150                    {
151                      "userValues": null,
152                      "values": [
153                        {
154                          "disabled": false,
155                          "readonly": false
156                        }
157                      ],
158                      "isNotTranslatable": false,
159                      "cloneable": true,
160                      "hidden": false,
161                      "hasRules": false,
162                      "displaySequence": 1,
163                      "label": "LikelhoodOfRecommendation2",
164                      "attributeId": "a0X5g000000GZNoEAO",
165                      "filterable": true,
166                      "disabled": false,
167                      "readonly": false,
168                      "required": false,
169                      "multiselect": false,
170                      "cacheable": true,
171                      "inputType": "number",
172                      "dataType": "percentage",
173                      "code": "LikelhoodOfRecommendation2"
174                    },
175                    {
176                      "userValues": null,
177                      "values": [
178                        {
179                          "disabled": false,
180                          "readonly": false
181                        }
182                      ],
183                      "isNotTranslatable": false,
184                      "cloneable": true,
185                      "hidden": false,
186                      "hasRules": false,
187                      "displaySequence": 1,
188                      "label": "Age2",
189                      "attributeId": "a0X5g000000GZNpEAO",
190                      "filterable": true,
191                      "disabled": false,
192                      "readonly": false,
193                      "required": false,
194                      "multiselect": false,
195                      "cacheable": true,
196                      "inputType": "number",
197                      "dataType": "number",
198                      "code": "Age2"
199                    },
200                    {
201                      "userValues": false,
202                      "values": [
203                        {
204                          "defaultValue": false,
205                          "disabled": false,
206                          "readonly": false
207                        }
208                      ],
209                      "isNotTranslatable": false,
210                      "cloneable": true,
211                      "hidden": false,
212                      "hasRules": false,
213                      "displaySequence": 1,
214                      "label": "NeedInsurance2",
215                      "attributeId": "a0X5g000000GZNqEAO",
216                      "filterable": true,
217                      "disabled": false,
218                      "readonly": false,
219                      "required": false,
220                      "multiselect": false,
221                      "cacheable": true,
222                      "inputType": "checkbox",
223                      "dataType": "text",
224                      "code": "NeedInsurance2"
225                    }
226                  ],
227                  "totalSize": 5
228                },
229                "id": "a0W5g0000009UieEAE",
230                "Name": "SURVEY",
231                "Code__c": "SURVEY",
232                "displaySequence": 2
233              }
234            ],
235            "totalSize": 2
236          },
237          "Attachments": null,
238          "lineNumber": "0001",
239          "productHierarchyPath": "01t5g000002vVZPAA2",
240          "groupMaxQuantity": 99999,
241          "groupMinQuantity": 0,
242          "maxQuantity": 2,
243          "minQuantity": 0,
244          "Quantity": 0,
245          "PricebookEntryId": "01u5g000002n2RaAAI",
246          "Product2Id": "01t5g000002vVZPAA2",
247          "ProductCode": "T11_p_151",
248          "Name": "T11_p_151"
249        }
250      ],
251      "pr_dc_002__IsOrderable__c": true,
252      "pr_dc_002__IsActive__c": true,
253      "pr_dc_002__Code__c": "T11_promo151",
254      "Name": "T11_promo151",
255      "Id": "a3T5g000000CvgkEAC"
256    }
257  }
258}

HTTP Response Codes

Code	Description
200	OK
500	Internal Server Error