Catalog List (POST)

Retrieve, search, filter, or sort catalog records.

Resource

/connect/pcm/catalogs

Resource example

https://yourInstance.salesforce.com/services/data/v64.0/connect/pcm/catalogs

Available version

60.0

Requires Chatter

HTTP methods

POST

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.

Note

Request body for POST

JSON example

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

{
"pageSize": 100,
"offset": 0,
"language": "french",
"filter": {
"criteria": [
{
"property": "name",
"operator": "contains",
"value": "apple"
}
]
}
}

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

{
"pageSize": 100,
"offset": 0,
"sort": {
  "orders": [
   {
   "property": "name",
   "direction": "desc"
   }
  ]
 },
"filter": {
"criteria": [
{
"property": "catalogType",
"operator": "eq",
"value": "ServiceProcess"
}
]
}
}

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` `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` `desc`	Optional	60.0

Response body for POST

Catalogs Output

Revenue Cloud Developer Guide

No Results

Catalog List (POST)