PureBasic / Salesforce Platform APIs / Calculate Price (New Sale Bundles)
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "listPricebookId": "{{standardPricebook}}",
; "candidatePricebookIds": [
; "{{standardPricebook}}"
; ],
; "pricingFlow": "GET_PRICE_USING_CONTEXT",
; "graph": {
; "graphId": "1",
; "records": [
; {
; "referenceId": "ref_sales_txn",
; "record": {
; "attributes": {
; "type": "SalesTransactionShape"
; },
; "CurrencyIsoCode": "USD"
; }
; },
; {
; "referenceId": "ref_sales_txn_item1",
; "record": {
; "attributes": {
; "type": "SalesTransactionItemShape"
; },
; "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
; "StartDate": "2022-01-01",
; "ProductId": "{{WorkAnywhereBundleProduct}}",
; "ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
; "Quantity": 10.0,
; "PricingTransactionType": "NewSale",
; "CurrencyIsoCode": "USD"
; }
; },
; {
; "referenceId": "ref_sales_txn_item2",
; "record": {
; "attributes": {
; "type": "SalesTransactionItemShape"
; },
; "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
; "StartDate": "2023-01-01",
; "ProductId": "{{VirtualRouterProduct}}",
; "ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
; "Quantity": 10.0,
; "PricingTransactionType": "NewSale",
; "CurrencyIsoCode": "USD"
; }
; },
; {
; "referenceId": "ref_sales_txn_item3",
; "record": {
; "attributes": {
; "type": "SalesTransactionItemShape"
; },
; "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
; "StartDate": "2023-01-01",
; "ProductId": "{{SLA_BronzeProduct}}",
; "ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
; "Quantity": 10.0,
; "PricingTransactionType": "NewSale",
; "CurrencyIsoCode": "USD"
; }
; },
; {
; "referenceId": "ref_sales_txn_item4",
; "record": {
; "attributes": {
; "type": "SalesTransactionItemShape"
; },
; "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
; "StartDate": "2023-01-01",
; "ProductId": "{{ClassTrainingProduct}}",
; "ProductSellingModelId": "{{OneTimePSM}}",
; "Quantity": 50.0,
; "PricingTransactionType": "NewSale",
; "CurrencyIsoCode": "USD"
; }
; },
; {
; "referenceId": "ref_rel1",
; "record": {
; "attributes": {
; "type": "SalesTrxnItemRelationShape"
; },
; "MainSalesTrxnItemShapeId": "@{ref_sales_txn_item1.Id}",
; "AssocSalesTrxnItemShapeId": "@{ref_sales_txn_item2.Id}",
; "MainSalesTrxnItemShapeRole": "Bundle",
; "AssocSalesTrxnItemShapeRole": "BundleComponent",
; "AssociatedItemShapePricing": "IncludedInBundlePrice"
; }
; },
; {
; "referenceId": "ref_rel2",
; "record": {
; "attributes": {
; "type": "SalesTrxnItemRelationShape"
; },
; "MainSalesTrxnItemShapeId": "@{ref_sales_txn_item1.Id}",
; "AssocSalesTrxnItemShapeId": "@{ref_sales_txn_item3.Id}",
; "MainSalesTrxnItemShapeRole": "Bundle",
; "AssocSalesTrxnItemShapeRole": "BundleComponent",
; "AssociatedItemShapePricing": "IncludedInBundlePrice"
; }
; },
; {
; "referenceId": "ref_rel3",
; "record": {
; "attributes": {
; "type": "SalesTrxnItemRelationShape"
; },
; "MainSalesTrxnItemShapeId": "@{ref_sales_txn_item1.Id}",
; "AssocSalesTrxnItemShapeId": "@{ref_sales_txn_item4.Id}",
; "MainSalesTrxnItemShapeRole": "Bundle",
; "AssocSalesTrxnItemShapeRole": "BundleComponent",
; "AssociatedItemShapePricing": "NotIncludedInBundlePrice"
; }
; }
; ]
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"listPricebookId","{{standardPricebook}}")
CkJsonObject::ckUpdateString(json,"candidatePricebookIds[0]","{{standardPricebook}}")
CkJsonObject::ckUpdateString(json,"pricingFlow","GET_PRICE_USING_CONTEXT")
CkJsonObject::ckUpdateString(json,"graph.graphId","1")
CkJsonObject::ckUpdateString(json,"graph.records[0].referenceId","ref_sales_txn")
CkJsonObject::ckUpdateString(json,"graph.records[0].record.attributes.type","SalesTransactionShape")
CkJsonObject::ckUpdateString(json,"graph.records[0].record.CurrencyIsoCode","USD")
CkJsonObject::ckUpdateString(json,"graph.records[1].referenceId","ref_sales_txn_item1")
CkJsonObject::ckUpdateString(json,"graph.records[1].record.attributes.type","SalesTransactionItemShape")
CkJsonObject::ckUpdateString(json,"graph.records[1].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[1].record.StartDate","2022-01-01")
CkJsonObject::ckUpdateString(json,"graph.records[1].record.ProductId","{{WorkAnywhereBundleProduct}}")
CkJsonObject::ckUpdateString(json,"graph.records[1].record.ProductSellingModelId","{{EvergreenMonthlyPSM}}")
CkJsonObject::ckUpdateNumber(json,"graph.records[1].record.Quantity","10.0")
CkJsonObject::ckUpdateString(json,"graph.records[1].record.PricingTransactionType","NewSale")
CkJsonObject::ckUpdateString(json,"graph.records[1].record.CurrencyIsoCode","USD")
CkJsonObject::ckUpdateString(json,"graph.records[2].referenceId","ref_sales_txn_item2")
CkJsonObject::ckUpdateString(json,"graph.records[2].record.attributes.type","SalesTransactionItemShape")
CkJsonObject::ckUpdateString(json,"graph.records[2].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[2].record.StartDate","2023-01-01")
CkJsonObject::ckUpdateString(json,"graph.records[2].record.ProductId","{{VirtualRouterProduct}}")
CkJsonObject::ckUpdateString(json,"graph.records[2].record.ProductSellingModelId","{{EvergreenMonthlyPSM}}")
CkJsonObject::ckUpdateNumber(json,"graph.records[2].record.Quantity","10.0")
CkJsonObject::ckUpdateString(json,"graph.records[2].record.PricingTransactionType","NewSale")
CkJsonObject::ckUpdateString(json,"graph.records[2].record.CurrencyIsoCode","USD")
CkJsonObject::ckUpdateString(json,"graph.records[3].referenceId","ref_sales_txn_item3")
CkJsonObject::ckUpdateString(json,"graph.records[3].record.attributes.type","SalesTransactionItemShape")
CkJsonObject::ckUpdateString(json,"graph.records[3].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[3].record.StartDate","2023-01-01")
CkJsonObject::ckUpdateString(json,"graph.records[3].record.ProductId","{{SLA_BronzeProduct}}")
CkJsonObject::ckUpdateString(json,"graph.records[3].record.ProductSellingModelId","{{EvergreenMonthlyPSM}}")
CkJsonObject::ckUpdateNumber(json,"graph.records[3].record.Quantity","10.0")
CkJsonObject::ckUpdateString(json,"graph.records[3].record.PricingTransactionType","NewSale")
CkJsonObject::ckUpdateString(json,"graph.records[3].record.CurrencyIsoCode","USD")
CkJsonObject::ckUpdateString(json,"graph.records[4].referenceId","ref_sales_txn_item4")
CkJsonObject::ckUpdateString(json,"graph.records[4].record.attributes.type","SalesTransactionItemShape")
CkJsonObject::ckUpdateString(json,"graph.records[4].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[4].record.StartDate","2023-01-01")
CkJsonObject::ckUpdateString(json,"graph.records[4].record.ProductId","{{ClassTrainingProduct}}")
CkJsonObject::ckUpdateString(json,"graph.records[4].record.ProductSellingModelId","{{OneTimePSM}}")
CkJsonObject::ckUpdateNumber(json,"graph.records[4].record.Quantity","50.0")
CkJsonObject::ckUpdateString(json,"graph.records[4].record.PricingTransactionType","NewSale")
CkJsonObject::ckUpdateString(json,"graph.records[4].record.CurrencyIsoCode","USD")
CkJsonObject::ckUpdateString(json,"graph.records[5].referenceId","ref_rel1")
CkJsonObject::ckUpdateString(json,"graph.records[5].record.attributes.type","SalesTrxnItemRelationShape")
CkJsonObject::ckUpdateString(json,"graph.records[5].record.MainSalesTrxnItemShapeId","@{ref_sales_txn_item1.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[5].record.AssocSalesTrxnItemShapeId","@{ref_sales_txn_item2.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[5].record.MainSalesTrxnItemShapeRole","Bundle")
CkJsonObject::ckUpdateString(json,"graph.records[5].record.AssocSalesTrxnItemShapeRole","BundleComponent")
CkJsonObject::ckUpdateString(json,"graph.records[5].record.AssociatedItemShapePricing","IncludedInBundlePrice")
CkJsonObject::ckUpdateString(json,"graph.records[6].referenceId","ref_rel2")
CkJsonObject::ckUpdateString(json,"graph.records[6].record.attributes.type","SalesTrxnItemRelationShape")
CkJsonObject::ckUpdateString(json,"graph.records[6].record.MainSalesTrxnItemShapeId","@{ref_sales_txn_item1.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[6].record.AssocSalesTrxnItemShapeId","@{ref_sales_txn_item3.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[6].record.MainSalesTrxnItemShapeRole","Bundle")
CkJsonObject::ckUpdateString(json,"graph.records[6].record.AssocSalesTrxnItemShapeRole","BundleComponent")
CkJsonObject::ckUpdateString(json,"graph.records[6].record.AssociatedItemShapePricing","IncludedInBundlePrice")
CkJsonObject::ckUpdateString(json,"graph.records[7].referenceId","ref_rel3")
CkJsonObject::ckUpdateString(json,"graph.records[7].record.attributes.type","SalesTrxnItemRelationShape")
CkJsonObject::ckUpdateString(json,"graph.records[7].record.MainSalesTrxnItemShapeId","@{ref_sales_txn_item1.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[7].record.AssocSalesTrxnItemShapeId","@{ref_sales_txn_item4.Id}")
CkJsonObject::ckUpdateString(json,"graph.records[7].record.MainSalesTrxnItemShapeRole","Bundle")
CkJsonObject::ckUpdateString(json,"graph.records[7].record.AssocSalesTrxnItemShapeRole","BundleComponent")
CkJsonObject::ckUpdateString(json,"graph.records[7].record.AssociatedItemShapePricing","NotIncludedInBundlePrice")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/commerce/pricing/salestransaction/actions/calculate-price","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"listPricebookId": "{{standardPricebook}}",
"candidatePricebookIds": [
"{{standardPricebook}}"
],
"pricingFlow": "GET_PRICE_USING_CONTEXT",
"graph": {
"graphId": "1",
"records": [
{
"referenceId": "ref_sales_txn",
"record": {
"attributes": {
"type": "SalesTransactionShape"
},
"CurrencyIsoCode": "USD"
}
},
{
"referenceId": "ref_sales_txn_item1",
"record": {
"attributes": {
"type": "SalesTransactionItemShape"
},
"SalesTransactionShapeId": "@{ref_sales_txn.Id}",
"StartDate": "2022-01-01",
"ProductId": "{{WorkAnywhereBundleProduct}}",
"ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
"Quantity": 10.0,
"PricingTransactionType": "NewSale",
"CurrencyIsoCode": "USD"
}
},
{
"referenceId": "ref_sales_txn_item2",
"record": {
"attributes": {
"type": "SalesTransactionItemShape"
},
"SalesTransactionShapeId": "@{ref_sales_txn.Id}",
"StartDate": "2023-01-01",
"ProductId": "{{VirtualRouterProduct}}",
"ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
"Quantity": 10.0,
"PricingTransactionType": "NewSale",
"CurrencyIsoCode": "USD"
}
},
{
"referenceId": "ref_sales_txn_item3",
"record": {
"attributes": {
"type": "SalesTransactionItemShape"
},
"SalesTransactionShapeId": "@{ref_sales_txn.Id}",
"StartDate": "2023-01-01",
"ProductId": "{{SLA_BronzeProduct}}",
"ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
"Quantity": 10.0,
"PricingTransactionType": "NewSale",
"CurrencyIsoCode": "USD"
}
},
{
"referenceId": "ref_sales_txn_item4",
"record": {
"attributes": {
"type": "SalesTransactionItemShape"
},
"SalesTransactionShapeId": "@{ref_sales_txn.Id}",
"StartDate": "2023-01-01",
"ProductId": "{{ClassTrainingProduct}}",
"ProductSellingModelId": "{{OneTimePSM}}",
"Quantity": 50.0,
"PricingTransactionType": "NewSale",
"CurrencyIsoCode": "USD"
}
},
{
"referenceId": "ref_rel1",
"record": {
"attributes": {
"type": "SalesTrxnItemRelationShape"
},
"MainSalesTrxnItemShapeId": "@{ref_sales_txn_item1.Id}",
"AssocSalesTrxnItemShapeId": "@{ref_sales_txn_item2.Id}",
"MainSalesTrxnItemShapeRole": "Bundle",
"AssocSalesTrxnItemShapeRole": "BundleComponent",
"AssociatedItemShapePricing": "IncludedInBundlePrice"
}
},
{
"referenceId": "ref_rel2",
"record": {
"attributes": {
"type": "SalesTrxnItemRelationShape"
},
"MainSalesTrxnItemShapeId": "@{ref_sales_txn_item1.Id}",
"AssocSalesTrxnItemShapeId": "@{ref_sales_txn_item3.Id}",
"MainSalesTrxnItemShapeRole": "Bundle",
"AssocSalesTrxnItemShapeRole": "BundleComponent",
"AssociatedItemShapePricing": "IncludedInBundlePrice"
}
},
{
"referenceId": "ref_rel3",
"record": {
"attributes": {
"type": "SalesTrxnItemRelationShape"
},
"MainSalesTrxnItemShapeId": "@{ref_sales_txn_item1.Id}",
"AssocSalesTrxnItemShapeId": "@{ref_sales_txn_item4.Id}",
"MainSalesTrxnItemShapeRole": "Bundle",
"AssocSalesTrxnItemShapeRole": "BundleComponent",
"AssociatedItemShapePricing": "NotIncludedInBundlePrice"
}
}
]
}
}'
https://domain.com/services/data/v{{version}}/commerce/pricing/salestransaction/actions/calculate-price
Postman Collection Item JSON
{
"name": "Calculate Price (New Sale Bundles)",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"listPricebookId\": \"{{standardPricebook}}\",\n \"candidatePricebookIds\": [\n \"{{standardPricebook}}\"\n ],\n \"pricingFlow\": \"GET_PRICE_USING_CONTEXT\",\n \"graph\": {\n \"graphId\": \"1\",\n \"records\": [\n {\n \"referenceId\": \"ref_sales_txn\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTransactionShape\"\n },\n \"CurrencyIsoCode\": \"USD\" \n }\n },\n {\n \"referenceId\": \"ref_sales_txn_item1\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTransactionItemShape\"\n },\n \"SalesTransactionShapeId\": \"@{ref_sales_txn.Id}\",\n \"StartDate\": \"2022-01-01\",\n \"ProductId\": \"{{WorkAnywhereBundleProduct}}\",\n \"ProductSellingModelId\": \"{{EvergreenMonthlyPSM}}\",\n \"Quantity\": 10.0,\n \"PricingTransactionType\": \"NewSale\",\n \"CurrencyIsoCode\": \"USD\" \n }\n },\n {\n \"referenceId\": \"ref_sales_txn_item2\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTransactionItemShape\"\n },\n \"SalesTransactionShapeId\": \"@{ref_sales_txn.Id}\",\n \"StartDate\": \"2023-01-01\",\n \"ProductId\": \"{{VirtualRouterProduct}}\",\n \"ProductSellingModelId\": \"{{EvergreenMonthlyPSM}}\",\n \"Quantity\": 10.0,\n \"PricingTransactionType\": \"NewSale\",\n \"CurrencyIsoCode\": \"USD\" \n }\n }, \n {\n \"referenceId\": \"ref_sales_txn_item3\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTransactionItemShape\"\n },\n \"SalesTransactionShapeId\": \"@{ref_sales_txn.Id}\",\n \"StartDate\": \"2023-01-01\",\n \"ProductId\": \"{{SLA_BronzeProduct}}\",\n \"ProductSellingModelId\": \"{{EvergreenMonthlyPSM}}\",\n \"Quantity\": 10.0,\n \"PricingTransactionType\": \"NewSale\",\n \"CurrencyIsoCode\": \"USD\" \n }\n },\n {\n \"referenceId\": \"ref_sales_txn_item4\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTransactionItemShape\"\n },\n \"SalesTransactionShapeId\": \"@{ref_sales_txn.Id}\",\n \"StartDate\": \"2023-01-01\",\n \"ProductId\": \"{{ClassTrainingProduct}}\",\n \"ProductSellingModelId\": \"{{OneTimePSM}}\",\n \"Quantity\": 50.0,\n \"PricingTransactionType\": \"NewSale\",\n \"CurrencyIsoCode\": \"USD\" \n }\n }, \n {\n \"referenceId\": \"ref_rel1\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTrxnItemRelationShape\"\n },\n \"MainSalesTrxnItemShapeId\": \"@{ref_sales_txn_item1.Id}\",\n \"AssocSalesTrxnItemShapeId\": \"@{ref_sales_txn_item2.Id}\",\n \"MainSalesTrxnItemShapeRole\": \"Bundle\",\n \"AssocSalesTrxnItemShapeRole\": \"BundleComponent\",\n \"AssociatedItemShapePricing\": \"IncludedInBundlePrice\"\n }\n },\n {\n \"referenceId\": \"ref_rel2\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTrxnItemRelationShape\"\n },\n \"MainSalesTrxnItemShapeId\": \"@{ref_sales_txn_item1.Id}\",\n \"AssocSalesTrxnItemShapeId\": \"@{ref_sales_txn_item3.Id}\",\n \"MainSalesTrxnItemShapeRole\": \"Bundle\",\n \"AssocSalesTrxnItemShapeRole\": \"BundleComponent\",\n \"AssociatedItemShapePricing\": \"IncludedInBundlePrice\"\n }\n },\n {\n \"referenceId\": \"ref_rel3\",\n \"record\": {\n \"attributes\": {\n \"type\": \"SalesTrxnItemRelationShape\"\n },\n \"MainSalesTrxnItemShapeId\": \"@{ref_sales_txn_item1.Id}\",\n \"AssocSalesTrxnItemShapeId\": \"@{ref_sales_txn_item4.Id}\",\n \"MainSalesTrxnItemShapeRole\": \"Bundle\",\n \"AssocSalesTrxnItemShapeRole\": \"BundleComponent\",\n \"AssociatedItemShapePricing\": \"NotIncludedInBundlePrice\"\n }\n } \n ]\n }\n}"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/commerce/pricing/salestransaction/actions/calculate-price",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"commerce",
"pricing",
"salestransaction",
"actions",
"calculate-price"
]
},
"description": "Calculate the price of the Work Anywhere software bundle plus all it's bundle components for the pricing period of 1 month. Because this bundle is sold on an evergreen subscription rather than a termed subscription, the price is calculated per month rather than for the length of the subscription.\n\nAdd one RelationShape for each bundle component. Note that the classroom training product is not included in the bundle price, while the other two bundle components are.\n\nSee [Calculate Price](https://desktop.postman.com/?desktopVersion=10.13.6&webVersion=10.13.7-ui-230522-1730&userId=10709048&teamId=0)."
},
"response": [
]
}
