GET Category by searching in category names
GET/v/ct/:searchWord
- Requires Data Viewer ApiKey permissions.
- Example URI: https://instancename.piminto.com/api/en-us/v/ct/searchWord
Provides the ability to get a list of categories that contain the specified search term (search word or phrase) in their names.
Returns
Specify a search term (word or phrase) and the endpoint will return information about categories that contain the specified search term in their names.
If no category matches the query, the resulting response contains only: "status" = "OK", indicating that the request was successfully sent and executed.
This API call provides a flexible way to search for categories in your PIMS and can be useful when you need to find categories that meet certain search criteria, such as identifying all categories related to a particular product line.
Request
Path Parameters
Search word or phrase in category name
Responses
- 200
success
- application/json
- Schema
- Example (from schema)
Schema
- Categories
- Category not found
- Array [
- ]
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
Automatically calculated value that represents a unique PIMS internal category ID. You can use to retrieve more details about the category.
The name of the category identified by category ID.
The ID of the parent category.
The calculated relative path of the category, uses '>' as a unique category ID separator.
The calculated relative path of the category, uses '>' as a category name separator.
The proper sort order for the categories when displayed in a user interface.
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.
The path for the image of the category.
{}