Get Energy Products Action

Retrieve a list of products and pricing details from the Energy and Utilities product catalog that match the specified filter criteria.

This action is available in API version 68.0 and later.

Special Access Rules

The Get Energy 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/getEnergyProducts

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
`catalogCode`	string	Optional. The code of the product catalog to search within.
`categoryCode`	string	Optional. The code of the product category to use to filter the products.
`priceBookName`	string	Optional. The name of the active price book to use for pricing. Defaults to Standard Price Book when not provided.
`isActive`	boolean	Optional. Indicates whether to return only active products.
`maximumProductsLimit`	int	Optional. The maximum number of products to return. The default is 200.

Outputs

Output	Type	Description
`productPricingDetails`	Apex[]	An Apex Connect API response that contains the matching products and their pricing information. Each item contains these fields. `productId` (string): ID of the product. `productName` (string): Name of the product. `productDescription` (string): Description of the product. `productCode` (string): Product code. `listPrice` (number): List price of the product. `quantity` (number): Quantity associated with the product pricing. `sellingModelType` (string): Selling model type for the product. `pricingTermUnit` (string): Unit of the pricing term. `netItemTotalPriceText` (string): Formatted net item total price. `productImageUrl` (string): URL of the product image.
`productCount`	int	The total number of products that match the search criteria.

Example

POST

This sample request is for the Get Energy Products action.

1{
2  "inputs": [
3    {
4      "catalogCode": "COMMODITY_CATALOG",
5      "categoryCode": "ADDONPRODUCTS",
6      "priceBookName": "Standard Price Book",
7      "isActive": true,
8      "maximumProductsLimit": 200
9    }
10  ]
11}

This sample response is for the Get Energy Products action.

1[
2  {
3    "actionName": "getEnergyProducts",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "productPricingDetails": [
9        {
10          "productId": "01txx0000000AbcAAE",
11          "productName": "Green Saver Plan",
12          "productDescription": "Residential electricity plan",
13          "productCode": "GSP-001",
14          "listPrice": 89.50,
15          "quantity": 1,
16          "sellingModelType": "TermDefined",
17          "pricingTermUnit": "Month",
18          "netItemTotalPriceText": "89.50",
19          "productImageUrl": "https://example.com/images/green-saver.png"
20        }
21      ],
22      "productCount": 1
23    },
24    "sortOrder": -1,
25    "version": 1
26  }
27]