Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Product Catalog Management
Product Catalog Management Standard Objects
Product Catalog Management Fields on Standard Objects
Product Catalog Management Business APIs
Resources
Request Bodies
Additional Fields Input
Bulk Product Details Input
Catalog Input
Criteria Input
Data Rounding Input
Data Row Input
Deep Clone Input
Field Data Input
Filter Input
Include Object Input
Index Configuration Collection Input
Index Configuration Input
Index Setting Input
Options Input
Order Input
Product Input
Related Object Filters Input
Related Object Node Input
Related Records Input
Run-time Catalog Snapshot Input
Setting Input
Snapshot Deployment Input
Sort Input
Response Bodies
Product Catalog Management Metadata API Types
Product Catalog Management Tooling API Objects
Product Discovery
Salesforce Pricing
Rate Management
Usage Management
Product Configurator
Transaction Management
Dynamic Revenue Orchestrator
Billing
Revenue Cloud Associated Objects
PDF

Catalog Input

Input representation of the request to retrieve catalog records.
JSON example
This example shows how to retrieve catalogs that contain apple in the catalog name.
{
"pageSize": 100,
"offset": 0,
"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
correlation​Id 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
offset Integer Number of records to skip. The default value is 0. Optional 60.0
page​Size 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