Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Product Rating Response

Output representation for the Product Rating Connect API.
JSON example
This example shows a sample success response.
1{
2  "contextId": "11jxx0000006i5gAAA",
3  "pricingResult": {
4    "Economy Renter 1": {
5      "NetUnitPrice": 1000,
6      "childNodes": []
7    },
8    "Economy Renter 2": {
9      "NetUnitPrice": 2000,
10      "childNodes": []
11    }
12  },
13  "contextJSON": {
14    "SalesTransaction": [
15      {
16        "Account": null,
17        "businessObjectType": "Quote",
18        "SalesTransactionName": "Test Quote",
19        "ProratedAmount": 112.25,
20        "StartDate": "2025-07-01",
21        "CurrencyIsoCode__std": "USD",
22        "InsuranceQuoteType": "New Business",
23        "TransactionType": "AutoTransactionType",
24        "TotalProratedAmount": 132.25,
25        "Pricebook": "01sSG000009SJvNYAW",
26        "Opportunity": null,
27        "TotalAmount": 277.15,
28        "EndDate": "2025-08-31",
29        "SalesTransactionItem": [
30          {
31            "businessObjectType": "QuoteLineItem",
32            "Product": "01tSG000008KnvSYAS",
33            "id": "0QLSG000000dIxz4AE",
34            "ProductCode": "Auto Silver",
35            "SalesTransactionItemAttribute": [
36              {
37                "AttributeKey": "0tjSG0000006q8GYAQ",
38                "AttributeValue": "6.0",
39                "ParentReference": "0QLSG000000dIxy4AE",
40                "hasObjectRef": null,
41                "AttributePicklistValue": null,
42                "IsPriceImpacting": null,
43                "businessObjectType": "QuoteLineItemAttribute",
44                "AttributeName": "Driver MVR Points",
45                "id": "0zuSG000002IfoSYAS",
46                "AttributeDefinitionCode": "DriverMVRPoints",
47                "SalesTransactionItemAttrParent": "0QLSG000000dIxy4AE",
48                "AttributeDeveloperName": "Driver_MVR_Points"
49              }
50            ],
51            "LineItemPath": "0QLSG000000dIy04AE/0QLSG000000dIxz4AE",
52            "PricebookEntry": "01uSG000003chfXYAQ",
53            "NetUnitPrice": 79.77,
54            "ParentReference": "0Q0SG000000P3XN0A0",
55            "UnitPrice": 469.6,
56            "InstanceKey": "673ec36c-7d4a-4e8a-999a-6cf16a299f4a",
57            "childNodes": [
58              {
59                "businessObjectType": "QuoteLineItem",
60                "Product": "01tSG000008KnvSYAS",
61                "id": "0QLSG000000dIxz4AE",
62                "ProductCode": "medPay",
63                "SalesTransactionItemAttribute": [],
64                "childNodes": []
65              }
66            ]
67          }
68        ],
69        "TotalStandardAmount": 680.8
70      }
71    ]
72  },
73  "productDetails": {
74    "auto": {
75      "attributeCategories": [
76        {
77          "attributes": [
78            {
79              "attributeCategoryId": "0v3SG0000001ZToYAM",
80              "attributeNameOverride": "Bodily Injury Per Person Limit",
81              "attributePicklist": {
82                "id": "0v5SG0000004YXzYAM",
83                "values": [
84                  {
85                    "code": "BIPD500",
86                    "displayValue": "$500",
87                    "id": "0v6SG0000006Vl2YAE",
88                    "name": "BIPD500",
89                    "sequence": 1,
90                    "status": "Active",
91                    "textValue": "500.0"
92                  }
93                ]
94              },
95              "code": "BodilyInjuryPerPersonLimit",
96              "dataType": "PICKLIST",
97              "developerName": "Bodily_Injury_Per_Person_Limit",
98              "id": "0tjSG0000006q7RYAQ",
99              "isCloneable": false,
100              "isConfigurable": false,
101              "isHidden": true,
102              "isPriceImpacting": false,
103              "isReadOnly": false,
104              "isRequired": false,
105              "label": "Bodily Injury Per Person Limit",
106              "name": "Bodily Injury Per Person Limit",
107              "status": "Active"
108            }
109          ],
110          "code": "Auto Term",
111          "name": "Auto Term"
112        }
113      ],
114      "id": "01tSG000008KnvBYAS",
115      "isActive": true,
116      "isAssetizable": true,
117      "isConfigurable": true,
118      "isSoldOnlyWithOtherProds": false,
119      "name": "Auto",
120      "nodeType": "bundleProduct",
121      "productClassification": {
122        "id": "11BSG00000LARcM2AX"
123      },
124      "productCode": "auto"
125    }
126  },
127  "uiTreatments": [
128    {
129      "details": {
130        "attributeId": "0tjxx0000000007AAA",
131        "stiId": "0QLxx0000004CU0GAM",
132        "attributePicklistValueId": "0v6xx0000000005AAA"
133      },
134      "uiTreatmentTarget": "Attribute_Picklist_Value",
135      "uiTreatmentType": "Hide"
136    },
137    {
138      "details": {
139        "stiId": "ref_f0f2da7b_c431_482d_bf4b_599052f3a2e1"
140      },
141      "uiTreatmentTarget": "Component",
142      "uiTreatmentType": "Disable"
143    }
144  ],
145  "ratingResult": {
146    "childNodes": [
147      {
148        "childNodes": [
149          {
150            "childNodes": [],
151            "details": {
152              "NetUnitPrice": 590.4,
153              "InstanceKey": "bipd1",
154              "ProductCode": "bipd",
155              "NetTotalPrice": 590.4,
156              "ProratedQLITaxAmount": 0
157            }
158          }
159        ],
160        "details": {
161          "NetUnitPrice": 1485.84,
162          "InstanceKey": "AutoSilver",
163          "ProductCode": "autoSilver",
164          "NetTotalPrice": 1485.84,
165          "ProratedQLITaxAmount": 0
166        }
167      }
168    ]
169  }
170}
Property Name Type Description Filter Group and Version Available Version
configMessages Insurance Config Message[] List of configurator messages. Small, 63.0 63.0
contextId String ID of the context. Small, 61.0 61.0
contextJSON Context JSON[] Serialized JSON representation of the context. Small, 66.0 66.0
errors List of errors that are encountered during the processing of the API request. Small, 61.0 61.0
pricingResult Map<String, Object> Details of the pricing result. Small, 61.0 61.0
productDetails Product[] Details of the list of products that are included in the context JSON. Small, 66.0 66.0
ratingResult Rating Result[] Rating results after executing pricing with the context. Small, 66.0 66.0
uiTreatments Insurance UI Treatments[] Details of the insurance UI configuration. Small, 66.0 66.0