Chilkat Online Tools

Ruby / Salesforce Platform APIs / Calculate Price (New Sale)

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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}}",
#   "pricingFlow": "GET_PRICE_USING_CONTEXT",
#   "graph": {
#     "graphId": "1",
#     "records": [
#       {
#         "referenceId": "ref_sales_txn",
#         "record": {
#           "attributes": {
#             "type": "SalesTransactionShape"
#           },
#           "CurrencyIsoCode": "USD"
#         }
#       },
#       {
#         "referenceId": "Item_1_Evergreen",
#         "record": {
#           "attributes": {
#             "type": "SalesTransactionItemShape"
#           },
#           "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
#           "StartDate": "2023-01-01",
#           "ProductId": "{{SLA_BronzeProduct}}",
#           "ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
#           "Quantity": 3.0,
#           "PricingTransactionType": "NewSale",
#           "CurrencyIsoCode": "USD"
#         }
#       },
#       {
#         "referenceId": "Item_2_Termed",
#         "record": {
#           "attributes": {
#             "type": "SalesTransactionItemShape"
#           },
#           "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
#           "StartDate": "2023-01-01",
#           "EndDate": "2023-12-31",
#           "ProductId": "{{VirtualRouterProduct}}",
#           "ProductSellingModelId": "{{TermMonthlyPSM}}",
#           "Quantity": 100.0,
#           "PricingTransactionType": "NewSale",
#           "CurrencyIsoCode": "USD"
#         }
#       }
#     ]
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("listPricebookId","{{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","Item_1_Evergreen")
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","2023-01-01")
json.UpdateString("graph.records[1].record.ProductId","{{SLA_BronzeProduct}}")
json.UpdateString("graph.records[1].record.ProductSellingModelId","{{EvergreenMonthlyPSM}}")
json.UpdateNumber("graph.records[1].record.Quantity","3.0")
json.UpdateString("graph.records[1].record.PricingTransactionType","NewSale")
json.UpdateString("graph.records[1].record.CurrencyIsoCode","USD")
json.UpdateString("graph.records[2].referenceId","Item_2_Termed")
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.EndDate","2023-12-31")
json.UpdateString("graph.records[2].record.ProductId","{{VirtualRouterProduct}}")
json.UpdateString("graph.records[2].record.ProductSellingModelId","{{TermMonthlyPSM}}")
json.UpdateNumber("graph.records[2].record.Quantity","100.0")
json.UpdateString("graph.records[2].record.PricingTransactionType","NewSale")
json.UpdateString("graph.records[2].record.CurrencyIsoCode","USD")

# 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() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "listPricebookId": "{{standardPricebook}}",
    "pricingFlow": "GET_PRICE_USING_CONTEXT",
    "graph": {
        "graphId": "1",
        "records": [
            {
                "referenceId": "ref_sales_txn",
                "record": {
                    "attributes": {
                        "type": "SalesTransactionShape"
                    },
                    "CurrencyIsoCode": "USD"
                }
            },
            {
                "referenceId": "Item_1_Evergreen",
                "record": {
                    "attributes": {
                        "type": "SalesTransactionItemShape"
                    },
                    "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
                    "StartDate": "2023-01-01",
                    "ProductId": "{{SLA_BronzeProduct}}",
                    "ProductSellingModelId": "{{EvergreenMonthlyPSM}}",
                    "Quantity": 3.0,
                    "PricingTransactionType": "NewSale",
                    "CurrencyIsoCode": "USD"
                }
            },
            {
                "referenceId": "Item_2_Termed",
                "record": {
                    "attributes": {
                        "type": "SalesTransactionItemShape"
                    },
                    "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
                    "StartDate": "2023-01-01",
                    "EndDate": "2023-12-31",
                    "ProductId": "{{VirtualRouterProduct}}",
                    "ProductSellingModelId": "{{TermMonthlyPSM}}",
                    "Quantity": 100.0,
                    "PricingTransactionType": "NewSale",
                    "CurrencyIsoCode": "USD"
                }
            }
        ]
    }
}'
https://domain.com/services/data/v{{version}}/commerce/pricing/salestransaction/actions/calculate-price

Postman Collection Item JSON

{
  "name": "Calculate Price (New Sale)",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"listPricebookId\": \"{{standardPricebook}}\",\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\": \"Item_1_Evergreen\",\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\": 3.0,\n                    \"PricingTransactionType\": \"NewSale\",\n                    \"CurrencyIsoCode\": \"USD\"\n                }\n            },\n            {\n                \"referenceId\": \"Item_2_Termed\",\n                \"record\": {\n                    \"attributes\": {\n                        \"type\": \"SalesTransactionItemShape\"\n                    },\n                    \"SalesTransactionShapeId\": \"@{ref_sales_txn.Id}\",\n                    \"StartDate\": \"2023-01-01\",\n                    \"EndDate\": \"2023-12-31\",\n                    \"ProductId\": \"{{VirtualRouterProduct}}\",\n                    \"ProductSellingModelId\": \"{{TermMonthlyPSM}}\",\n                    \"Quantity\": 100.0,\n                    \"PricingTransactionType\": \"NewSale\",\n                    \"CurrencyIsoCode\": \"USD\"\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 a new sale that contains two order items: a term-defined subscription order for a bronze-level SLA, and an evergreen subscription order for a virtual router. The payload for the term-defined order contains both a start date and an end date. Instead of an end date, you can also include a start date and a subscription term.\n\nSee [Calculate Price](https://developer.salesforce.com/docs/revenue/subscription-management/references/prices?meta=Summary)."
  },
  "response": [
  ]
}