Chilkat Online Tools

phpAx / Salesforce Platform APIs / Create or Update Quote

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "pricingPref": "skip",
//   "graph": {
//     "graphId": "refQuoteGraph",
//     "records": [
//       {
//         "referenceId": "refQuote",
//         "record": {
//           "attributes": {
//             "type": "Quote",
//             "method": "POST"
//           },
//           "Name": "Quote_{{$randomCompanyName}}",
//           "Pricebook2Id": "{{standardPricebook}}"
//         }
//       },
//       {
//         "referenceId": "refQuoteLineItem1",
//         "record": {
//           "attributes": {
//             "type": "QuoteLineItem",
//             "method": "POST"
//           },
//           "QuoteId": "@{refQuote.id}",
//           "PricebookEntryId": "{{VirtualRouterTermedPBE}}",
//           "Product2Id": "{{VirtualRouterProduct}}",
//           "Quantity": 5.0,
//           "UnitPrice": 35.0,
//           "PeriodBoundary": "Anniversary",
//           "BillingFrequency": "Monthly",
//           "StartDate": "2023-01-01",
//           "EndDate": "2024-01-01"
//         }
//       },
//       {
//         "referenceId": "refQuoteLineItem2",
//         "record": {
//           "attributes": {
//             "type": "QuoteLineItem",
//             "method": "POST"
//           },
//           "QuoteId": "@{refQuote.id}",
//           "PricebookEntryId": "{{SLABronzeEvergrnMonthPBE}}",
//           "Product2Id": "{{SLA_BronzeProduct}}",
//           "Quantity": 1.0,
//           "UnitPrice": 10.0,
//           "PeriodBoundary": "DayOfPeriod",
//           "PeriodBoundaryDay": 4,
//           "BillingFrequency": "Monthly",
//           "StartDate": "2023-01-01"
//         }
//       }
//     ]
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('pricingPref','skip');
$json->UpdateString('graph.graphId','refQuoteGraph');
$json->UpdateString('graph.records[0].referenceId','refQuote');
$json->UpdateString('graph.records[0].record.attributes.type','Quote');
$json->UpdateString('graph.records[0].record.attributes.method','POST');
$json->UpdateString('graph.records[0].record.Name','Quote_{{$randomCompanyName}}');
$json->UpdateString('graph.records[0].record.Pricebook2Id','{{standardPricebook}}');
$json->UpdateString('graph.records[1].referenceId','refQuoteLineItem1');
$json->UpdateString('graph.records[1].record.attributes.type','QuoteLineItem');
$json->UpdateString('graph.records[1].record.attributes.method','POST');
$json->UpdateString('graph.records[1].record.QuoteId','@{refQuote.id}');
$json->UpdateString('graph.records[1].record.PricebookEntryId','{{VirtualRouterTermedPBE}}');
$json->UpdateString('graph.records[1].record.Product2Id','{{VirtualRouterProduct}}');
$json->UpdateNumber('graph.records[1].record.Quantity','5.0');
$json->UpdateNumber('graph.records[1].record.UnitPrice','35.0');
$json->UpdateString('graph.records[1].record.PeriodBoundary','Anniversary');
$json->UpdateString('graph.records[1].record.BillingFrequency','Monthly');
$json->UpdateString('graph.records[1].record.StartDate','2023-01-01');
$json->UpdateString('graph.records[1].record.EndDate','2024-01-01');
$json->UpdateString('graph.records[2].referenceId','refQuoteLineItem2');
$json->UpdateString('graph.records[2].record.attributes.type','QuoteLineItem');
$json->UpdateString('graph.records[2].record.attributes.method','POST');
$json->UpdateString('graph.records[2].record.QuoteId','@{refQuote.id}');
$json->UpdateString('graph.records[2].record.PricebookEntryId','{{SLABronzeEvergrnMonthPBE}}');
$json->UpdateString('graph.records[2].record.Product2Id','{{SLA_BronzeProduct}}');
$json->UpdateNumber('graph.records[2].record.Quantity','1.0');
$json->UpdateNumber('graph.records[2].record.UnitPrice','10.0');
$json->UpdateString('graph.records[2].record.PeriodBoundary','DayOfPeriod');
$json->UpdateInt('graph.records[2].record.PeriodBoundaryDay',4);
$json->UpdateString('graph.records[2].record.BillingFrequency','Monthly');
$json->UpdateString('graph.records[2].record.StartDate','2023-01-01');

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('Content-Type','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/services/data/v{{version}}/commerce/quotes/actions/place','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "pricingPref": "skip",
    "graph": {
        "graphId": "refQuoteGraph",
        "records": [
            {
                "referenceId": "refQuote",
                "record": {
                    "attributes": {
                        "type": "Quote",
                        "method": "POST"
                    },
                    "Name": "Quote_{{$randomCompanyName}}",
                    "Pricebook2Id": "{{standardPricebook}}"                    
                }
            },
            {
                "referenceId": "refQuoteLineItem1",
                "record": {
                    "attributes": {
                        "type": "QuoteLineItem",
                        "method": "POST"
                    },
                    "QuoteId": "@{refQuote.id}",
                    "PricebookEntryId": "{{VirtualRouterTermedPBE}}",
                    "Product2Id": "{{VirtualRouterProduct}}",
                    "Quantity": 5.0,
                    "UnitPrice": 35.0,
                    "PeriodBoundary": "Anniversary",
                    "BillingFrequency": "Monthly",
                    "StartDate": "2023-01-01",
                    "EndDate": "2024-01-01"                    
                }
            },
            {
                "referenceId": "refQuoteLineItem2",
                "record": {
                    "attributes": {
                        "type": "QuoteLineItem",
                        "method": "POST"
                    },
                    "QuoteId": "@{refQuote.id}",
                    "PricebookEntryId": "{{SLABronzeEvergrnMonthPBE}}",
                    "Product2Id": "{{SLA_BronzeProduct}}",
                    "Quantity": 1.0,
                    "UnitPrice": 10.0,
                    "PeriodBoundary": "DayOfPeriod",
                    "PeriodBoundaryDay": 4,
                    "BillingFrequency": "Monthly",
                    "StartDate": "2023-01-01"
                }
            }

        ]
    }
}'
https://domain.com/services/data/v{{version}}/commerce/quotes/actions/place

