Get Cart Promotions

Retrieve all promotions for a specified opportunity, quote, or order.

1GET /v2/cpq/carts/cart_ID/promotions

This API supports the guest user enhancements that Salesforce introduced with the Winter ‘21 release. To encrypt and decrypt data for guest users, use the UserSecurity class with this API. See Guest User Technical Details.

For additional information, see UserSecurity Class and CPQ and Digital Commerce Changes for Guest Users.

Remote Method

1getCartsPromotions

Handlers

1REST Endpoint: APIPromotionsCartsCpqV2.cls
2Implementation: EPCPromotionRuntimeService.cls

Apex remote service

1CpqAppHandler

Apex Remote Input Map

1methodName:getCartsPromotions
2cartId:8011I000000TUaK
3query:query
4filters:vlocity_cmt__Code__c:Root-Promo
5sortBy:Id

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/{namespace}/v2/cpq/carts/{cart_ID}/promotions`

Example Request

1GET /services/apexrest/vlocity_cmt/v2/cpq/carts/8011I000000TUaK/promotions?query=iphone&sortBy=Id&filters=vlocity_cmt__Code__c:Root-Promo

Example Response

1{
2  "totalSize": 1,
3  "messages": [],
4  "records": [
5    {
6      "messages": [],
7      "actions": {
8        "validatecart": {
9          "rest": {
10            "params": {},
11            "method": "POST",
12            "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/8011I000000TUaKQAW/validate"
13          },
14          "remote": {
15            "params": {
16              "cartId": "8011I000000TUaKQAW",
17              "methodName": "runCartValidation"
18            }
19          },
20          "client": {
21            "params": {}
22          }
23        }
24      },
25      "displaySequence": 0,
26      "Id": "a2j1I000000XzfWQAS",
27      "Name": "Root-Promo",
28      "vlocity_cmt__Code__c": "Root-Promo",
29      "name": "Root-Promo",
30      "code": "Root-Promo",
31      "id": "a2j1I000000XzfWQAS",
32      "category": "Qualified"
33    }
34  ]
35}