Chilkat Online Tools

Python / Salesforce Platform APIs / Calculate Price (New Sale Bundles)

Back to Collection Items

import sys
import chilkat

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat.CkHttp()

# 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 = chilkat.CkJsonObject()
json.UpdateString("listPricebookId","{{standardPricebook}}")
json.UpdateString("candidatePricebookIds[0]","{{standardPricebook}}")
json.UpdateString("pricingFlow","GET_PRICE_USING_CONTEXT")
json.UpdateString("graph.graphId","1")
json.UpdateString("graph.records[0].referenceId","ref_sales_txn")
json.UpdateString("graph.records[0].record.attributes.type","SalesTransactionShape")
json.UpdateString("graph.records[0].record.CurrencyIsoCode","USD")
json.UpdateString("graph.records[1].referenceId","ref_sales_txn_item1")
json.UpdateString("graph.records[1].record.attributes.type","SalesTransactionItemShape")
json.UpdateString("graph.records[1].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
json.UpdateString("graph.records[1].record.StartDate","2022-01-01")
json.UpdateString("graph.records[1].record.ProductId","{{WorkAnywhereBundleProduct}}")
json.UpdateString("graph.records[1].record.ProductSellingModelId","{{EvergreenMonthlyPSM}}")
json.UpdateNumber("graph.records[1].record.Quantity","10.0")
json.UpdateString("graph.records[1].record.PricingTransactionType","NewSale")
json.UpdateString("graph.records[1].record.CurrencyIsoCode","USD")
json.UpdateString("graph.records[2].referenceId","ref_sales_txn_item2")
json.UpdateString("graph.records[2].record.attributes.type","SalesTransactionItemShape")
json.UpdateString("graph.records[2].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
json.UpdateString("graph.records[2].record.StartDate","2023-01-01")
json.UpdateString("graph.records[2].record.ProductId","{{VirtualRouterProduct}}")
json.UpdateString("graph.records[2].record.ProductSellingModelId","{{EvergreenMonthlyPSM}}")
json.UpdateNumber("graph.records[2].record.Quantity","10.0")
json.UpdateString("graph.records[2].record.PricingTransactionType","NewSale")
json.UpdateString("graph.records[2].record.CurrencyIsoCode","USD")
json.UpdateString("graph.records[3].referenceId","ref_sales_txn_item3")
json.UpdateString("graph.records[3].record.attributes.type","SalesTransactionItemShape")
json.UpdateString("graph.records[3].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
json.UpdateString("graph.records[3].record.StartDate","2023-01-01")
json.UpdateString("graph.records[3].record.ProductId","{{SLA_BronzeProduct}}")
json.UpdateString("graph.records[3].record.ProductSellingModelId","{{EvergreenMonthlyPSM}}")
json.UpdateNumber("graph.records[3].record.Quantity","10.0")
json.UpdateString("graph.records[3].record.PricingTransactionType","NewSale")
json.UpdateString("graph.records[3].record.CurrencyIsoCode","USD")
json.UpdateString("graph.records[4].referenceId","ref_sales_txn_item4")
json.UpdateString("graph.records[4].record.attributes.type","SalesTransactionItemShape")
json.UpdateString("graph.records[4].record.SalesTransactionShapeId","@{ref_sales_txn.Id}")
json.UpdateString("graph.records[4].record.StartDate","2023-01-01")
json.UpdateString("graph.records[4].record.ProductId","{{ClassTrainingProduct}}")
json.UpdateString("graph.records[4].record.ProductSellingModelId","{{OneTimePSM}}")
json.UpdateNumber("graph.records[4].record.Quantity","50.0")
json.UpdateString("graph.records[4].record.PricingTransactionType","NewSale")
json.UpdateString("graph.records[4].record.CurrencyIsoCode","USD")
json.UpdateString("graph.records[5].referenceId","ref_rel1")
json.UpdateString("graph.records[5].record.attributes.type","SalesTrxnItemRelationShape")
json.UpdateString("graph.records[5].record.MainSalesTrxnItemShapeId","@{ref_sales_txn_item1.Id}")
json.UpdateString("graph.records[5].record.AssocSalesTrxnItemShapeId","@{ref_sales_txn_item2.Id}")
json.UpdateString("graph.records[5].record.MainSalesTrxnItemShapeRole","Bundle")
json.UpdateString("graph.records[5].record.AssocSalesTrxnItemShapeRole","BundleComponent")
json.UpdateString("graph.records[5].record.AssociatedItemShapePricing","IncludedInBundlePrice")
json.UpdateString("graph.records[6].referenceId","ref_rel2")
json.UpdateString("graph.records[6].record.attributes.type","SalesTrxnItemRelationShape")
json.UpdateString("graph.records[6].record.MainSalesTrxnItemShapeId","@{ref_sales_txn_item1.Id}")
json.UpdateString("graph.records[6].record.AssocSalesTrxnItemShapeId","@{ref_sales_txn_item3.Id}")
json.UpdateString("graph.records[6].record.MainSalesTrxnItemShapeRole","Bundle")
json.UpdateString("graph.records[6].record.AssocSalesTrxnItemShapeRole","BundleComponent")
json.UpdateString("graph.records[6].record.AssociatedItemShapePricing","IncludedInBundlePrice")
json.UpdateString("graph.records[7].referenceId","ref_rel3")
json.UpdateString("graph.records[7].record.attributes.type","SalesTrxnItemRelationShape")
json.UpdateString("graph.records[7].record.MainSalesTrxnItemShapeId","@{ref_sales_txn_item1.Id}")
json.UpdateString("graph.records[7].record.AssocSalesTrxnItemShapeId","@{ref_sales_txn_item4.Id}")
json.UpdateString("graph.records[7].record.MainSalesTrxnItemShapeRole","Bundle")
json.UpdateString("graph.records[7].record.AssocSalesTrxnItemShapeRole","BundleComponent")
json.UpdateString("graph.records[7].record.AssociatedItemShapePricing","NotIncludedInBundlePrice")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/commerce/pricing/salestransaction/actions/calculate-price","application/json",json)
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

print(str(resp.get_StatusCode()))
print(resp.bodyStr())

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": [
  ]
}