{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"expand","attrs":{"title":"Content"},"content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Table of Contents","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"}},"macroMetadata":{"macroId":{"value":"ab3f188b-a9ee-41bb-bb8b-561f55746cd7"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"In order to use the Dynamic Pricing API, your Salesforce Org needs to have API usage activated through having an API usage License. ","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Custom Matching criterion","type":"text"}]},{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"8.4.6 Setup Price Rules/Dynamic Pricing (Feature Setting)","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/SO/pages/882704391"}}]},{"text":". Our logic will not query these fields by itself so missing this data might lead to not matching Price Rules. ","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"numberedheadings","parameters":{"macroParams":{"start-numbering-with":{"value":"1"}},"macroMetadata":{"macroId":{"value":"d08939d6-a6b4-4c6e-a850-e5b954dc421e"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://numberedheadings.bobswift.appfire.app/logo-black-72.png"}}],"title":"Numbered Headings"}}},"content":[{"type":"paragraph","content":[{"text":"The Dynamic Pricing API is implemented as Apex class and is exposed as REST web service by using Salesforce standard functionality (see ","type":"text"},{"text":"Apex Developer Guide","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm"}}]},{"text":" for more information). For general information about the dynamic pricing feature, see ","type":"text"},{"text":"3.3.5 Price Rules / Dynamic Pricing","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/SO/pages/699465760"}}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"REST web service","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL","type":"text"}]},{"type":"paragraph","content":[{"text":"https://.my.salesforce.com/services/apexrest/ADvendio/ADvendio__Campaign_Item__c/ApplyPriceRules/","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Method","type":"text"}]},{"type":"paragraph","content":[{"text":"PATCH","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL Params","type":"text"}]},{"type":"paragraph","content":[{"text":"-","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Data Params","type":"text"}]},{"type":"paragraph","content":[{"text":"A JSON object with the attribute campaignItems, what contains a JSON serialized list of Campaign Items.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":": { \"campaignItems\":[{}, ...]}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Success Response","type":"text"}]},{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]},{"text":": 200","type":"text"}]},{"type":"paragraph","content":[{"text":"Content","type":"text","marks":[{"type":"strong"}]},{"text":": A JSON serialized list of the Campaign Items from the request body, but now with updated surcharge and discount fields.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":": [{}, ...]","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Response","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"Salesforce Apex REST Documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest_methods.htm"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Logic","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt-include","parameters":{"macroParams":{"":{"value":"AD:Technical Documentation - Dynamic Pricing"}},"macroMetadata":{"macroId":{"value":"551bb50b-bc6d-4f50-b785-97a9310a23d6"},"schemaVersion":{"value":"1"},"title":"Insert excerpt"}}}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Get a Session-ID","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get a Session ID","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl -v https://login.salesforce.com/services/oauth2/token -d \"grant_type=password\" -d \"client_id=\" -d \"client_secret=\" -d \"username=\" -d \"password=\" -H 'X-PrettyPrint:1'","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Connected App","type":"text"}]},{"type":"paragraph","content":[{"text":"Get CLIENT_ID and CLIENT_SECRET from any connected app or create a new app in your org: App Manager -> New Connected App","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Simple request","type":"text"}]},{"type":"paragraph","content":[{"text":"A simple request with a Price Rule, having all criteria fields empty (so it matches every Campaign Item) and setting surcharge B2 to 20%.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Call Dynamic Pricing web service","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl https://.my.salesforce.com/services/apexrest/ADvendio/ADvendio__Campaign_Item__c/ApplyPriceRules/ -H 'Authorization: Bearer ' -H \"Content-Type: application/json\" -H 'X-PrettyPrint:1' -d @requestBody.txt --request PATCH","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"requestBody.txt","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"campaignItems\": [\n {\n \"ADvendio__Ad_Price__c\": \"a0T7Y000005TxIWUA0\",\n \"ADvendio__from_Date__c\": \"2019-06-03\",\n \"ADvendio__until_Date__c\": \"2019-06-09\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"[\n {\n \"attributes\": {\n \"type\": \"ADvendio__Campaign_Item__c\"\n },\n \"ADvendio__from_Date__c\": \"2019-06-03\",\n \"ADvendio__until_Date__c\": \"2019-06-09\",\n \"ADvendio__Ad_Price__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Ad_price__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Ad_price__c/a0T7Y000005TxIWUA0\"\n },\n \"ADvendio__Ad_Spec__c\": \"a0R7Y00000Bi9JBUAZ\",\n \"Id\": \"a0T7Y000005TxIWUA0\",\n \"ADvendio__Ad_Spec__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Ad_Specs__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Ad_Specs__c/a0R7Y00000Bi9JBUAZ\"\n },\n \"Id\": \"a0R7Y00000Bi9JBUAZ\",\n \"ADvendio__Ad_Type__c\": \"a0S7Y00000JRcaDUAT\",\n \"ADvendio__Placement__c\": \"a2B7Y000001ox8RUAQ\",\n \"ADvendio__Ad_Type__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Ad_Type__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Ad_Type__c/a0S7Y00000JRcaDUAT\"\n },\n \"Id\": \"a0S7Y00000JRcaDUAT\"\n },\n \"ADvendio__Placement__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Placement__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Placement__c/a2B7Y000001ox8RUAQ\"\n },\n \"Id\": \"a2B7Y000001ox8RUAQ\",\n \"ADvendio__Site__c\": \"a2o7Y00000176LMQAY\",\n \"ADvendio__Site__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Site__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Site__c/a2o7Y00000176LMQAY\"\n },\n \"Id\": \"a2o7Y00000176LMQAY\"\n }\n }\n }\n },\n \"ADvendio__Rate_Discount_4__c\": 15.00,\n \"ADvendio__Ad_Price__c\": \"a0T7Y000005TxIWUA0\",\n \"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\\\"}]}\"\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Complex request","type":"text"}]},{"type":"paragraph","content":[{"text":"A more complex example to match the following Price Rule (additionally to more simple ones)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"a more complex Price Rule","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"{\n \"ADvendio__PriceRule__c\":{\n \"Id\":\"a2C7Y000001Ia6UUAS\",\n \"ADvendio__AdServerIdCategory__c\":\"Inventory\",\n \"ADvendio__FrequencyCapping__c\":true,\n \"ADvendio__DayTimeTargeting__c\":true,\n \"ADvendio__AdType__c\":\"a0GA000000mXrcMMAS\",\n \"ADvendio__Placement__c\":\"a1MA0000009rsHWMAY\",\n \"ADvendio__AdvertisingMedium__c\":\"a1kA0000002JIb0IAG\",\n \"ADvendio__WhereToApply__c\":\"ADvendio__Rate_Discount_2_custom__c\",\n \"ADvendio__Percentage__c\":\"99.00000000000\",\n \"CurrencyIsoCode\":\"EUR\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Call Dynamic Pricing web service","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl https://.my.salesforce.com/services/apexrest/ADvendio/ADvendio__Campaign_Item__c/ApplyPriceRules/ -H 'Authorization: Bearer ' -H \"Content-Type: application/json\" -H 'X-PrettyPrint:1' -d @requestBody.txt --request PATCH","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"requestBody.txt","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"campaignItems\":\n [\n {\n \"attributes\": {\n \"type\": \"ADvendio__Campaign_Item__c\",\n \"url\": \"/services/data/v46.0/sobjects/ADvendio__Campaign_Item__c/a0w7Y00000oiyH9QAI\"\n },\n \"Id\": \"a0w7Y00000oiyH9QAI\",\n \"ADvendio__from_Date__c\": \"2023-06-05\",\n \"ADvendio__until_Date__c\": \"2023-06-25\",\n \"ADvendio__Ad_Price__c\": \"a0T7Y000005TxIQUA0\",\n \"ADvendio__FrequencyCapping__c\": \"1 per 1 hour\",\n \"RecordTypeId\": \"0127Y000002Kg5VQAS\",\n \"ADvendio__AdServerTargeting__c\": \"{\\\"Inventory\\\":{\\\"type\\\":\\\"List\\\",\\\"logic\\\":\\\"&&\\\",\\\"valL\\\":[{\\\"type\\\":\\\"Id\\\",\\\"valS\\\":\\\"\\\"},{\\\"type\\\":\\\"Id\\\",\\\"valS\\\":\\\"a0L7Y00000FA7jyUAD\\\"}]}}\",\n \"CurrencyIsoCode\": \"EUR\",\n \"ADvendio__DayTimeTargeting__c\": \"{\\\"Wednesday\\\":[{\\\"hour\\\":\\\"12\\\"},{\\\"hour\\\":\\\"13\\\"},{\\\"hour\\\":\\\"14\\\"}],\\\"Thursday\\\":[{\\\"hour\\\":\\\"12\\\"},{\\\"hour\\\":\\\"13\\\"},{\\\"hour\\\":\\\"14\\\"}],\\\"Friday\\\":[{\\\"hour\\\":\\\"12\\\"},{\\\"hour\\\":\\\"13\\\"},{\\\"hour\\\":\\\"14\\\"}]}\"\n\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"[\n {\n \"attributes\": {\n \"type\": \"ADvendio__Campaign_Item__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Campaign_Item__c/a0w7Y00000oiyH9QAI\"\n },\n \"ADvendio__Ad_Price__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Ad_price__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Ad_price__c/a0T7Y000005TxIQUA0\"\n },\n \"ADvendio__Ad_Spec__c\": \"a0R7Y00000Bi9J6UAJ\",\n \"Id\": \"a0T7Y000005TxIQUA0\",\n \"ADvendio__Ad_Spec__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Ad_Specs__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Ad_Specs__c/a0R7Y00000Bi9J6UAJ\"\n },\n \"Id\": \"a0R7Y00000Bi9J6UAJ\",\n \"ADvendio__Ad_Type__c\": \"a0S7Y00000JRcaKUAT\",\n \"ADvendio__Placement__c\": \"a2B7Y000001ox8GUAQ\",\n \"ADvendio__Ad_Type__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Ad_Type__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Ad_Type__c/a0S7Y00000JRcaKUAT\"\n },\n \"Id\": \"a0S7Y00000JRcaKUAT\",\n \"ADvendio__AdServer_Login__c\": \"a0M7Y000008E9coUAC\",\n \"ADvendio__AdServer_Login__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__AdServer_Logins__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__AdServer_Logins__c/a0M7Y000008E9coUAC\"\n },\n \"Id\": \"a0M7Y000008E9coUAC\",\n \"RecordTypeId\": \"0127Y000002Kg4LQAS\",\n \"RecordType\": {\n \"attributes\": {\n \"type\": \"RecordType\",\n \"url\": \"/services/data/v45.0/sobjects/RecordType/0127Y000002Kg4LQAS\"\n },\n \"Id\": \"0127Y000002Kg4LQAS\",\n \"DeveloperName\": \"DFP\"\n }\n }\n },\n \"ADvendio__Placement__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Placement__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Placement__c/a2B7Y000001ox8GUAQ\"\n },\n \"Id\": \"a2B7Y000001ox8GUAQ\",\n \"ADvendio__Site__c\": \"a2o7Y00000176LGQAY\",\n \"ADvendio__Site__r\": {\n \"attributes\": {\n \"type\": \"ADvendio__Site__c\",\n \"url\": \"/services/data/v45.0/sobjects/ADvendio__Site__c/a2o7Y00000176LGQAY\"\n },\n \"Id\": \"a2o7Y00000176LGQAY\"\n }\n }\n }\n },\n \"CurrencyIsoCode\": \"EUR\",\n \"ADvendio__from_Date__c\": \"2023-06-05\",\n \"ADvendio__until_Date__c\": \"2023-06-25\",\n \"ADvendio__DayTimeTargeting__c\": \"{\\\"Wednesday\\\":[{\\\"hour\\\":\\\"12\\\"},{\\\"hour\\\":\\\"13\\\"},{\\\"hour\\\":\\\"14\\\"}],\\\"Thursday\\\":[{\\\"hour\\\":\\\"12\\\"},{\\\"hour\\\":\\\"13\\\"},{\\\"hour\\\":\\\"14\\\"}],\\\"Friday\\\":[{\\\"hour\\\":\\\"12\\\"},{\\\"hour\\\":\\\"13\\\"},{\\\"hour\\\":\\\"14\\\"}]}\",\n \"ADvendio__Rate_Discount_2_custom__c\": 99.00,\n \"RecordTypeId\": \"0127Y000002Kg5VQAS\",\n \"ADvendio__Ad_Price__c\": \"a0T7Y000005TxIQUA0\",\n \"ADvendio__AppliedPriceRules__c\": \"{\\\"UpdatedFields\\\":{\\\"ADvendio__Rate_Discount_2_custom__c\\\":\\\"99.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_2_custom__c\\\"}]}\",\n \"Id\": \"a0w7Y00000oiyH9QAI\",\n \"ADvendio__FrequencyCapping__c\": \"1 per 1 hour\",\n \"ADvendio__AdServerTargeting__c\": \"{\\\"Inventory\\\":{\\\"type\\\":\\\"List\\\",\\\"logic\\\":\\\"&&\\\",\\\"valL\\\":[{\\\"type\\\":\\\"Id\\\",\\\"valS\\\":\\\"\\\"},{\\\"type\\\":\\\"Id\\\",\\\"valS\\\":\\\"a0L7Y00000FA7jyUAD\\\"}]}}\"\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage in Apex","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"List cis = ...\ncis = ADvendio.DynamicPricing.applyPriceRules(cis);","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Dynamic Pricing API - Documentation

Table of Contents

Custom Matching criterion