Product Categories

get_product_categories

Get list of product categories for the authenticated user's organization

get_product_categories

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_product_categories",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "langCode": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_product_categories",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "langCode": "string"
  }
});

result = await session.call_tool("get_product_categories", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "langCode": "string"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for category name

relationsArray<string>

Relations to include (e.g., ["products", "image"])

langCodestring

Language code for translations

get_product_category_count

Get product category count in the authenticated user's organization

get_product_category_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_product_category_count",
    "arguments": {}
  }
}

const result = await client.callTool({
  "name": "get_product_category_count",
  "arguments": {}
});

result = await session.call_tool("get_product_category_count", arguments={})

create_product_category

Create a new product category in the authenticated user's organization

create_product_category

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_product_category",
    "arguments": {
        "category_data": {
          "name": "string",
          "translations": [
            {
              "languageCode": "string",
              "name": "string",
              "description": "string"
            }
          ]
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_product_category",
  "arguments": {
    "category_data": {
      "name": "string",
      "translations": [
        {
          "languageCode": "string",
          "name": "string",
          "description": "string"
        }
      ]
    }
  }
});

result = await session.call_tool("create_product_category", arguments={
  "category_data": {
    "name": "string",
    "translations": [
      {
        "languageCode": "string",
        "name": "string",
        "description": "string"
      }
    ]
  }
})

Request Body

{
  "category_data": {
    "name": "string",
    "translations": [
      {
        "languageCode": "string",
        "name": "string",
        "description": "string"
      }
    ]
  }
}

Body

application/json

category_dataobjectrequired

The data for creating the product category

Show child attributes

namestringrequired

The name (required)

translationsArray<object>

Category translations for different languages

Show child attributes

languageCodestringrequired

namestringrequired

descriptionstring

[key: string]any

update_product_category

Update an existing product category

update_product_category

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_product_category",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "category_data": {
          "translations": [
            {
              "languageCode": "string",
              "name": "string",
              "description": "string"
            }
          ]
        }
      }
  }
}

const result = await client.callTool({
  "name": "update_product_category",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "category_data": {
      "translations": [
        {
          "languageCode": "string",
          "name": "string",
          "description": "string"
        }
      ]
    }
  }
});

result = await session.call_tool("update_product_category", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "category_data": {
    "translations": [
      {
        "languageCode": "string",
        "name": "string",
        "description": "string"
      }
    ]
  }
})

Request Body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "category_data": {
    "translations": [
      {
        "languageCode": "string",
        "name": "string",
        "description": "string"
      }
    ]
  }
}

Body

application/json

idstring<uuid>required

The product category ID

category_dataobjectrequired

The data for updating the product category

Show child attributes

translationsArray<object>

Category translations for different languages

Show child attributes

languageCodestringrequired

namestringrequired

descriptionstring

[key: string]any

get_products_by_category

Get all products in a specific category

get_products_by_category

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_products_by_category",
    "arguments": {
        "categoryId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "enabled": true,
        "relations": [
          "string"
        ],
        "langCode": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_products_by_category",
  "arguments": {
    "categoryId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "enabled": true,
    "relations": [
      "string"
    ],
    "langCode": "string"
  }
});

result = await session.call_tool("get_products_by_category", arguments={
  "categoryId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "enabled": true,
  "relations": [
    "string"
  ],
  "langCode": "string"
})

Parameters

categoryIdstring<uuid>required

The product category ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

enabledboolean

Filter by enabled status

relationsArray<string>

Relations to include

langCodestring

Language code for translations

Stack Overflow Website Demo