Return the applied promotions for a specified account ID.
GET /v2/accounts/{account_ID}/promotions
Remote Method
getAppliedPromotionsByAccount
Handlers
REST Endpoint: APIAppliedPromotionsAccountsV2.cls
Implementation: CpqAppliedPromotionsAccountActionV2.cls
Apex Remote Service
CpqAppHandler
Apex Remote Input Map
{
methodName:getAppliedPromotionsByAccount
accounttId:0011I000007lzDO
cartId:801Dn0000002YPA,
fields:"vlocity_cmt__CancellationDate__c,vlocity_cmt__AppliesTo__c"
pagesize:2
filters:vlocity_cmt__AppliesTo__c:Account_Contract
commitmentDateFilter:2017-04-05T07:00:00.000Z
appliedPromoStatusFilter:Active
}
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
GET /services/apexrest/vlocity_cmt/v2/cpq/carts/801360000000oQ9/promotions
Example Response
{
"totalSize": 1,
"messages": [],
"records": [
{
"messages": [],
"displaySequence": -1,
"Id": {
"value": "a1if4000000Z1wTAAS",
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Record ID",
"hidden": true,
"fieldName": "Id",
"editable": false,
"dataType": "ID",
"actions": {}
},
"vlocity_cmt__BillingAccountId__c": {
"value": "001f40000093uqMAAQ",
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Account",
"hidden": true,
"fieldName": "vlocity_cmt__BillingAccountId__c",
"editable": false,
"dataType": "REFERENCE",
"actions": {}
},
"vlocity_cmt__PromotionId__c": {
"value": "a2ff4000000cHPMAA2",
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Promotion",
"hidden": true,
"fieldName": "vlocity_cmt__PromotionId__c",
"editable": true,
"dataType": "REFERENCE",
"actions": {}
},
"vlocity_cmt__Sequence__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Sequence",
"hidden": true,
"fieldName": "vlocity_cmt__Sequence__c",
"editable": true,
"dataType": "DOUBLE",
"actions": {}
},
"vlocity_cmt__CancellationDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Cancellation Date",
"hidden": true,
"fieldName": "vlocity_cmt__CancellationDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"vlocity_cmt__CommitmentStartDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Commitment Start Date",
"hidden": true,
"fieldName": "vlocity_cmt__CommitmentStartDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"vlocity_cmt__AppliesTo__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Applies To",
"hidden": true,
"fieldName": "vlocity_cmt__AppliesTo__c",
"editable": true,
"dataType": "PICKLIST",
"actions": {}
},
"vlocity_cmt__CancellationStatus__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Cancellation Status",
"hidden": true,
"fieldName": "vlocity_cmt__CancellationStatus__c",
"editable": true,
"dataType": "PICKLIST",
"actions": {}
},
"vlocity_cmt__ReasonForCancellation__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Reason for Cancellation",
"hidden": true,
"fieldName": "vlocity_cmt__ReasonForCancellation__c",
"editable": true,
"dataType": "STRING",
"actions": {}
},
"vlocity_cmt__CommitmentEndDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Commitment End Date",
"hidden": true,
"fieldName": "vlocity_cmt__CommitmentEndDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"vlocity_cmt__PricingStartDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Benefit Start Date",
"hidden": true,
"fieldName": "vlocity_cmt__PricingStartDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"vlocity_cmt__PricingEndDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Benefit End Date",
"hidden": true,
"fieldName": "vlocity_cmt__PricingEndDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"Name": "BundleJul19Promo",
"Description": "BundleJul19Promo"
}
]
}{
"totalSize": 1,
"messages": [],
"records": [
{
"messages": [],
"displaySequence": -1,
"Id": {
"value": "a1if4000000Z1wTAAS",
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Record ID",
"hidden": true,
"fieldName": "Id",
"editable": false,
"dataType": "ID",
"actions": {}
},
"cmt_araov100_1__BillingAccountId__c": {
"value": "001f40000093uqMAAQ",
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Account",
"hidden": true,
"fieldName": "cmt_araov100_1__BillingAccountId__c",
"editable": false,
"dataType": "REFERENCE",
"actions": {}
},
"cmt_araov100_1__PromotionId__c": {
"value": "a2ff4000000cHPMAA2",
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Promotion",
"hidden": true,
"fieldName": "cmt_araov100_1__PromotionId__c",
"editable": true,
"dataType": "REFERENCE",
"actions": {}
},
"cmt_araov100_1__Sequence__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Sequence",
"hidden": true,
"fieldName": "cmt_araov100_1__Sequence__c",
"editable": true,
"dataType": "DOUBLE",
"actions": {}
},
"cmt_araov100_1__CancellationDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Cancellation Date",
"hidden": true,
"fieldName": "cmt_araov100_1__CancellationDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"cmt_araov100_1__CommitmentStartDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Commitment Start Date",
"hidden": true,
"fieldName": "cmt_araov100_1__CommitmentStartDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"cmt_araov100_1__AppliesTo__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Applies To",
"hidden": true,
"fieldName": "cmt_araov100_1__AppliesTo__c",
"editable": true,
"dataType": "PICKLIST",
"actions": {}
},
"cmt_araov100_1__CancellationStatus__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Cancellation Status",
"hidden": true,
"fieldName": "cmt_araov100_1__CancellationStatus__c",
"editable": true,
"dataType": "PICKLIST",
"actions": {}
},
"cmt_araov100_1__ReasonForCancellation__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Reason for Cancellation",
"hidden": true,
"fieldName": "cmt_araov100_1__ReasonForCancellation__c",
"editable": true,
"dataType": "STRING",
"actions": {}
},
"cmt_araov100_1__CommitmentEndDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Commitment End Date",
"hidden": true,
"fieldName": "cmt_araov100_1__CommitmentEndDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"cmt_araov100_1__PricingStartDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Benefit Start Date",
"hidden": true,
"fieldName": "cmt_araov100_1__PricingStartDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"cmt_araov100_1__PricingEndDate__c": {
"value": null,
"previousValue": null,
"originalValue": null,
"messages": [],
"label": "Benefit End Date",
"hidden": true,
"fieldName": "cmt_araov100_1__PricingEndDate__c",
"editable": true,
"dataType": "DATETIME",
"actions": {}
},
"Name": "BundleJul19Promo",
"Description": "BundleJul19Promo"
}
]
}