Insurance Quote Details (GET, PATCH)

Get or update quote details by the specified quote ID.

You can get the desired quote details by using the filter and non-filter request parameters. Use the term filter to differentiate between the filter and non-filter parameters. See, Resource example.

A filter parameter is used to show the results that match a certain criteria, for example ProductSpec=InsuredItem shows the quote details for the insured item only. A non-filter parameter controls the behavior or format of the response, for example returnChildrenNodes=true shows the child nodes of the SalesTransactionItem. In the default context definition, a SalesTransactionItem in context represents a QuoteLineItem.

Note

These are the operators that are supported to filter the results.

  • eq—Equal
  • ne—Not equal
  • lt—Less than
  • lte—Less than or equal to
  • gt—Greater than
  • gte—Greater than or equal to

Resource 

{quoteId} is a placeholder.

1/connect/insurance/quotes/{quoteId}
1/connect/insurance/quotes/{quoteId}?contextId=[value]filter[field1][operator1]=[value1]&filter[field2][operator2]=[value2]&key1=value1&includeClause=true

The field1 parameter refers to the ProductSpec filter parameter, and the field2 parameter refers to the valid context attribute of SalesTransactionItem in the target context definition. You can add multiple filter and non-filter parameters to get the desired result.

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quotes/0Q0DR0000000xFw0AI
1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quotes/0Q0DR0000000xFw0AI?contextId=0000000i18tq18g002917545349255616564529f415d45c4b1b1ea08747a2195&filter[ProductSpec][eq]=InsuredItem&filter[DYN__Auto_Value][gt]=60000&returnChildrenNodes=true&includeClause=true

Available Version 

63.0

HTTP Methods 

GET, PATCH

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
connectDynamicParametersMap<String,String>Specify these filter and non-filter request parameters to get the desired results.
  • contextId—Non-filter parameter to get the quote details for the specified context ID.
  • ProductSpec—Filter parameter to get the quote details for the specified product spec. Valid values are:
    • Coverage
    • InsuredItem
    • InsuredParty
    • Product
  • returnChildrenNodes—Non-filter parameter that retrieves all the SalesTransactionItems in the hierarchy, starting from each matching SalesTransactionItem and includes all child nodes.
    Use the returnChildrenNodes parameter with filter parameters.
  • includeClause—Non-filter parameter that includes the associated product clauses of the SalesTransactionItems in the response body.
    Use the includeClause parameter with filter parameters.
Optional63.0

Response Body for GET 

Get Quote

Request Body for PATCH 

JSON Example 

1{
2  "configOptions": {
3    "executePricing": false,
4    "validateProductCatalog": false,
5    "executeConfigurationRules": false,
6    "executeQualificationRules": false
7  },
8  "additionalFields": {
9    "Status": "Draft",
10    "ValidFromDate": "2025-10-29T00:00:00.000Z"
11  },
12  "addedNodes": [
13    {
14      "productCode": "autoCollision",
15      "instanceKeys": [
16        "autoBundle",
17        "autoCollision"
18      ],
19      "additionalFields": {
20        "StartDate": "2025-09-29T00:00:00.000Z",
21        "EndDate": "2025-10-29T00:00:00.000Z",
22        "Discount": 40
23      }
24    }
25  ],
26  "updatedNodes": [
27    {
28      "instanceKeys": [
29        "autoBundle"
30      ],
31      "productCode": "autoBundle",
32      "attributes": {
33        "avMake": "AudiQ14"
34      },
35      "additionalFields": {
36        "StartDate": "2025-09-29T00:00:00.000Z",
37        "EndDate": "2025-10-29T00:00:00.000Z",
38        "Discount": 50
39      }
40    }
41  ]
42}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
addedNodesInsurance Quote Input Node[]List of added nodes for insurance quote.Optional63.0
additionalFieldsMap<String, Object>Insurance quote additional fields.Optional63.0
configOptionsInsurance Quote Config Options []Configurator options for insurance quote.Optional63.0
deletedNodesInsurance Quote Input Node[]List of deleted nodes from insurance quote.Optional63.0
pricingProcedureStringPricing procedure for insurance quote.Optional63.0
updatedNodesInsurance Quote Input Node[]List of updated nodes on insurance quote.Optional63.0

Response Body for PATCH 

Insurance Quote