Skip to main content

Categories Tree

GET 

/v/ctf

Provides the capability to retrieve the complete structure and hierarchy of categories from the root node to the end within your Product Information Management System (PIMS).

Returns


This endpoint provides the complete structure of categories, including all subcategories and nested nodes, starting from the root node and extending to all its child elements. The retrieved data displays the entire category hierarchy in the PIMS system, providing a comprehensive view of the data structure.

In this endpoint, the cat_data metadata field includes only the cat_image attribute, the path to the category image.

Request

Query Parameters

    order-by string

    Set this parameter to cat_name to sort the tree nodes output by name; by default, nodes are sorted by the cat_order field

Responses

success

Schema
    status stringrequired

    The status of the API request. A value of "OK" indicates that the request was successfully sent and processed.

    categoriesTree object[]required

    Structure and hierarchy of categories in PIMS

  • Array [
  • id integerrequired

    Automatically calculated value that represents a unique PIMS internal category ID. You can use to retrieve more details about the category.

    cat_name stringrequired

    The name of the category identified by category ID.

    cat_parent_id integerrequired

    The ID of the parent category.

    cat_path_id stringrequired

    The calculated relative path of the category, uses '>' as a unique category ID separator.

    cat_path stringrequired

    The calculated relative path of the category, uses '>' as a category name separator.

    children object[]

    Array of categoriesTree elements

    cat_order integerrequired

    The proper sort order for the categories when displayed in a user interface.

    cat_rank integerrequired

    A numerical classification for the category's rank.

    cat_data object

    Metadata associated with the category. Extendable. In this endpoint, the cat_data metadata field includes only the "cat_image" attribute, the path to the category image.

    cat_image stringrequired

    The path for the image of the category.

  • ]
Loading...