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
`rootProductCodes`	String[]	Root product codes that are used to create rating inputs.	Optional	66.0
`salesTransactionTypeId`	String	ID of the sales transaction type for which you want to generate rating request payload.	Optional	66.0
`transactionType`	String	Name of the transaction processing type.	Optional	66.0