A Catalog is a view that allows hierarchical categorization of products for you to search through products. This use case describes how to browse through a catalog. It helps you explore the products before you add them to the cart. There are multiple ways you can search and find the product you are looking for. Implementation teams can use these APIs to filter products by their characteristics, sort products by fields associated with them, apply pagination to the results, and use other such functionalities to navigate the catalog.

Getting the Category Tree for a Price List

You can retrieve all or a filtered list of categories based on provided parameters. For example, pass the price list ID to retrieve all categories associated with that price list ID.

Prerequisite

You must have price list ID to retrieve the categories associated with it.

Example

The following table lists the API method, endpoint, and path as well as a sample request and response to get the category tree for a price list.

MethodGET
Endpoint/categories
Request Parameter

The following URL parameters are used to narrow down the search result to specifically retrieve categories associated with a price list ID.

Parameters

Values

page1
limit100
includeproduct
price list IDffc5c4ad-7329-472e-aca6-b733c2ae47dd


Request URLhttps://<URL_of_the_Instance>/api/catalog/v1/categories?includes=products&page=1&limit=100
Request Body

The following sample code enables you to get the category tree for the given price list and based on the other above-mentioned parameters.

curl --request GET \
     --url 'https://<URL_of_the_Instance>/api/catalog/v1/categories?includes=products&page=1&limit=100' \
     --header 'PriceListId: ffc5c4ad-7329-472e-aca6-b733c2ae47dd' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <token>
CODE
Response

The API returns the list of categories with details such as Category ID, Category Name, Description, Hierarchy ID, and the category's parent and child categories.

Response Body

[
  {
    "AncestorId": null,
    "AncestorPath": "391a047e-0a21-4f4a-be76-835ca61515d8",
    "HierarchyId": "fab05569-02aa-43fc-b44c-d88b0d30d6ac",
    "DefaultSearchCategory": false,
    "Description": "Parent_RLPAutoCat_SmokeProd_Category",
    "ExpandedByDefault": false,
    "GuidePage": null,
    "HideAllSearchFilters": false,
    "ImageURL": null,
    "IncludeInTotalsView": true,
    "IsHidden": false,
    "IsLeaf": false,
    "IsPicklist": false,
    "Label": "Parent_RLPAutoCat_SmokeProd_Category",
    "LargeImageURL": null,
    "LongDescription": null,
    "SearchFilterFields": null,
    "Type": null,
    "CreatedBy": null,
    "CreatedDate": "2023-01-19T10:01:45.0678137Z",
    "Id": "391a047e-0a21-4f4a-be76-835ca61515d8",
    "ModifiedBy": null,
    "ModifiedDate": "2023-01-19T10:01:45.0678137Z",
    "Name": "Parent_RLPAutoCat_SmokeProd_Category",
    "Currency": "USD",
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": null,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": null,
    "CatAuto_DateTime_CstField_c": null,
    "CatAuto_Double_CstField_c": null,
    "CatAuto_Int_CstField_c": null,
    "CatAuto_Multipicklist_CstField_c": null,
    "CatAuto_String_CstField_c": null,
    "CreatedById": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "ModifiedById": "d717a075-9cbf-480c-b230-837e0e6dee75"
  },
  {
    "AncestorId": "ed316c6a-0bbb-4477-bb88-baad008e3478",
    "AncestorPath": "391a047e-0a21-4f4a-be76-835ca61515d8,ed316c6a-0bbb-4477-bb88-baad008e3478,7f0d36db-2484-4920-b099-f08adc7111fa",
    "HierarchyId": "fab05569-02aa-43fc-b44c-d88b0d30d6ac",
    "DefaultSearchCategory": false,
    "Description": "Level3_Ch1_RLPAutoCat_SmokeProd_Category",
    "ExpandedByDefault": false,
    "GuidePage": null,
    "HideAllSearchFilters": false,
    "ImageURL": null,
    "IncludeInTotalsView": true,
    "IsHidden": false,
    "IsLeaf": true,
    "IsPicklist": false,
    "Label": "Level3_Ch1_RLPAutoCat_SmokeProd_Category",
    "LargeImageURL": null,
    "LongDescription": null,
    "SearchFilterFields": null,
    "Type": null,
    "CreatedBy": null,
    "CreatedDate": "2023-01-19T10:02:44.7413515Z",
    "Id": "7f0d36db-2484-4920-b099-f08adc7111fa",
    "ModifiedBy": null,
    "ModifiedDate": "2023-01-19T10:02:44.7413515Z",
    "Name": "Level3_Ch1_RLPAutoCat_SmokeProd_Category",
    "Currency": "USD",
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": null,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": null,
    "CatAuto_DateTime_CstField_c": null,
    "CatAuto_Double_CstField_c": null,
    "CatAuto_Int_CstField_c": null,
    "CatAuto_Multipicklist_CstField_c": null,
    "CatAuto_String_CstField_c": null,
    "CreatedById": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "ModifiedById": "d717a075-9cbf-480c-b230-837e0e6dee75"
  }
]
CODE