Postman Collection Item JSON

{
  "name": "Create or Update Quote",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"pricingPref\": \"skip\",\n    \"graph\": {\n        \"graphId\": \"refQuoteGraph\",\n        \"records\": [\n            {\n                \"referenceId\": \"refQuote\",\n                \"record\": {\n                    \"attributes\": {\n                        \"type\": \"Quote\",\n                        \"method\": \"POST\"\n                    },\n                    \"Name\": \"Quote_{{$randomCompanyName}}\",\n                    \"Pricebook2Id\": \"{{standardPricebook}}\"                    \n                }\n            },\n            {\n                \"referenceId\": \"refQuoteLineItem1\",\n                \"record\": {\n                    \"attributes\": {\n                        \"type\": \"QuoteLineItem\",\n                        \"method\": \"POST\"\n                    },\n                    \"QuoteId\": \"@{refQuote.id}\",\n                    \"PricebookEntryId\": \"{{VirtualRouterTermedPBE}}\",\n                    \"Product2Id\": \"{{VirtualRouterProduct}}\",\n                    \"Quantity\": 5.0,\n                    \"UnitPrice\": 35.0,\n                    \"PeriodBoundary\": \"Anniversary\",\n                    \"BillingFrequency\": \"Monthly\",\n                    \"StartDate\": \"2023-01-01\",\n                    \"EndDate\": \"2024-01-01\"                    \n                }\n            },\n            {\n                \"referenceId\": \"refQuoteLineItem2\",\n                \"record\": {\n                    \"attributes\": {\n                        \"type\": \"QuoteLineItem\",\n                        \"method\": \"POST\"\n                    },\n                    \"QuoteId\": \"@{refQuote.id}\",\n                    \"PricebookEntryId\": \"{{SLABronzeEvergrnMonthPBE}}\",\n                    \"Product2Id\": \"{{SLA_BronzeProduct}}\",\n                    \"Quantity\": 1.0,\n                    \"UnitPrice\": 10.0,\n                    \"PeriodBoundary\": \"DayOfPeriod\",\n                    \"PeriodBoundaryDay\": 4,\n                    \"BillingFrequency\": \"Monthly\",\n                    \"StartDate\": \"2023-01-01\"\n                }\n            }\n\n        ]\n    }\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/commerce/quotes/actions/place",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "commerce",
        "quotes",
        "actions",
        "place"
      ]
    },
    "description": "This example creates a quote for the following products.\n\n- 5 Virtual Routers sold on a 1-year termed subscription at $35/item\n- 1 Bronze Service Level Agreement sold on an evergreen subscription at $10/month\n    \n\nSee [place quote](https://developer.salesforce.com/docs/revenue/subscription-management/references/quotes?meta=Create+or+update+a+quote+with+place+quote)."
  },
  "response": [
  ]
}