GetProductCategories
Retrieve product categories with filtering, sorting, and pagination options. Use this tool to fetch organized category data based on specific criteria such as ID, name, or description.
Instructions
Retrieve a list of product categories. The product categories can be filtered by fields such as id
. The product categories can also be sorted or paginated.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
$and | No | ||
$or | No | ||
created_at | No | ||
description | No | ||
fields | No | ||
handle | No | ||
id | No | ||
include_ancestors_tree | No | ||
include_descendants_tree | No | ||
limit | No | ||
name | No | ||
offset | No | ||
order | No | ||
parent_category_id | No | ||
q | No | ||
updated_at | No |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"$and": {
"items": {
"type": "string"
},
"type": "array"
},
"$or": {
"items": {
"type": "string"
},
"type": "array"
},
"created_at": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"description": {
"type": "string"
},
"fields": {
"type": "string"
},
"handle": {
"type": "string"
},
"id": {
"type": "string"
},
"include_ancestors_tree": {
"type": "boolean"
},
"include_descendants_tree": {
"type": "boolean"
},
"limit": {
"type": "number"
},
"name": {
"type": "string"
},
"offset": {
"type": "number"
},
"order": {
"type": "string"
},
"parent_category_id": {
"type": "string"
},
"q": {
"type": "string"
},
"updated_at": {
"additionalProperties": false,
"properties": {},
"type": "object"
}
},
"type": "object"
}