get_category_permissions
Retrieve category permissions to control which customer groups can view categories on websites. Get permissions for specific categories or all categories.
Instructions
Get category permissions from Catalog Service via gRPC.
This tool calls the GetCategoryPermissions RPC method to retrieve category permission
information from the Adobe Commerce Catalog Service. Category permissions control
which customer groups can view specific categories on different websites.
Args:
environment_id: Adobe Commerce Cloud environment ID (e.g., '3f73a49a-3137-472c-bb0d-39d0e7925d86')
category_ids: Optional list of category IDs to retrieve permissions for.
If not provided, returns permissions for all categories.
use_tls: Whether to use TLS connection (default: True)
timeout: Request timeout in seconds (default: 15.0)
Returns:
Dict containing category permission information with keys:
- permissions: List of permission dictionaries, each containing:
- environment_id: Environment ID
- category_id: Category ID
- displayable_permission_by_website_code: Map of website codes to customer group permissions
- created: Creation timestamp
- updated: Last update timestamp
- deleted: Whether the permission is deleted
- count: Number of permissions retrieved
- status: Success or error status
Example:
>>> result = get_category_permissions(
... environment_id='3f73a49a-3137-472c-bb0d-39d0e7925d86',
... category_ids=['1', '2', '4']
... )
>>> print(result['count'])
3
>>> for perm in result['permissions']:
... print(f"Category {perm['category_id']}: {perm['displayable_permission_by_website_code']}")
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| timeout | No | ||
| use_tls | No | ||
| category_ids | No | ||
| environment_id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |