Get Applied Promotions for Account

Return the applied promotions for a specified account ID.

1GET /v2/accounts/{account_ID}/promotions

Remote Method

1getAppliedPromotionsByAccount

Handlers

1REST Endpoint: APIAppliedPromotionsAccountsV2.cls
2Implementation: CpqAppliedPromotionsAccountActionV2.cls

Apex Remote Service

1CpqAppHandler

Apex Remote Input Map

1{
2  methodName:getAppliedPromotionsByAccount
3  accounttId:0011I000007lzDO
4  cartId:801Dn0000002YPA,
5  fields:"vlocity_cmt__CancellationDate__c,vlocity_cmt__AppliesTo__c"
6  pagesize:2
7  filters:vlocity_cmt__AppliesTo__c:Account_Contract
8  commitmentDateFilter:2017-04-05T07:00:00.000Z
9  appliedPromoStatusFilter:Active
10}

Package

Communication (vlocity_cmt)

API Parameters and Response Format

For API parameter names and descriptions, see Cart-Based API Swagger Reference.

Resource Information

Response Format	JSON
Resource URL	`/services/apexrest/vlocity_cmt/v2/cpq/carts/{account_ID}/promotions?subaction=getPromotionsAppliedToCart`

Example Request

1GET /services/apexrest/vlocity_cmt/v2/cpq/carts/801360000000oQ9/promotions

Example Response

1{
2  "totalSize": 1,
3  "messages": [],
4  "records": [
5    {
6      "messages": [],
7      "displaySequence": -1,
8      "Id": {
9        "value": "a1if4000000Z1wTAAS",
10        "previousValue": null,
11        "originalValue": null,
12        "messages": [],
13        "label": "Record ID",
14        "hidden": true,
15        "fieldName": "Id",
16        "editable": false,
17        "dataType": "ID",
18        "actions": {}
19      },
20      "vlocity_cmt__BillingAccountId__c": {
21        "value": "001f40000093uqMAAQ",
22        "previousValue": null,
23        "originalValue": null,
24        "messages": [],
25        "label": "Account",
26        "hidden": true,
27        "fieldName": "vlocity_cmt__BillingAccountId__c",
28        "editable": false,
29        "dataType": "REFERENCE",
30        "actions": {}
31      },
32      "vlocity_cmt__PromotionId__c": {
33        "value": "a2ff4000000cHPMAA2",
34        "previousValue": null,
35        "originalValue": null,
36        "messages": [],
37        "label": "Promotion",
38        "hidden": true,
39        "fieldName": "vlocity_cmt__PromotionId__c",
40        "editable": true,
41        "dataType": "REFERENCE",
42        "actions": {}
43      },
44      "vlocity_cmt__Sequence__c": {
45        "value": null,
46        "previousValue": null,
47        "originalValue": null,
48        "messages": [],
49        "label": "Sequence",
50        "hidden": true,
51        "fieldName": "vlocity_cmt__Sequence__c",
52        "editable": true,
53        "dataType": "DOUBLE",
54        "actions": {}
55      },
56      "vlocity_cmt__CancellationDate__c": {
57        "value": null,
58        "previousValue": null,
59        "originalValue": null,
60        "messages": [],
61        "label": "Cancellation Date",
62        "hidden": true,
63        "fieldName": "vlocity_cmt__CancellationDate__c",
64        "editable": true,
65        "dataType": "DATETIME",
66        "actions": {}
67      },
68      "vlocity_cmt__CommitmentStartDate__c": {
69        "value": null,
70        "previousValue": null,
71        "originalValue": null,
72        "messages": [],
73        "label": "Commitment Start Date",
74        "hidden": true,
75        "fieldName": "vlocity_cmt__CommitmentStartDate__c",
76        "editable": true,
77        "dataType": "DATETIME",
78        "actions": {}
79      },
80      "vlocity_cmt__AppliesTo__c": {
81        "value": null,
82        "previousValue": null,
83        "originalValue": null,
84        "messages": [],
85        "label": "Applies To",
86        "hidden": true,
87        "fieldName": "vlocity_cmt__AppliesTo__c",
88        "editable": true,
89        "dataType": "PICKLIST",
90        "actions": {}
91      },
92      "vlocity_cmt__CancellationStatus__c": {
93        "value": null,
94        "previousValue": null,
95        "originalValue": null,
96        "messages": [],
97        "label": "Cancellation Status",
98        "hidden": true,
99        "fieldName": "vlocity_cmt__CancellationStatus__c",
100        "editable": true,
101        "dataType": "PICKLIST",
102        "actions": {}
103      },
104      "vlocity_cmt__ReasonForCancellation__c": {
105        "value": null,
106        "previousValue": null,
107        "originalValue": null,
108        "messages": [],
109        "label": "Reason for Cancellation",
110        "hidden": true,
111        "fieldName": "vlocity_cmt__ReasonForCancellation__c",
112        "editable": true,
113        "dataType": "STRING",
114        "actions": {}
115      },
116      "vlocity_cmt__CommitmentEndDate__c": {
117        "value": null,
118        "previousValue": null,
119        "originalValue": null,
120        "messages": [],
121        "label": "Commitment End Date",
122        "hidden": true,
123        "fieldName": "vlocity_cmt__CommitmentEndDate__c",
124        "editable": true,
125        "dataType": "DATETIME",
126        "actions": {}
127      },
128      "vlocity_cmt__PricingStartDate__c": {
129        "value": null,
130        "previousValue": null,
131        "originalValue": null,
132        "messages": [],
133        "label": "Benefit Start Date",
134        "hidden": true,
135        "fieldName": "vlocity_cmt__PricingStartDate__c",
136        "editable": true,
137        "dataType": "DATETIME",
138        "actions": {}
139      },
140      "vlocity_cmt__PricingEndDate__c": {
141        "value": null,
142        "previousValue": null,
143        "originalValue": null,
144        "messages": [],
145        "label": "Benefit End Date",
146        "hidden": true,
147        "fieldName": "vlocity_cmt__PricingEndDate__c",
148        "editable": true,
149        "dataType": "DATETIME",
150        "actions": {}
151      },
152      "Name": "BundleJul19Promo",
153      "Description": "BundleJul19Promo"
154    }
155  ]
156}{
157  "totalSize": 1,
158  "messages": [],
159  "records": [
160    {
161      "messages": [],
162      "displaySequence": -1,
163      "Id": {
164        "value": "a1if4000000Z1wTAAS",
165        "previousValue": null,
166        "originalValue": null,
167        "messages": [],
168        "label": "Record ID",
169        "hidden": true,
170        "fieldName": "Id",
171        "editable": false,
172        "dataType": "ID",
173        "actions": {}
174      },
175      "cmt_araov100_1__BillingAccountId__c": {
176        "value": "001f40000093uqMAAQ",
177        "previousValue": null,
178        "originalValue": null,
179        "messages": [],
180        "label": "Account",
181        "hidden": true,
182        "fieldName": "cmt_araov100_1__BillingAccountId__c",
183        "editable": false,
184        "dataType": "REFERENCE",
185        "actions": {}
186      },
187      "cmt_araov100_1__PromotionId__c": {
188        "value": "a2ff4000000cHPMAA2",
189        "previousValue": null,
190        "originalValue": null,
191        "messages": [],
192        "label": "Promotion",
193        "hidden": true,
194        "fieldName": "cmt_araov100_1__PromotionId__c",
195        "editable": true,
196        "dataType": "REFERENCE",
197        "actions": {}
198      },
199      "cmt_araov100_1__Sequence__c": {
200        "value": null,
201        "previousValue": null,
202        "originalValue": null,
203        "messages": [],
204        "label": "Sequence",
205        "hidden": true,
206        "fieldName": "cmt_araov100_1__Sequence__c",
207        "editable": true,
208        "dataType": "DOUBLE",
209        "actions": {}
210      },
211      "cmt_araov100_1__CancellationDate__c": {
212        "value": null,
213        "previousValue": null,
214        "originalValue": null,
215        "messages": [],
216        "label": "Cancellation Date",
217        "hidden": true,
218        "fieldName": "cmt_araov100_1__CancellationDate__c",
219        "editable": true,
220        "dataType": "DATETIME",
221        "actions": {}
222      },
223      "cmt_araov100_1__CommitmentStartDate__c": {
224        "value": null,
225        "previousValue": null,
226        "originalValue": null,
227        "messages": [],
228        "label": "Commitment Start Date",
229        "hidden": true,
230        "fieldName": "cmt_araov100_1__CommitmentStartDate__c",
231        "editable": true,
232        "dataType": "DATETIME",
233        "actions": {}
234      },
235      "cmt_araov100_1__AppliesTo__c": {
236        "value": null,
237        "previousValue": null,
238        "originalValue": null,
239        "messages": [],
240        "label": "Applies To",
241        "hidden": true,
242        "fieldName": "cmt_araov100_1__AppliesTo__c",
243        "editable": true,
244        "dataType": "PICKLIST",
245        "actions": {}
246      },
247      "cmt_araov100_1__CancellationStatus__c": {
248        "value": null,
249        "previousValue": null,
250        "originalValue": null,
251        "messages": [],
252        "label": "Cancellation Status",
253        "hidden": true,
254        "fieldName": "cmt_araov100_1__CancellationStatus__c",
255        "editable": true,
256        "dataType": "PICKLIST",
257        "actions": {}
258      },
259      "cmt_araov100_1__ReasonForCancellation__c": {
260        "value": null,
261        "previousValue": null,
262        "originalValue": null,
263        "messages": [],
264        "label": "Reason for Cancellation",
265        "hidden": true,
266        "fieldName": "cmt_araov100_1__ReasonForCancellation__c",
267        "editable": true,
268        "dataType": "STRING",
269        "actions": {}
270      },
271      "cmt_araov100_1__CommitmentEndDate__c": {
272        "value": null,
273        "previousValue": null,
274        "originalValue": null,
275        "messages": [],
276        "label": "Commitment End Date",
277        "hidden": true,
278        "fieldName": "cmt_araov100_1__CommitmentEndDate__c",
279        "editable": true,
280        "dataType": "DATETIME",
281        "actions": {}
282      },
283      "cmt_araov100_1__PricingStartDate__c": {
284        "value": null,
285        "previousValue": null,
286        "originalValue": null,
287        "messages": [],
288        "label": "Benefit Start Date",
289        "hidden": true,
290        "fieldName": "cmt_araov100_1__PricingStartDate__c",
291        "editable": true,
292        "dataType": "DATETIME",
293        "actions": {}
294      },
295      "cmt_araov100_1__PricingEndDate__c": {
296        "value": null,
297        "previousValue": null,
298        "originalValue": null,
299        "messages": [],
300        "label": "Benefit End Date",
301        "hidden": true,
302        "fieldName": "cmt_araov100_1__PricingEndDate__c",
303        "editable": true,
304        "dataType": "DATETIME",
305        "actions": {}
306      },
307      "Name": "BundleJul19Promo",
308      "Description": "BundleJul19Promo"
309    }
310  ]
311}