Chilkat Online Tools

TCL / Salesforce Platform APIs / Calculate Price (New Sale with Discounts)

Back to Collection Items

load ./chilkat.dll

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

set http [new_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}}",
#   "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": "2024-01-01",
#           "ProductId": "{{VirtualRouterProduct}}",
#           "ProductSellingModelId": "{{TermMonthlyPSM}}",
#           "Quantity": 100.0,
#           "PricingTransactionType": "NewSale",
#           "CurrencyIsoCode": "USD"
#         }
#       },
#       {
#         "referenceId": "Order_Level_Discount",
#         "record": {
#           "attributes": {
#             "type": "PriceAdjustmentGroupShape"
#           },
#           "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
#           "AdjustmentType": "AdjustmentPercentage",
#           "AdjustmentValue": -20,
#           "AdjustmentSource": "Discretionary"
#         }
#       },
#       {
#         "referenceId": "Line_Level_Discount",
#         "record": {
#           "attributes": {
#             "type": "PriceAdjustmentItemShape"
#           },
#           "SalesTransactionItemShapeId": "@{Item_1_Evergreen.Id}",
#           "AdjustmentType": "AdjustmentAmount",
#           "AdjustmentValue": -10,
#           "AdjustmentSource": "Discretionary",
#           "AdjustmentAmountScope": "Unit"
#         }
#       }
#     ]
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "listPricebookId" "{{standardPricebook}}"
CkJsonObject_UpdateString $json "pricingFlow" "GET_PRICE_USING_CONTEXT"
CkJsonObject_UpdateString $json "graph.graphId" "1"
CkJsonObject_UpdateString $json "graph.records[0].referenceId" "ref_sales_txn"
CkJsonObject_UpdateString $json "graph.records[0].record.attributes.type" "SalesTransactionShape"
CkJsonObject_UpdateString $json "graph.records[0].record.CurrencyIsoCode" "USD"
CkJsonObject_UpdateString $json "graph.records[1].referenceId" "Item_1_Evergreen"
CkJsonObject_UpdateString $json "graph.records[1].record.attributes.type" "SalesTransactionItemShape"
CkJsonObject_UpdateString $json "graph.records[1].record.SalesTransactionShapeId" "@{ref_sales_txn.Id}"
CkJsonObject_UpdateString $json "graph.records[1].record.StartDate" "2023-01-01"
CkJsonObject_UpdateString $json "graph.records[1].record.ProductId" "{{SLA_BronzeProduct}}"
CkJsonObject_UpdateString $json "graph.records[1].record.ProductSellingModelId" "{{EvergreenMonthlyPSM}}"
CkJsonObject_UpdateNumber $json "graph.records[1].record.Quantity" "3.0"
CkJsonObject_UpdateString $json "graph.records[1].record.PricingTransactionType" "NewSale"
CkJsonObject_UpdateString $json "graph.records[1].record.CurrencyIsoCode" "USD"
CkJsonObject_UpdateString $json "graph.records[2].referenceId" "Item_2_Termed"
CkJsonObject_UpdateString $json "graph.records[2].record.attributes.type" "SalesTransactionItemShape"
CkJsonObject_UpdateString $json "graph.records[2].record.SalesTransactionShapeId" "@{ref_sales_txn.Id}"
CkJsonObject_UpdateString $json "graph.records[2].record.StartDate" "2023-01-01"
CkJsonObject_UpdateString $json "graph.records[2].record.EndDate" "2024-01-01"
CkJsonObject_UpdateString $json "graph.records[2].record.ProductId" "{{VirtualRouterProduct}}"
CkJsonObject_UpdateString $json "graph.records[2].record.ProductSellingModelId" "{{TermMonthlyPSM}}"
CkJsonObject_UpdateNumber $json "graph.records[2].record.Quantity" "100.0"
CkJsonObject_UpdateString $json "graph.records[2].record.PricingTransactionType" "NewSale"
CkJsonObject_UpdateString $json "graph.records[2].record.CurrencyIsoCode" "USD"
CkJsonObject_UpdateString $json "graph.records[3].referenceId" "Order_Level_Discount"
CkJsonObject_UpdateString $json "graph.records[3].record.attributes.type" "PriceAdjustmentGroupShape"
CkJsonObject_UpdateString $json "graph.records[3].record.SalesTransactionShapeId" "@{ref_sales_txn.Id}"
CkJsonObject_UpdateString $json "graph.records[3].record.AdjustmentType" "AdjustmentPercentage"
CkJsonObject_UpdateInt $json "graph.records[3].record.AdjustmentValue" -20
CkJsonObject_UpdateString $json "graph.records[3].record.AdjustmentSource" "Discretionary"
CkJsonObject_UpdateString $json "graph.records[4].referenceId" "Line_Level_Discount"
CkJsonObject_UpdateString $json "graph.records[4].record.attributes.type" "PriceAdjustmentItemShape"
CkJsonObject_UpdateString $json "graph.records[4].record.SalesTransactionItemShapeId" "@{Item_1_Evergreen.Id}"
CkJsonObject_UpdateString $json "graph.records[4].record.AdjustmentType" "AdjustmentAmount"
CkJsonObject_UpdateInt $json "graph.records[4].record.AdjustmentValue" -10
CkJsonObject_UpdateString $json "graph.records[4].record.AdjustmentSource" "Discretionary"
CkJsonObject_UpdateString $json "graph.records[4].record.AdjustmentAmountScope" "Unit"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/services/data/v{{version}}/commerce/pricing/salestransaction/actions/calculate-price" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

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": "2024-01-01",
                    "ProductId": "{{VirtualRouterProduct}}",
                    "ProductSellingModelId": "{{TermMonthlyPSM}}",
                    "Quantity": 100.0,
                    "PricingTransactionType": "NewSale",
                    "CurrencyIsoCode": "USD"
                }
            },
            {
                "referenceId": "Order_Level_Discount",
                "record": {
                    "attributes": {
                        "type": "PriceAdjustmentGroupShape"
                    },
                    "SalesTransactionShapeId": "@{ref_sales_txn.Id}",
                    "AdjustmentType": "AdjustmentPercentage",
                    "AdjustmentValue": -20,
                    "AdjustmentSource": "Discretionary"
                }
            },
            {
                "referenceId": "Line_Level_Discount",
                "record": {
                    "attributes": {
                        "type": "PriceAdjustmentItemShape"
                    },
                    "SalesTransactionItemShapeId": "@{Item_1_Evergreen.Id}",
                    "AdjustmentType": "AdjustmentAmount",
                    "AdjustmentValue": -10,
                    "AdjustmentSource": "Discretionary",
                    "AdjustmentAmountScope": "Unit"
                }
            }                        
        ]
    }
}'
https://domain.com/services/data/v{{version}}/commerce/pricing/salestransaction/actions/calculate-price

