Retrieve the details of an individual promotion by specifying its ID in the resource URI.
GET v2/epc/promotions/{promotions_ID}
Remote Method
readPromotion
REST Handler
APIPromotionRestHandler
Apex Remote Service
PCAppHandler
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
-
GET v2/epc/promotions/a3K3h0000006Aj3EAE
- ```nolang
GET v2/epc/promotions?id=a3K3h0000006Aj3EAE
Example Result
{
"epcResponse": {
"entities": [
{
"numberOfProduct": 0,
"entity": {
"attributes": {
"type": "vlocity_cmt__Promotion__c",
"url": "/services/data/v52.0/sobjects/vlocity_cmt__Promotion__c/a3K3h0000006AiyEAE"
},
"Id": "a3K3h0000006AiyEAE",
"OwnerId": "0053h000002UGCUAA4",
"IsDeleted": false,
"Name": "Promotion-Example",
"CurrencyIsoCode": "USD",
"RecordTypeId": "0123h000000slErAAI",
"CreatedDate": "2021-09-07T05:50:02.000+0000",
"CreatedById": "0053h000002UGCUAA4",
"LastModifiedDate": "2021-09-07T05:50:02.000+0000",
"LastModifiedById": "0053h000002UGCUAA4",
"SystemModstamp": "2021-09-07T05:50:02.000+0000",
"LastViewedDate": "2021-09-07T05:50:02.000+0000",
"LastReferencedDate": "2021-09-07T05:50:02.000+0000",
"vlocity_cmt__AppliesToAllItems__c": false,
"vlocity_cmt__CannotBeCombined__c": false,
"vlocity_cmt__Code__c": "Promotion-Example",
"vlocity_cmt__Description__c": "Promotion-Example",
"vlocity_cmt__DurationUnitOfMeasure__c": "Month",
"vlocity_cmt__EnableAutoAddProducts__c": false,
"vlocity_cmt__EnableAutoApplyPromotion__c": true,
"vlocity_cmt__GlobalKey__c": "a74dff32-15da-f94a-9769-d58c6685d0cb",
"vlocity_cmt__IsActive__c": true,
"vlocity_cmt__IsLimitedQuantity__c": true,
"vlocity_cmt__IsOrderable__c": true,
"vlocity_cmt__PriceListId__c": "a343h000001ACXFAA4",
"vlocity_cmt__ServiceContinuation__c": "Not Applicable",
"vlocity_cmt__PriceListId__r": {
"attributes": {
"type": "vlocity_cmt__PriceList__c",
"url": "/services/data/v52.0/sobjects/vlocity_cmt__PriceList__c/a343h000001ACXFAA4"
},
"Id": "a343h000001ACXFAA4",
"Name": "ShamPriceList"
}
}
}
],
"overallResult": "success"
}
}