Get Fully Priced Products Action

Retrieve fully priced offerings and product hierarchy configurations inside a comparison flow.

This action is available in API version 68.0 and later.

Special Access Rules

The Get Fully Priced Products action is available in Enterprise and Unlimited Editions with Energy and Utilities Cloud.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/getFullyPricedProducts

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
`catalogCode`	string	Required. The catalog code used to retrieve fully priced products.
`priceBookId`	string	Required. The ID of the price book used to evaluate individual product pricing details.
`webstoreName`	string	Required. The name of the webstore used to retrieve fully priced products.
`servicePoints`	Apex[]	Required. A collection of Apex `ConnectApi.EUServicePoint` objects that store infrastructure usage metrics and service parameters. Each item contains these fields. `marketIdentifier` (string): Market identifier for the service point. `distributionArea` (string): Distribution area for the service point. `tariffAttributes` (object[]): Tariff attributes for the service point, each with an attribute name and value. `consumption` (object): Consumption details for the service point, including annual consumption and unit of measure.
`recommendedProductsCount`	int	Optional. The maximum number of parent recommended product listings returned from the priced product results.
`tariffAttributeValues`	Apex[]	Optional. A collection of Apex `ConnectApi.EUTariffAttributeVal` criteria used to filter items by shared utility rules. Each item contains these fields. `attributeName` (string): Name of the tariff attribute. `attributeValue` (string): Value of the tariff attribute.

Outputs

Output	Type	Description
`fullyPricedProductOutput`	Apex	An Apex response that contains the fully priced product with product configurations, pricing details, and customizability flags. Contains these fields. `success` (boolean): Indicates whether the request was processed successfully. `euFullyPricedProducts` (object): Fully priced product configuration payload for the request context. `errors` (object[]): List of errors returned when the pricing request can’t be completed.

Example

POST

This sample request is for the Get Fully Priced Products action.

1{
2  "inputs": [
3    {
4      "catalogCode": "ELEC_CATALOG",
5      "priceBookId": "01sxx0000004AbcAAE",
6      "webstoreName": "EnergyStore",
7      "servicePoints": [
8        {
9          "marketIdentifier": "MKT001",
10          "distributionArea": "AREA_01",
11          "tariffAttributes": [
12            {
13              "attributeName": "paymentMethod",
14              "attributeValue": "DirectDebit"
15            }
16          ],
17          "consumption": {
18            "annualConsumption": 3500,
19            "unit": "kWh"
20          }
21        }
22      ],
23      "recommendedProductsCount": 5,
24      "tariffAttributeValues": [
25        {
26          "attributeName": "contractLength",
27          "attributeValue": "12"
28        }
29      ]
30    }
31  ]
32}

This sample response is for the Get Fully Priced Products action.

1[
2  {
3    "actionName": "getFullyPricedProducts",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "fullyPricedProductOutput": {
9        "success": true,
10        "euFullyPricedProducts": {
11          "productId": "01txx0000000AbcAAE",
12          "productName": "Green Saver Plan",
13          "netUnitPrice": 89.5
14        },
15        "errors": []
16      }
17    },
18    "sortOrder": -1,
19    "version": 1
20  }
21]