Postman Collection Item JSON

{
  "name": "Calculate Price (New Sale with Discounts)",
  "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\": \"2024-01-01\",\n                    \"ProductId\": \"{{VirtualRouterProduct}}\",\n                    \"ProductSellingModelId\": \"{{TermMonthlyPSM}}\",\n                    \"Quantity\": 100.0,\n                    \"PricingTransactionType\": \"NewSale\",\n                    \"CurrencyIsoCode\": \"USD\"\n                }\n            },\n            {\n                \"referenceId\": \"Order_Level_Discount\",\n                \"record\": {\n                    \"attributes\": {\n                        \"type\": \"PriceAdjustmentGroupShape\"\n                    },\n                    \"SalesTransactionShapeId\": \"@{ref_sales_txn.Id}\",\n                    \"AdjustmentType\": \"AdjustmentPercentage\",\n                    \"AdjustmentValue\": -20,\n                    \"AdjustmentSource\": \"Discretionary\"\n                }\n            },\n            {\n                \"referenceId\": \"Line_Level_Discount\",\n                \"record\": {\n                    \"attributes\": {\n                        \"type\": \"PriceAdjustmentItemShape\"\n                    },\n                    \"SalesTransactionItemShapeId\": \"@{Item_1_Evergreen.Id}\",\n                    \"AdjustmentType\": \"AdjustmentAmount\",\n                    \"AdjustmentValue\": -10,\n                    \"AdjustmentSource\": \"Discretionary\",\n                    \"AdjustmentAmountScope\": \"Unit\"\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 sales transaction, including a top-level and a line-level discount. The top-level discount specifies 20% off the entire sales transaction, while the line-level discount specifies $10 off the sales transaction item.\n\nIn this example, the sales transaction is an order and the sales transaction item is an order item."
  },
  "response": [
  ]
}