Insurance Product Rating (POST, PATCH)

Rate products or update product ratings in insurance quoting processes.

Resource

/connect/insurance/product-rating

Resource Example

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

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-rating

Available Version

63.0

HTTP Methods

POST, PATCH

Request Body for POST

JSON Example

{
  "transactionType": "AutoTransactionType",
  "additionalFields": {
    "QuoteAccount": "001ZM000002ZNnBYAW"
  },
  "ratingOptions": {
    "executeConfigurationRules": false
  },
  "ratingInputs": [
    {
      "productCode": "auto",
      "instanceKeys": [
        "Auto1"
      ],
      "attributes": {
        "Make": "BMW",
        "AutoValue": "20000",
        "Year": "2024",
        "Model": "SUV"
      }
    },
    {
      "productCode": "comprehensive",
      "instanceKeys": [
        "Auto1",
        "Comprehensive"
      ],
      "attributes": {
        "Limit": "2000",
        "Deductible": "100"
      }
    }
  ],
  "rootProductCodes": [
    "auto-ECO1x",
    "auto-ECO2x"
  ]
}

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.	Required if the generated context ID is used to issue a policy	63.0
`effectiveDate`	String	Date used to find the active pricing procedure for pricing. The default value is the current date.	Optional	63.0
`ratingInputs`	Rating Input Node[]	JSON that contains the attribute values of each context node.	Required	63.0
`ratingOptions`	Rating Options Input[]	Options for rating.	Optional	63.0
`rootProductCodes`	String []	Root product codes that are used with the `ratingInputs` to create rating result. The created rating result is used as request in the insurance product rating API.	Optional	66.0
`transactionType`	String	Name of the transaction processing type.	Required	63.0

Response Body for POST

Product Rating Response

Request Body for PATCH

JSON Example

{
  "contextId": "a49103b233638b918217c74eced69220e534e160c3d3d35bc8cf6608515aeab3",
  "ratingOptions": {
    "executePricing": true,
    "executeConfigurationRules": false
  },
  "updatedNodes": [
    {
      "instanceKeys": [
        "AutoSilver",
        "BMW",
        "Tim1"
      ],
      "productCode": "driver",
      "attributes": {
        "DriverAccidentPoints": 1,
        "AgeFirstLicensed": 50,
        "DriverMVRPoints": 1
      },
      "targetRecords": [
        "003DR000002ov8NYAQ",
        "001DR000003avQCYAY"
      ]
    }
  ],
  "addedNodes": [
    {
      "instanceKeys": [
        "AutoSilver",
        "Tesla"
      ],
      "productCode": "auto",
      "attributes": {
        "Year": "2022",
        "Model": "Y"
      }
    },
    {
      "instanceKeys": [
        "AutoSilver",
        "Tesla",
        "collision1"
      ],
      "productCode": "collision",
      "attributes": {
        "Limit": 500,
        "Deductible": 1000
      }
    },
    {
      "instanceKeys": [
        "AutoSilver",
        "Tesla",
        "Driver1"
      ],
      "productCode": "driver",
      "attributes": {
        "DriverAccidentPoints": 5,
        "AgeFirstLicensed": 30,
        "DriverMVRPoints": 1
      },
      "targetRecords": [
        "003DR000002oxCfYAI",
        "001DR000003azdpYAA"
      ]
    },
    {
      "instanceKeys": [
        "AutoSilver",
        "Audi",
        "Collision2"
      ],
      "productCode": "collision",
      "attributes": {
        "Limit": 500,
        "Deductible": 1000
      }
    }
  ]
}

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.	Optional	63.0
`updatedNodes`	Rating Input Node[]	List of updated nodes.	Optional	63.0

Response Body for PATCH

Product Rating Response