Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Quoting Business APIs
Resources
Requests
Add Eligible Product Clause Input
Add Eligible Product Clause Options Input
Bulk Product Clause Input
Clause Generation Options Input
Instance Key Input
Insurance Get Eligible Clauses Input
Insurance Product Clause Input
Insurance Quote Config Options
Insurance Quote Options
Insurance Quote Related Record Input
Insurance Invoke Underwriting Rule Input
Insurance Quote Input Node
Insurance Quote Patch Input
Insurance Quote Post Input
Product Clause Update Input
Product Clause Variable Mapping Input
Product Rating Patch Input
Product Rating Post Input
Product Rating Request Input
Product Surcharge Bulk Post Input
Product Surcharge Patch Input
Product Surcharge Post Input
Product Clause Input
Rating Input Node
Rating Options Input
Responses
Insurance Quoting Standard Invocable Actions
Insurance Quoting Metadata API Types
Insurance Quoting Developer Journey
Insurance Apex Reference
Error Codes and Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Product Rating Request Input

Input representation for getting rating input from product IDs.
JSON example
1{
2  "productIds": [
3    "01txx0000006i3DAAQ"
4  ],
5  "salesTransactionTypeId": "0YWxx000000001GAAQ",
6  "transactionType": "Auto",
7  "ratingOptions": {
8    "executeConfigurationRules": true,
9    "executePricing": true,
10    "returnContextJSON": false,
11    "returnProductDetails": false
12  },
13  "effectiveDate": "2025-01-01T00:00:00.000Z",
14  "ratingDate": "2025-01-01T00:00:00.000Z",
15  "additionalFields": {
16    "customField1": "value1"
17  },
18  "rootProductCodes": [
19    "AUTO_POLICY"
20  ]
21}
Properties
Name Type Description Required or Optional Available Version
additionalFields Map<String, Object> Additional fields to generate rating input. Optional 66.0
effectiveDate Date Date that's used to find the active pricing procedure for pricing. The default value is the current date. Optional 66.0
productIds String[] IDs of the products for which you want to generate rating input. Required 66.0
ratingDate Date Date that's used to calculate rating. Optional 66.0
ratingOptions Rating Options Input Options to control rating behavior. Optional 66.0
rootProduct​Codes String[] Root product codes that are used to create rating inputs. Optional 66.0
salesTransaction​TypeId String ID of the sales transaction type for which you want to generate rating request payload. Optional 66.0
transaction​Type String Name of the transaction processing type. Optional 66.0