Retrieve Promotion Details

Retrieve the details of an individual promotion by specifying its ID in the resource URI.

1GET v2/epc/promotions/{promotions_ID}

Remote Method

1readPromotion

REST Handler

1APIPromotionRestHandler

Apex Remote Service

1PCAppHandler

Package

Communication (vlocity_cmt)

API Parameters and Response Format

For API parameter names and descriptions, see the Swagger (OpenAPI) reference documentation for Industries EPC REST APIs.

Resource Information

Response Format	JSON
Resource URL	`/services/apexrest/{namespace}/v2/epc/promotions/{promotions-id}`

Example Request

1GET v2/epc/promotions/a3K3h0000006Aj3EAE

1-   ```nolang
2GET v2/epc/promotions?id=a3K3h0000006Aj3EAE

Example Result

1{
2    "epcResponse": {
3        "entities": [
4            {
5                "numberOfProduct": 0,
6                "entity": {
7                    "attributes": {
8                        "type": "vlocity_cmt__Promotion__c",
9                        "url": "/services/data/v52.0/sobjects/vlocity_cmt__Promotion__c/a3K3h0000006AiyEAE"
10                    },
11                    "Id": "a3K3h0000006AiyEAE",
12                    "OwnerId": "0053h000002UGCUAA4",
13                    "IsDeleted": false,
14                    "Name": "Promotion-Example",
15                    "CurrencyIsoCode": "USD",
16                    "RecordTypeId": "0123h000000slErAAI",
17                    "CreatedDate": "2021-09-07T05:50:02.000+0000",
18                    "CreatedById": "0053h000002UGCUAA4",
19                    "LastModifiedDate": "2021-09-07T05:50:02.000+0000",
20                    "LastModifiedById": "0053h000002UGCUAA4",
21                    "SystemModstamp": "2021-09-07T05:50:02.000+0000",
22                    "LastViewedDate": "2021-09-07T05:50:02.000+0000",
23                    "LastReferencedDate": "2021-09-07T05:50:02.000+0000",
24                    "vlocity_cmt__AppliesToAllItems__c": false,
25                    "vlocity_cmt__CannotBeCombined__c": false,
26                    "vlocity_cmt__Code__c": "Promotion-Example",
27                    "vlocity_cmt__Description__c": "Promotion-Example",
28                    "vlocity_cmt__DurationUnitOfMeasure__c": "Month",
29                    "vlocity_cmt__EnableAutoAddProducts__c": false,
30                    "vlocity_cmt__EnableAutoApplyPromotion__c": true,
31                    "vlocity_cmt__GlobalKey__c": "a74dff32-15da-f94a-9769-d58c6685d0cb",
32                    "vlocity_cmt__IsActive__c": true,
33                    "vlocity_cmt__IsLimitedQuantity__c": true,
34                    "vlocity_cmt__IsOrderable__c": true,
35                    "vlocity_cmt__PriceListId__c": "a343h000001ACXFAA4",
36                    "vlocity_cmt__ServiceContinuation__c": "Not Applicable",
37                    "vlocity_cmt__PriceListId__r": {
38                        "attributes": {
39                            "type": "vlocity_cmt__PriceList__c",
40                            "url": "/services/data/v52.0/sobjects/vlocity_cmt__PriceList__c/a343h000001ACXFAA4"
41                        },
42                        "Id": "a343h000001ACXFAA4",
43                        "Name": "ShamPriceList"
44                    }
45                }
46            }
47        ],
48        "overallResult": "success"
49    }
50}