Product Classification List (POST)

Retrieve a list of product classification records. You can also search, filter, or sort the product classifications.

This API retrieves a paginated list of product classification records from the Product Catalog Management (PCM) or Enterprise Product Catalog (EPC) catalog system. You can search for product classifications by name, apply filters, and sort the results.

Resource

1/revenue/product-catalog-management/product-classifications/list

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/revenue/product-catalog-management/product-classifications/list

Available Version: 67.0

HTTP Methods: POST

Note: POST methods typically create an item, but for this resource POST is used to retrieve information.

Request Body for POST

JSON Example

1{
2  "catalogSystem": "pcm",
3  "searchTerm": "Mobile",
4  "filter": {
5    "criteria": [
6      {
7        "property": "name",
8        "operator": "contains",
9        "value": "Mobile"
10      }
11    ]
12  },
13  "sort": {
14    "orders": [
15      {
16        "property": "name",
17        "direction": "asc"
18      }
19    ]
20  },
21  "pageSize": 25,
22  "offset": 0
23}

Properties

Name	Type	Description	Required or Optional	Available Version
`catalogSystem`	String	Name of the catalog system. Valid values are `pcm`—Product Catalog Management or `epc`—Enterprise Product Catalog. If unspecified, the default catalog system is `pcm`.	Optional	67.0
`filter`	Criteria Input	Criteria to filter the product classification records. The supported property is `name`. The supported operators are `eq`, `in`, or `contains`. If multiple criteria are specified, they’re combined by using the `and` operator. Each criterion supports only the `property`, `operator`, and `value` fields.	Optional	67.0
`offset`	Integer	Number of records to skip. The default value is 0.	Optional	67.0
`pageSize`	Integer	Specifies the number of records per page. Valid values are 5, 10, 25, 50, and 100. If unspecified, the default value is 100.	Optional	67.0
`searchTerm`	String	String used to search for product classifications with the product classification name containing the search term.	Optional	67.0
`sort`	Order Input	Sort order for the product classifications. If unspecified, the default sort order is by name in ascending order.	Optional	67.0

Response Body for POST: Product Classification List Collection