Get Catalogs Action

Get a list of catalog records.

This action is available in API version 64.0 and later.

You can invoke this action via Apex and Flows only.

Special Access Rules

Inputs

Input	Type	Description
`recordLimit`	integer	Number of catalog records to get. The minimum is 1, the maximum is 100, and the default is 100.
`recordOffset`	integer	Number of catalog records to skip in the request. The default is 0.
`correlationId`	string	Unique identifier for tracking requests and messages, allowing reference to a specific transaction or event chain.
`orderBy`	string	Sort records in ascending or descending order.

Outputs

Output	Type	Description
`resultCatalogList`	Apex-defined	List of filtered catalog records. See CatalogOutputRepresentation.
`apiStatusOutputRepresentation`	Apex-defined	An Apex `runtime_industries_cpq.ApiStatusRepresentation` record that contains the status of the request, including the status code and message.
`recordLimit`	integer	Number of catalog records to show per page.
`resultListCount`	integer	Number of catalog records in the result.
`correlationId`	string	Unique identifier for tracking requests and messages, allowing reference to a specific transaction or event chain.
`recordOffset`	integer	Number of catalog records to skip in the request. The default is 0.

Example

POST

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

1Invocable.Action action = Invocable.Action.createStandardAction('getCatalogs');
2
3action.setInvocationParameter('correlationId', '9cbb9650-48c5-11ed-96d1-0afcf185843b');
4action.setInvocationParameter('recordLimit', 1);
5action.setInvocationParameter('recordOffset', 1);
6String[] sortOrder = new String[]{'Name:ASC'};
7action.setInvocationParameter('orderBy', sortOrder);
8
9List<Invocable.Action.Result> results = action.invoke();
10System.debug('Catalog List Action + '+results);

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

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