| Note |
|---|
In order to use this API, your Salesforce Org needs to have API usage activated through having an API usage License. |
The Package Creation API is currently not available in version 2.171.
We apologize for any inconvenience this may cause and appreciate your patience.
1. REST Web Service
1.1. URL
https://<my-domain-name>.my.salesforce.com/services/apexrest/ADvendio/ADvendio__Campaign_Item__c/PackageService/
1.2. Method
PATCH
1.3. URL Params
None
1.4. Data Params
A JSON object with the attribute request, containing mediaCampaignId and a JSON serialized list of campaignItems.
...
| Code Block |
|---|
{
"mediaCampaignId": "a235t000000yMAZAA2",
"campaignItems": [
{
"Ad_Price__c": "a0T5t000001QpPYEA0",
"from_Date__c": "20-01-01",
"until_Date__c": "20-01-01",
"Rate_Discount_4__c": 4.2,
"Quantity__c": 3
},
{
"Ad_Price__c": "a0T5t000001QpQNEA0",
"from_Date__c": "20-01-01",
"until_Date__c": "30-01-01",
"Quantity__c": 44,
"Id": "a0wXX00XX000000001"
},
{
"Ad_Price__c": "a0T5t000001QpPgEAK",
"from_Date__c": "21-01-01",
"until_Date__c": "29-01-01",
"Quantity__c": 53,
"PacketItem__c": "a0wXX00XX000000001"
}
]
}
} |
1.5. Success Response
Code: 200
Content: A JSON serialized list of the Campaign Items from the request body with their details.
...
| Code Block |
|---|
[
{
"attributes": {
"type": "ADvendio__Campaign_Item__c",
"url": "/services/data/v59.0/sobjects/ADvendio__Campaign_Item__c/a0wXX00XX000000006"
},
"ADvendio__Ad_Price__c": "a0T5t000001QpPYEA0",
"from_Date__c": "2020-01-01",
"until_Date__c": "2020-01-01",
"Rate_Discount_4__c": 4.2,
"Quantity__c": 3
},
...
] |
1.6. Error Response
See Salesforce Apex REST Documentation
1.8. Examples
1.8.1. Simple Request
Creating a Standard Campaign Item and a Package with a Header and Component:
| Code Block |
|---|
{
"mediaCampaignId": "a235t000000yMAZAA2",
"campaignItems": [
{
"Ad_Price__c": "a0T5t000001QpPYEA0",
"from_Date__c": "20-01-01",
"until_Date__c": "20-01-01",
"Rate_Discount_4__c": 4.2,
"Quantity__c": 3
},
{
"Ad_Price__c": "a0T5t000001QpQNEA0",
"from_Date__c": "20-01-01",
"until_Date__c": "30-01-01",
"Quantity__c": 44,
"Id": "a0wXX00XX000000001"
},
{
"Ad_Price__c": "a0T5t000001QpPgEAK",
"from_Date__c": "21-01-01",
"until_Date__c": "29-01-01",
"Quantity__c": 53,
"PacketItem__c": "a0wXX00XX000000001"
}
]
}
} |
1.8.3. Response
| Code Block |
|---|
},
"ADvendio__Ad_Price__c": "a0T5t000001QpPYEA0",
"from_Date__c": "2020-01-01",
"until_Date__c": "2020-01-01",
"Rate_Discount_4__c": 4.2,
"Quantity__c": 3
}, |
1.9. Usage in Apex
| Code Block |
|---|
List<ADvendio__Campaign_Item__c> cis = ... cis = ADvendio.PackageService.applyPackage(cis); |
1.7. Logic
Technical Documentation - Package Creation
The Package Service API creates Virtual Campaign Items which can be either Standard or Packages.
...
A Package Header Campaign Item must link to an Ad Spec with a Package Header Record Type.
A Package Component Campaign Item must link to the Package Header Campaign Item using the
PacketItem__cattribute.
Required Fields:
For Standard Campaign Items:
Ad_Price__cfrom_Date__cuntil_Date__cQuantity__c
For Package Header Campaign Items:
Ad_Price__cfrom_Date__cuntil_Date__cQuantity__cId(must be unique within the request)
For Package Component Campaign Items:
Ad_Price__cfrom_Date__cuntil_Date__cQuantity__cPacketItem__c(must match the Id of the corresponding Package Header Campaign Item)
Optional Surcharge and Discount Fields:
Sales_Price__cSurchargeB2__cSurchargeB2Abs__cSurchargeB3__cSurchargeB3Abs__cSurchargeSalesPrice__cSurchargeSalesPricePct__cRateDiscount1AbsCustom__cRateDiscount2AbsCustom__cRateDiscount3AbsCustom__cRateDiscount4AbsCustom__cRate_Discount_2_custom__cRate_Discount_3_custom__cRate_Discount_4__cQuantity_Discount_custom__c
...