Module: Mage_Catalog
The Mage_Catalog module allows you to manage categories and products.
Category
Allows you to manage categories and how products are assigned to categories.
Resource Name: catalog_category
Aliases:
- category
Methods:
- catalog_category.currentStore - Set/Get the current store view
- catalog_category.tree - Retrieve the hierarchical category tree
- catalog_category.level - Retrieve one level of categories by a website, store view, or parent category
- catalog_category.info - Retrieve the category data
- catalog_category.create - Create a new category
- catalog_category.update - Update a category
- catalog_category.move - Move a category in its tree
- catalog_category.delete - Delete a category
- catalog_category.assignedProducts - Retrieve a list of products assigned to a category
- catalog_category.assignProduct - Assign product to a category
- catalog_category.updateProduct - Update an assigned product
- catalog_category.removeProduct - Remove a product assignment
Category Attributes
Allows you to retrieve the list of category attributes and options.
Resource Name: catalog_category_attribute
Aliases:
- category_attribute
Methods:
- catalog_category_attribute.currentStore - Set/Get the current store view
- catalog_category_attribute.list - Retrieve the category attributes
- catalog_category_attribute.options - Retrieve the attribute options
Product
Allows you to manage products.
Resource Name: catalog_product
Aliases:
- product
Methods:
- catalog_product.currentStore - Set/Get the current store view
- catalog_product.list - Retrieve the list of products using filters
- catalog_product.info - Retrieve information about the required product
- catalog_product.create - Create a new product
- catalog_product.update - Update a required product
- catalog_product.setSpecialPrice - Set special price for a product
- catalog_product.getSpecialPrice - Get special price for a product
- catalog_product.delete - Delete a required product
- catalog_product.listOfAdditionalAttributes - Get the list of additional attributes
Product Attributes
Allows you to retrieve product attributes and options.
Resource Name: catalog_product_attribute
Aliases:
- product_attribute
Methods:
- product_attribute.currentStore - Set/Get the current store view
- product_attribute.list - Retrieve the attribute list
- product_attribute.options - Retrieve the attribute options
- product_attribute.addOption - Add a new option for attributes with selectable fields
- product_attribute.create - Create a new attribute
- product_attribute.info - Get full information about an attribute with the list of options
- product_attribute.remove - Remove the required attribute
- product_attribute.removeOption - Remove an option for attributes with selectable fields
- product_attribute.types - Get the list of possible attribute types
- product_attribute.update - Update the required attribute
Product Attribute Sets
Allows you to retrieve product attribute sets.
Resource Name: catalog_product_attribute_set
Aliases:
- product_attribute_set
Methods:
- product_attribute_set.list - Retrieve the list of product attribute sets
- product_attribute_set.attributeAdd - Add an attribute to the attribute set
- product_attribute_set.attributeRemove - Remove an attribute from an attribute set
- product_attribute_set.create - Create a new attribute set
- product_attribute_set.groupAdd - Add a new group for attributes in the attribute set
- product_attribute_set.groupRemove - Remove a group of attributes from an attribute set
- product_attribute_set.groupRename - Rename a group of attributes in an attribute set
- product_attribute_set.remove - Remove an attribute set
Product Types
Allows you to retrieve product types.
Resource Name: catalog_product_type
Aliases:
- product_type
Methods:
- catalog_product_type.list - Retrieve the list of product types
Product Images
Allows you to manage product images.
Resource Name: catalog_product_attribute_media
Aliases:
- product_attribute_media
- product_media
Methods:
- catalog_product_attribute_media.currentStore - Set/Get the current store view
- catalog_product_attribute_media.list - Retrieve the product images
- catalog_product_attribute_media.info - Retrieve the specified product image
- catalog_product_attribute_media.types - Retrieve product image types
- catalog_product_attribute_media.create - Upload a new image for a product
- catalog_product_attribute_media.update - Update an image for a product
- catalog_product_attribute_media.remove - Remove an image for a product
Product Tier Price
Allows you to retrieve and update product tier prices.
Resource Name: catalog_product_attribute_tier_price
Aliases:
- product_attribute_tier_price
- product_tier_price
Methods:
- catalog_product_attribute_tier_price.info - Retrieve information about product tier prices
- catalog_product_attribute_tier_price.update - Update the product tier prices
Product Links
Allows you to manage links for products, including related, cross-sells, up-sells, and grouped.
Resource Name: catalog_product_link
Aliases:
- product_link
Methods:
- catalog_product_link.list - Retrieve products linked to the specified product
- catalog_product_link.assign - Link a product to another product
- catalog_product_link.update - Update a product link
- catalog_product_link.remove - Remove a product link
- catalog_product_link.types - Retrieve product link types
- catalog_product_link.attributes - Retrieve product link type attributes
Product Downloadable Link
Allows you to add, remove, and retrieve a link to a downloadable product.
Resource Name: product_downloadable_link
Methods:
- product_downloadable_link.add - Add a new link to the downloadable product
- product_downloadable_link.list - Get the list of links for a downloadable product
- product_downloadable_link.remove - Remove a link from a downloadable product
Product Tag
Allows you to add, update, remove, and retrieve product tags.
Resource Name: catalog_product_tag
Aliases:
- product_tag
Methods:
- product_tag.add - Retrieve the list of tags by the product ID
- product_tag.info - Retrieve information about a product tag
- product_tag.add - Add one or more tags to a product
- product_tag.update - Update an existing product tag
- product_tag.remove - Remove a product tag
Product Custom Option
Allows you to manage product custom options, including adding, updating, removing, and retrieving information.
Resource Name: catalog_product_custom_option
Aliases:
- product_custom_option
Methods:
- product_custom_option.add - Add a new custom option to a product
- product_custom_option.update - Update the product custom option
- product_custom_option.types - Get the list of available custom option types
- product_custom_option.list - Retrieve the list of product custom options
- product_custom_option.info - Get full information about the custom option in a product
- product_custom_option.remove - Remove the custom option
Product Custom Option Value
Allows you to manage product custom option values, including adding, updating, removing, and retrieving information.
Resource Name: catalog_product_custom_option_value
Aliases:
- product_custom_option_value
Methods:
- product_custom_option_value.add - Add a new custom option value to a selectable custom option
- product_custom_option_value.list - Retrieve the list of product custom option values
- product_custom_option_value.info - Retrieve full information about the specified product custom option value
- product_custom_option_value.update - Update the custom option value
- product_custom_option_value.remove - Remove the custom option value