| get_productsA | Get product details from Catalog Service via gRPC.
This tool calls the GetProducts RPC method to retrieve product information
from the Adobe Commerce Catalog Service.
Args:
environment_id: Adobe Commerce Cloud environment ID (e.g., 'abc123xyz')
store_view_code: Store view code (e.g., 'default')
store_code: Store code (e.g., 'main_website_store')
website_code: Website code (e.g., 'base')
skus: List of product SKUs to retrieve
use_tls: Whether to use TLS connection (default: True)
timeout: Request timeout in seconds (default: 15.0)
Returns:
Dict containing product information with keys:
- products: List of product dictionaries
- count: Number of products retrieved
- status: Success or error status
Example:
>>> result = get_products(
... environment_id='abc123xyz',
... store_view_code='default',
... store_code='main_website_store',
... website_code='base',
... skus=['SKU123', 'SKU456']
... )
>>> print(result['count'])
2
|
| get_product_variantsA | Get product variants from Catalog Service via gRPC.
This tool calls the GetVariants RPC method to retrieve product variant information
(configurable product options and their values) from the Adobe Commerce Catalog Service.
Product variants represent the different configurations of a configurable product,
showing all available option combinations (like colors, sizes) and their corresponding
child product SKUs.
Args:
environment_id: Adobe Commerce Cloud environment ID (e.g., '3f73a49a-3137-472c-bb0d-39d0e7925d86')
store_view_code: Store view code (e.g., 'test')
store_code: Store code (e.g., 'test')
website_code: Website code (e.g., 'test')
skus: List of parent product SKUs to retrieve variants for
use_tls: Whether to use TLS connection (default: True)
timeout: Request timeout in seconds (default: 15.0)
Returns:
Dict containing variant information with keys:
- variants: List of variant dictionaries, each containing:
- id: Variant identifier
- parent_sku: Parent product SKU
- product_sku: Child product SKU for this variant
- option_values: List of option values (attribute_code, uid, value_index)
- count: Number of variants retrieved
- status: Success or error status
Example:
>>> result = get_product_variants(
... environment_id='3f73a49a-3137-472c-bb0d-39d0e7925d86',
... store_view_code='test',
... store_code='test',
... website_code='test',
... skus=['CAT-249']
... )
>>> print(result['count'])
4
>>> for variant in result['variants']:
... print(f"{variant['product_sku']}: {[opt['attribute_code'] for opt in variant['option_values']]}")
|
| get_environment_detailsA | Get environment details from Catalog Service via HTTP REST API.
This tool calls the /catalog/v1/environments endpoint to retrieve environment
information including websites, store views, and export details.
Args:
environment_ids: List of Adobe Commerce Cloud environment IDs
(e.g., ['7059bb71-341a-4ccb-b543-d7b2948b73e4'])
timeout: Request timeout in seconds (default: 15.0)
Returns:
Dict containing environment information with keys:
- status: Success or error status
- environments: List of environment details
- count: Number of environments retrieved
Example:
>>> result = get_environment_details(
... environment_ids=['7059bb71-341a-4ccb-b543-d7b2948b73e4']
... )
>>> print(result['count'])
1
>>> print(result['environments'][0]['websites'])
|
| get_environment_store_viewsA | Get all store views for a specific environment.
This is a convenience tool that retrieves environment details and extracts
all store view information in a flattened structure for easier use.
Args:
environment_id: Adobe Commerce Cloud environment ID
timeout: Request timeout in seconds (default: 15.0)
Returns:
Dict containing:
- status: Success or error status
- environment_id: The queried environment ID
- store_views: List of all store views with their codes
- websites: List of all websites with their codes
- count: Number of store views found
Example:
>>> result = get_environment_store_views('7059bb71-341a-4ccb-b543-d7b2948b73e4')
>>> for sv in result['store_views']:
... print(f"{sv['websiteCode']}/{sv['storeCode']}/{sv['storeViewCode']}")
|
| find_store_view_codesA | Find and filter store views by website and/or store code.
Useful for discovering available store view codes when you know the
website and store codes but need to find valid store view codes.
Args:
environment_id: Adobe Commerce Cloud environment ID
website_code: Optional website code to filter by
store_code: Optional store code to filter by
timeout: Request timeout in seconds (default: 15.0)
Returns:
Dict containing:
- status: Success or error status
- environment_id: The queried environment ID
- matching_store_views: List of matching store views
- count: Number of matching store views
Example:
>>> result = find_store_view_codes(
... environment_id='7059bb71-341a-4ccb-b543-d7b2948b73e4',
... website_code='base',
... store_code='main_website_store'
... )
>>> print([sv['storeViewCode'] for sv in result['matching_store_views']])
|
| get_product_overrides_by_websiteA | Get product overrides for all customer groups in a website.
This retrieves price overrides for all customer groups, not just one.
Useful when you need to see pricing across all customer segments.
Args:
environment_id: Adobe Commerce Cloud environment ID
website_code: Website code (e.g., 'base')
skus: List of product SKUs to retrieve overrides for
filter_virtual_cgs: Filter out virtual customer groups (default: False)
use_tls: Whether to use TLS connection (default: True)
timeout: Request timeout in seconds (default: 15.0)
Returns:
Dict containing product overrides with keys:
- overrides: List of product override dictionaries (all customer groups), each containing:
- customer_group_code: SHA1 hash of customer group ID
Use get_customer_group_id_from_code() to decode to numeric ID
Common hashes:
'b6589fc6ab0dc82cf12099d1c2d40ab994e8410c' = ID 0 (NOT LOGGED IN)
'356a192b7913b04c54574d18c28d46e6395428ab' = ID 1 (General/Logged In)
'da4b9237bacccdf19c0760cab7aec4a8359010b0' = ID 2 (Wholesale)
- sku, website_code, currency, prices, tier_prices, etc.
- count: Number of overrides retrieved
- status: Success or error status
Example:
>>> result = get_product_overrides_by_website.invoke({
... 'environment_id': 'abc123',
... 'website_code': 'base',
... 'skus': ['SKU123']
... })
>>> # Returns overrides for all customer groups
>>> for override in result['overrides']:
... group_id = get_customer_group_id_from_code(override['customer_group_code'])
... print(f"Group ID {group_id}: {override['customer_group_code']}, Price: {override['prices']}")
|
| get_category_permissionsA | 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']}")
|
