Get Catalog Details Action

Get details of a catalog record.

This action is available in API version 64.0 and later.

You can invoke this action via Apex and Flows only.

Special Access Rules

The Get Catalog Details action is available in Enterprise, Unlimited, and Developer Editions where Product Discovery is enabled.

Inputs

Input	Type	Description
`catalogId`	string	Required. ID of the catalog record.
`correlationId`	string	Unique identifier attached to requests and messages, enabling reference to a specific transaction or event chain.

Outputs

Output	Type	Description
`apiStatusOutputRepresentation`	Apex-defined	An Apex `runtime_industries_cpq.ApiStatusRepresentation` record that contains the status of the request, including the status code and message.
`catalogDetailsResult`	Apex-defined	Details of the catalog record.
`correlationId`	string	Unique identifier attached to requests and messages, allowing reference to a specific transaction or event chain.

Example

Here’s a sample input to call this invocable action from Apex code.

1Invocable.Action action = Invocable.Action.createStandardAction('getCatalogDetails');
2
3action.setInvocationParameter('correlationId', '9cbb9650-48c5-11ed-96d1-0afcf185843b');
4action.setInvocationParameter('catalogId', '0ZSZ6000000CtXYOA0');
5
6List<Invocable.Action.Result> results = action.invoke();
7System.debug('Catalog Details Action + '+results);

Here’s a sample response when you call this action.

1[
2  {
3    "actionName": "getCatalogDetails",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "apiStatusOutputRepresentation": {
10        "statusMessage": null,
11        "statusCode": "FetchedDetailsSuccessfully",
12        "messages": []
13      },
14      "correlationId": "9cbb9650-48c5-11ed-96d1-0afcf185843b",
15      "catalogDetailsResult": {
16        "status": null,
17        "numberOfCategories": 2,
18        "name": "Hardware Catalog",
19        "id": "0ZSZ6000000CtXYOA0",
20        "effectiveStartDate": null,
21        "effectiveEndDate": null,
22        "description": "Hardware Catalog Desc",
23        "customFields": null,
24        "catalogType": "Sales",
25        "catalogCode": "HC"
26      }
27    },
28    "sortOrder": -1,
29    "version": 1
30  }
31]