Catalog List (POST)

Retrieve, search, filter, or sort catalog records.

Resource

1/connect/pcm/catalogs

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/pcm/catalogs

Available Version: 60.0

Requires Chatter: No

HTTP Methods: POST

Note: The POST method is used to retrieve the catalog records instead of the GET method as a request payload is sent to filter the records.

Request Body for POST

JSON Example

This example shows how to retrieve catalogs that contain apple in the catalog name.

1{
2"pageSize": 100,
3"offset": 0,
4"language": "french",
5"filter": {
6"criteria": [
7{
8"property": "name",
9"operator": "contains",
10"value": "apple"
11}
12]
13}
14}

This example shows how to retrieve catalogs with ServiceProcess as the catalog type.

1{
2"pageSize": 100,
3"offset": 0,
4"sort": {
5  "orders": [
6   {
7   "property": "name",
8   "direction": "desc"
9   }
10  ]
11 },
12"filter": {
13"criteria": [
14{
15"property": "catalogType",
16"operator": "eq",
17"value": "ServiceProcess"
18}
19]
20}
21}

Properties

Name	Type	Description	Required or Optional	Available Version
`correlationId`	String	Unique token to track and associate related events or transactions across different components of the application. If unspecified, a Universally Unique Identifier (UUID) is generated.	Optional	60.0
`filter`	Filter	Criteria to filter the records. Filters are applicable to the fields of the ProductCatalog object. The supported operators are `eq`, `in`, or `contains`. The supported properties are `name` and `catalogType`.	Optional	60.0
`language`	String	Custom language that you can specify to get translated data for the fields of an object that’s enabled for translation. See Translate Product and Product Category Data.	Optional	64.0
`offset`	Integer	Number of records to skip. The default value is 0.	Optional	60.0
`pageSize`	Integer	Number of records per page. Valid values are from 1 through 100. If unspecified, defaults to 100.	Optional	60.0
`sort`	Sort	Sort order of the catalog records. The supported operators are `asc` or `desc`.	Optional	60.0

Response Body for POST: Catalogs Output