Getting the Products in a Category

You can retrieve all active products associated with the provided category ID and price list ID. This can be the ID of the leaf category, sub-category, or root category.

Prerequisite

You must have a price list ID and the category ID.

Example 1

The following table lists the API method, endpoint, and path as well as a sample request and response to get all products associated with a category and the corresponding price list.

MethodGET
Endpoint/categories/{categoryId}/products
Request URL

The following URL parameters are used to narrow down the search result to specifically retrieve products associated with a category ID and a price list ID.

Parameters

Values

page10
limit5
category ID391a047e-0a21-4f4a-be76-835ca61515d8
price list IDffc5c4ad-7329-472e-aca6-b733c2ae47dd
Request

The following sample code enables you to get the products associated with the given price list and category, adhering to the other above-mentioned parameters.

curl --request GET \
     --url 'https://rlp-dev.congacloud.io/api/catalog/v1/categories/cf3e1894-7732-4de2-bc2d-171d3bafa563/products?page=10&limit=5' \
     --header 'PriceListId: 51432cec-268a-4d2f-a543-8b91f70cdb7c' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <Token>
CODE
Response

For a leaf category, the API returns all products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories.

Response Body

[
  {
    "ConfigurationType": "Standalone",
    "Customizable": null,
    "Description": "ACS_Pagination_St_46",
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": null,
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": false,
    "HasSearchAttributes": false,
    "ImageURL": "https://i1.wp.com/techforceservices.com.au/wp-content/uploads/2019/04/Conga.png?fit=584%2C190,ssl=1",
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": "ACS_Pagination_St_46",
    "ProductType": null,
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": "2022-08-11T10:18:59.1461591Z",
    "Id": "ddc05e30-9406-4713-991e-ea9fb7d199db",
    "ModifiedBy": null,
    "ModifiedDate": "2022-09-06T14:22:43Z",
    "Name": "ACS_Pagination_St_46",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": true,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": "USD",
    "CatAuto_DateTime_CstField_c": "2022-03-01T00:00:00Z",
    "CatAuto_Double_CstField_c": 169,
    "CatAuto_Int_CstField_c": 369,
    "CatAuto_Multipicklist_CstField_c": [
      "Red",
      "Blue"
    ],
    "CatAuto_String_CstField_c": "AutoString_169",
    "CreatedById": "27634e3f-904a-4321-9ce5-c2edbe181d90",
    "ModifiedById": "27634e3f-904a-4321-9ce5-c2edbe181d90"
  },
  {
    "ConfigurationType": "Standalone",
    "Customizable": null,
    "Description": "ACS_Pagination_St_47",
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": null,
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": false,
    "HasSearchAttributes": false,
    "ImageURL": "https://i1.wp.com/techforceservices.com.au/wp-content/uploads/2019/04/Conga.png?fit=584%2C190,ssl=1",
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": "ACS_Pagination_St_47",
    "ProductType": null,
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": "2022-08-11T10:18:59.1461591Z",
    "Id": "b5f22f5c-8a88-4fc7-add6-b3f11bf0114e",
    "ModifiedBy": null,
    "ModifiedDate": "2022-09-06T14:22:43Z",
    "Name": "ACS_Pagination_St_47",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": false,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": "INR",
    "CatAuto_DateTime_CstField_c": "2022-03-01T00:00:00Z",
    "CatAuto_Double_CstField_c": 170,
    "CatAuto_Int_CstField_c": 370,
    "CatAuto_Multipicklist_CstField_c": [
      "Yellow",
      "Green"
    ],
    "CatAuto_String_CstField_c": "AutoString_170",
    "CreatedById": "27634e3f-904a-4321-9ce5-c2edbe181d90",
    "ModifiedById": "27634e3f-904a-4321-9ce5-c2edbe181d90"
  },
  {
    "ConfigurationType": "Standalone",
    "Customizable": null,
    "Description": "ACS_Pagination_St_48",
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": null,
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": false,
    "HasSearchAttributes": false,
    "ImageURL": "https://i1.wp.com/techforceservices.com.au/wp-content/uploads/2019/04/Conga.png?fit=584%2C190,ssl=1",
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": "ACS_Pagination_St_48",
    "ProductType": null,
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": "2022-08-11T10:18:59.1461591Z",
    "Id": "1387c727-82a9-4a24-bdd6-57b2a379cef2",
    "ModifiedBy": null,
    "ModifiedDate": "2022-09-06T14:22:43Z",
    "Name": "ACS_Pagination_St_48",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": true,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": "GBP",
    "CatAuto_DateTime_CstField_c": "2022-03-01T00:00:00Z",
    "CatAuto_Double_CstField_c": 171,
    "CatAuto_Int_CstField_c": 371,
    "CatAuto_Multipicklist_CstField_c": [
      "Pink",
      "White"
    ],
    "CatAuto_String_CstField_c": "AutoString_171",
    "CreatedById": "27634e3f-904a-4321-9ce5-c2edbe181d90",
    "ModifiedById": "27634e3f-904a-4321-9ce5-c2edbe181d90"
  },
  {
    "ConfigurationType": "Standalone",
    "Customizable": null,
    "Description": "ACS_Pagination_St_49",
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": null,
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": false,
    "HasSearchAttributes": false,
    "ImageURL": "https://i1.wp.com/techforceservices.com.au/wp-content/uploads/2019/04/Conga.png?fit=584%2C190,ssl=1",
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": "ACS_Pagination_St_49",
    "ProductType": null,
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": "2022-08-11T10:18:59.1461591Z",
    "Id": "dda4cb81-d8c9-4b15-9d59-0bf8c60db23d",
    "ModifiedBy": null,
    "ModifiedDate": "2022-09-06T14:22:43Z",
    "Name": "ACS_Pagination_St_49",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": false,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": "EUR",
    "CatAuto_DateTime_CstField_c": "2018-03-01T00:00:00Z",
    "CatAuto_Double_CstField_c": 172,
    "CatAuto_Int_CstField_c": 372,
    "CatAuto_Multipicklist_CstField_c": [
      "Purple",
      "Black"
    ],
    "CatAuto_String_CstField_c": "AutoString_172",
    "CreatedById": "27634e3f-904a-4321-9ce5-c2edbe181d90",
    "ModifiedById": "27634e3f-904a-4321-9ce5-c2edbe181d90"
  },
  {
    "ConfigurationType": "Standalone",
    "Customizable": null,
    "Description": "ACS_Pagination_St_50",
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": null,
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": false,
    "HasSearchAttributes": false,
    "ImageURL": "https://i1.wp.com/techforceservices.com.au/wp-content/uploads/2019/04/Conga.png?fit=584%2C190,ssl=1",
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": "ACS_Pagination_St_50",
    "ProductType": null,
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": "2022-08-11T10:18:59.1461591Z",
    "Id": "81c9ef97-5b6d-4f17-9f92-d960f7e935b6",
    "ModifiedBy": null,
    "ModifiedDate": "2022-09-06T14:22:43Z",
    "Name": "ACS_Pagination_St_50",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": true,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": "USD",
    "CatAuto_DateTime_CstField_c": "2025-03-01T00:00:00Z",
    "CatAuto_Double_CstField_c": 173,
    "CatAuto_Int_CstField_c": 373,
    "CatAuto_Multipicklist_CstField_c": [
      "Red",
      "Blue"
    ],
    "CatAuto_String_CstField_c": "AutoString_173",
    "CreatedById": "27634e3f-904a-4321-9ce5-c2edbe181d90",
    "ModifiedById": "27634e3f-904a-4321-9ce5-c2edbe181d90"
  }
]
CODE

