Skip to main content

Category

About endpoint Category

Provides the ability to retrieve the entire structure and hierarchy of categories, select a specific category, or return categories that match a specific search query. The category endpoints provide comprehensive information about a category, including details on any subcategories that belong to or have been assigned to it.

Data returned by category endpoints include specific filter attributes for each individual category, related labels and their possible values, thus providing connected applications with all the necessary data to include fully dynamic advanced filtering capabilities in the connected application's user interface without the need for processing or processing local storage of category and product data.

Category Data returned by the Category endpoints for each category include:

  • id: An automatically calculated value that represents a unique PIMS internal category ID.
  • cat_name: The name of the category identified by category ID
  • cat_parent_id: The ID of the parent category.
  • cat_path_id: The relative path of the category that is calculated and uses '>' as a separator for the unique category ID.
  • cat_path: The relative path of the category that is calculated and uses '>' as a separator for the category name.
  • cat_rank: A numerical classification for the category's rank.
  • cat_order: The proper sorting order for the categories when displayed in a user interface.
  • cat_data: Metadata associated with the category. Extendable.