Content

Please make sure to add the relevant fields also to the Campaign Item you provide to the API method if you are using the Custom Matching Criteria as described here 8.4.6 Setup Price Rules/Dynamic Pricing (Feature Setting). Our logic will not query these fields by itself so missing this data might lead to not matching Price Rules.

The Dynamic Pricing API is implemented as Apex class and is exposed as REST web service by using Salesforce standard functionality (see Apex Developer Guide for more information). For general information about the dynamic pricing feature, see 3.3.5 Price Rules / Dynamic Pricing

1. REST web service

1.1. URL

https://<my-domain-name>.my.salesforce.com/services/apexrest/ADvendio/ADvendio__Campaign_Item__c/ApplyPriceRules/

1.2. Method

PATCH

1.3. URL Params

-

1.4. Data Params

A JSON object with the attribute campaignItems, what contains a JSON serialized list of Campaign Items.

Example: { "campaignItems":[{<Campaign Item>}, ...]}

1.5. Success Response

Code: 200

Content: A JSON serialized list of the Campaign Items from the request body, but now with updated surcharge and discount fields.

Example: [{<Campaign Item>}, ...]

1.6. Error Response

See Salesforce Apex REST Documentation

1.7. Logic

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'AD:Technical Documentation - Dynamic Pricing'.

1.8. Examples

1.8.1. Get a Session-ID

Get a Session ID

curl -v https://login.salesforce.com/services/oauth2/token -d "grant_type=password" -d "client_id=<CLIENT_ID>" -d "client_secret=<CLIENT_SECRET>" -d "username=<USER_NAME>" -d "password=<PASSWORD+TOKEN>" -H 'X-PrettyPrint:1'

Connected App

Get CLIENT_ID and CLIENT_SECRET from any connected app or create a new app in your org: App Manager -> New Connected App

1.8.2. Simple request

A simple request with a Price Rule, having all criteria fields empty (so it matches every Campaign Item) and setting surcharge B2 to 20%.

Call Dynamic Pricing web service

curl https://<my-domain-name>.my.salesforce.com/services/apexrest/ADvendio/ADvendio__Campaign_Item__c/ApplyPriceRules/ -H 'Authorization: Bearer <SESSION_ID>' -H "Content-Type: application/json" -H 'X-PrettyPrint:1' -d @requestBody.txt --request PATCH

requestBody.txt

{
    "campaignItems": [
        {
            "ADvendio__Ad_Price__c": "a0T7Y000005TxIWUA0",
            "ADvendio__from_Date__c": "2019-06-03",
            "ADvendio__until_Date__c": "2019-06-09"
        }
    ]
}

Response

[
    {
        "attributes": {
            "type": "ADvendio__Campaign_Item__c"
        },
        "ADvendio__from_Date__c": "2019-06-03",
        "ADvendio__until_Date__c": "2019-06-09",
        "ADvendio__Ad_Price__r": {
            "attributes": {
                "type": "ADvendio__Ad_price__c",
                "url": "/services/data/v45.0/sobjects/ADvendio__Ad_price__c/a0T7Y000005TxIWUA0"
            },
            "ADvendio__Ad_Spec__c": "a0R7Y00000Bi9JBUAZ",
            "Id": "a0T7Y000005TxIWUA0",
            "ADvendio__Ad_Spec__r": {
                "attributes": {
                    "type": "ADvendio__Ad_Specs__c",
                    "url": "/services/data/v45.0/sobjects/ADvendio__Ad_Specs__c/a0R7Y00000Bi9JBUAZ"
                },
                "Id": "a0R7Y00000Bi9JBUAZ",
                "ADvendio__Ad_Type__c": "a0S7Y00000JRcaDUAT",
                "ADvendio__Placement__c": "a2B7Y000001ox8RUAQ",
                "ADvendio__Ad_Type__r": {
                    "attributes": {
                        "type": "ADvendio__Ad_Type__c",
                        "url": "/services/data/v45.0/sobjects/ADvendio__Ad_Type__c/a0S7Y00000JRcaDUAT"
                    },
                    "Id": "a0S7Y00000JRcaDUAT"
                },
                "ADvendio__Placement__r": {
                    "attributes": {
                        "type": "ADvendio__Placement__c",
                        "url": "/services/data/v45.0/sobjects/ADvendio__Placement__c/a2B7Y000001ox8RUAQ"
                    },
                    "Id": "a2B7Y000001ox8RUAQ",
                    "ADvendio__Site__c": "a2o7Y00000176LMQAY",
                    "ADvendio__Site__r": {
                        "attributes": {
                            "type": "ADvendio__Site__c",
                            "url": "/services/data/v45.0/sobjects/ADvendio__Site__c/a2o7Y00000176LMQAY"
                        },
                        "Id": "a2o7Y00000176LMQAY"
                    }
                }
            }
        },
        "ADvendio__Rate_Discount_4__c": 15.00,
        "ADvendio__Ad_Price__c": "a0T7Y000005TxIWUA0",
        "ADvendio__AppliedPriceRules__c": "{\"UpdatedFields\":{\"ADvendio__Rate_Discount_4__c\":\"15.00\"},\"AppliedRules\":[{\"attributes\":{\"type\":\"ADvendio__PriceRule__c\",\"url\":\"/services/data/v57.0/sobjects/ADvendio__PriceRule__c/a2C7Y000001Ia6UUAS\"},\"Id\":\"a2C7Y000001Ia6UUAS\",\"Name\":\"prise rules 1\",\"ADvendio__WhereToApply__c\":\"ADvendio__Rate_Discount_4__c\"}]}"
    }
]

1.8.3. Complex request

A more complex example to match the following Price Rule (additionally to more simple ones)

a more complex Price Rule

{
   "ADvendio__PriceRule__c":{
      "Id":"a2C7Y000001Ia6UUAS",
      "ADvendio__AdServerIdCategory__c":"Inventory",
      "ADvendio__FrequencyCapping__c":true,
      "ADvendio__DayTimeTargeting__c":true,
      "ADvendio__AdType__c":"a0GA000000mXrcMMAS",
      "ADvendio__Placement__c":"a1MA0000009rsHWMAY",
      "ADvendio__AdvertisingMedium__c":"a1kA0000002JIb0IAG",
      "ADvendio__WhereToApply__c":"ADvendio__Rate_Discount_2_custom__c",
      "ADvendio__Percentage__c":"99.00000000000",
      "CurrencyIsoCode":"EUR"
   }
}