Example 2

The following table lists the API method, endpoint, and path as well as a sample request and response to get a product having a specific name and are associated with a category and a corresponding price list. 

MethodGET
Endpoint/categories/{categoryId}/products
Request URL

The following URL parameters are used to narrow down the search result to specifically retrieve products with the name "ACS_System_Installer" associated with a category ID and a price list ID.

Parameters

Values

filtereq(Name:ACS_System_Installer)
category ID391a047e-0a21-4f4a-be76-835ca61515d8
price list IDffc5c4ad-7329-472e-aca6-b733c2ae47dd
Request

The following sample code enables you to get the products associated with the given price list and category, adhering to the other above-mentioned parameters.

curl --request GET \
     --url 'https://rlp-dev.congacloud.io/api/catalog/v1/categories/cf3e1894-7732-4de2-bc2d-171d3bafa563/products?filter=eq%28Name%3AACS_System_Installer%29' \
     --header 'PriceListId: 51432cec-268a-4d2f-a543-8b91f70cdb7c' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <Token>
CODE
Response

For a leaf category, the API returns all products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories.

Response Body

[
  {
    "ConfigurationType": "Standalone",
    "Customizable": null,
    "Description": "ACS System Installer",
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": null,
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": false,
    "HasSearchAttributes": false,
    "ImageURL": "https://i1.wp.com/techforceservices.com.au/wp-content/uploads/2019/04/Conga.png?fit=584%2C190,ssl=1",
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": "ACS System Installer",
    "ProductType": null,
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": "2022-08-11T10:18:59.1461591Z",
    "Id": "ddc05e30-9406-4713-991e-ea9fb7d199db",
    "ModifiedBy": null,
    "ModifiedDate": "2022-09-06T14:22:43Z",
    "Name": "ACS System Installer",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": true,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": "USD",
    "CatAuto_DateTime_CstField_c": "2022-03-01T00:00:00Z",
    "CatAuto_Double_CstField_c": 169,
    "CatAuto_Int_CstField_c": 369,
    "CatAuto_Multipicklist_CstField_c": [
      "Red",
      "Blue"
    ],
    "CatAuto_String_CstField_c": "AutoString_169",
    "CreatedById": "27634e3f-904a-4321-9ce5-c2edbe181d90",
    "ModifiedById": "27634e3f-904a-4321-9ce5-c2edbe181d90"
  }
]
CODE

