Insurance Product Rating (POST, PATCH)

Rate products or update product ratings for use in Insurance quoting processes.

Resource

1/connect/insurance/product-rating

Resource example

1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/product-rating

Available version

63.0

HTTP methods

PATCH, POST

Request body for PATCH

JSON example

1{
2           "contextId": "11jxx0000006i5gAAA",
3           "productId": "01txx0000006i5gAAA",
4           "ratingInputs": [{
5               "instanceKeys": ["AutoRoot"],
6               "productCode": "AUTOROOT",
7               "attributes": {
8                  "Deductible": 1000
9               }
10          },
11          {
12              "instanceKeys": ["AutoRoot", "Audi"],
13              "productCode": "AUTO",
14              "attributes": {
15                  "Mileage": 20000
16              }
17          },
18          {
19              "instanceKeys": ["AutoRoot", "Audi", "Tom"],
20              "productCode": "DRIVER",
21              "attributes": {
22                  "DriverAge": 50,
23                  "DriverAccident": 0
24              },
25              "targetRecords": ["003xx000004WkvEAAS"]
26          }],
27          "ratingOptions": {
28              "pricingProcedure": "AutoRootEP"
29          }
30       }

Properties

Name	Type	Description	Required or Optional	Available Version
`addedNodes`	Rating Input Node[]	List of added nodes.	Optional	63.0
`additionalFields`	Map<String, Object>	Map of additional fields that must be updated in the quote context.	Optional	63.0
`contextId`	String	Context ID.	Required	63.0
`deletedNodes`	Rating Input Node[]	List of deleted nodes.	Optional	63.0
`effectiveDate`	String	Date used to find the active pricing procedure for pricing. The default value is the current date.	Optional	63.0
`ratingDate`	String	Date that's used to find the active pricing procedure.	Optional	63.0
`ratingOptions`	Rating Options Input[]	Options for rating.	Required	63.0
`updatedNodes`	Rating Input Node[]	List of updated nodes.	Optional	63.0

Response body for PATCH

Product Rating

Request body for POST

JSON example

1{
2           "contextId": "11jxx0000006i5gAAA",
3           "productId": "01txx0000006i5gAAA",
4           "ratingInputs": [{
5               "instanceKeys": ["AutoRoot"],
6               "productCode": "AUTOROOT",
7               "attributes": {
8                  "Deductible": 1000
9               }
10          },
11          {
12              "instanceKeys": ["AutoRoot", "Audi"],
13              "productCode": "AUTO",
14              "attributes": {
15                  "Mileage": 20000
16              }
17          },
18          {
19              "instanceKeys": ["AutoRoot", "Audi", "Tom"],
20              "productCode": "DRIVER",
21              "attributes": {
22                  "DriverAge": 50,
23                  "DriverAccident": 0
24              },
25              "targetRecords": ["003xx000004WkvEAAS"]
26          }],
27          "ratingOptions": {
28              "pricingProcedure": "AutoRootEP"
29          }
30       }

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalFields`	Map<String, Object>	Map of additional fields that must be updated in the quote context.	Optional	63.0
`effectiveDate`	String	Date used to find the active pricing procedure for pricing. The default value is the current date.	Optional	63.0
`productId`	String	ID of the root product.	Required	63.0
`ratingDate`	String	Date used to find the active pricing procedure.	Optional	63.0
`ratingInputs`	Rating Input Node[]	The input JSON that contains the attribute values of each context node.	Required	63.0
`ratingOptions`	Rating Options Input[]	The options for rating.	Required	63.0
`salesTransactionTypeId`	String	ID of the sales transaction type.	Optional	63.0
`transactionType`	String	ID of the transaction type.	Optional	63.0

Response body for POST

Product Rating Output

Insurance Developer Guide

Insurance Product Rating (POST, PATCH)