Example 3

The following table lists the API method, endpoint, and path as well as a sample request and response to get only standalone products associated with a category and a corresponding price list. 

MethodGET
Endpoint/categories/{categoryId}/products
Request URL

The following URL parameters are used to narrow down the search result to specifically retrieve the 1st standalone product on the third page that is associated with a category ID and a price list ID.

Parameters

Values

page10
limit5
filtereq(ConfigurationType:Standalone)
category ID391a047e-0a21-4f4a-be76-835ca61515d8
price list IDffc5c4ad-7329-472e-aca6-b733c2ae47dd
Request

The following sample code enables you to get the products associated with the given price list and category, adhering to the other above-mentioned parameters.

curl --request GET \
     --url 'https://rlp-dev.congacloud.io/api/catalog/v1/categories/cf3e1894-7732-4de2-bc2d-171d3bafa563/products?page=3&limit=1&filter=eq%28ConfigurationType%3AStandalone%29' \
     --header 'PriceListId: 51432cec-268a-4d2f-a543-8b91f70cdb7c' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <Token>
CODE
Response

For a leaf category, the API returns all products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories.

Response Body

[
  {
    "ConfigurationType": "Standalone",
    "Customizable": null,
    "Description": "ACS_Pagination_St_3",
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": null,
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": false,
    "HasSearchAttributes": false,
    "ImageURL": "https://i1.wp.com/techforceservices.com.au/wp-content/uploads/2019/04/Conga.png?fit=584%2C190,ssl=1",
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": "ACS_Pagination_St_3",
    "ProductType": null,
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": "2022-08-11T10:18:59.1461591Z",
    "Id": "229a416f-1b52-4e60-95c5-a8aa78973209",
    "ModifiedBy": null,
    "ModifiedDate": "2022-09-06T14:22:41Z",
    "Name": "ACS_Pagination_St_3",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": false,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": "INR",
    "CatAuto_DateTime_CstField_c": "2015-03-01T00:00:00Z",
    "CatAuto_Double_CstField_c": 126,
    "CatAuto_Int_CstField_c": 326,
    "CatAuto_Multipicklist_CstField_c": [
      "Yellow",
      "Green"
    ],
    "CatAuto_String_CstField_c": "AutoString_126",
    "CreatedById": "27634e3f-904a-4321-9ce5-c2edbe181d90",
    "ModifiedById": "27634e3f-904a-4321-9ce5-c2edbe181d90"
  }
]
CODE