Class Mage_Catalog_Model_Product_Api

Catalog product api

Mage_Catalog_Model_Product_Api

Direct known subclasses

Package: Mage\Catalog
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Catalog/Model/Product/Api.php

Methods summary
`public`	# `__construct( )`
`public array`	# `items( null\|object\|array $filters = null, string\|integer $store = null )` Retrieve list of products with basic info (id, sku, type, set, name) Retrieve list of products with basic info (id, sku, type, set, name) Parameters `$filters` `null\|object\|array` $filters `$store` `string\|integer` $store Returns `array`
`public array`	# `info( integer\|string $productId, string\|integer $store = null, array $attributes = null, mixed $identifierType = null )` Retrieve product info Retrieve product info Parameters `$productId` `integer\|string` $productId `$store` `string\|integer` $store `$attributes` `array` $attributes `$identifierType` Returns `array`
`public integer`	# `create( string $type, integer $set, string $sku, array $productData, string $store = null )` Create new product. Create new product. Parameters `$type` `string` $type `$set` `integer` $set `$sku` `string` $sku `$productData` `array` $productData `$store` `string` $store Returns `integer`
`public boolean`	# `update( integer\|string $productId, array $productData, string\|integer $store = null, mixed $identifierType = null )` Update product data Update product data Parameters `$productId` `integer\|string` $productId `$productData` `array` $productData `$store` `string\|integer` $store `$identifierType` Returns `boolean`
`protected object`	# `_prepareDataForSave( Mage_Catalog_Model_Product $product, array $productData )` Set additional data before product saved Set additional data before product saved Parameters `$product` `Mage_Catalog_Model_Product` $product `$productData` `array` $productData Returns `object`
`public boolean`	# `setSpecialPrice( integer\|string $productId, float $specialPrice = null, string $fromDate = null, string $toDate = null, string\|integer $store = null )` Update product special price Update product special price Parameters `$productId` `integer\|string` $productId `$specialPrice` `float` $specialPrice `$fromDate` `string` $fromDate `$toDate` `string` $toDate `$store` `string\|integer` $store Returns `boolean`
`public array`	# `getSpecialPrice( integer\|string $productId, string\|integer $store = null )` Retrieve product special price Retrieve product special price Parameters `$productId` `integer\|string` $productId `$store` `string\|integer` $store Returns `array`
`public boolean`	# `delete( integer\|string $productId, mixed $identifierType = null )` Delete product Delete product Parameters `$productId` `integer\|string` $productId `$identifierType` Returns `boolean`
`public array`	# `getAdditionalAttributes( mixed $productType, mixed $attributeSetId )` Get list of additional attributes which are not in default create/update list Get list of additional attributes which are not in default create/update list Parameters `$productType` `mixed` $productType `$attributeSetId` `mixed` $attributeSetId Returns `array`
`protected`	# `_checkProductTypeExists( mixed $productType )` Check if product type exists Check if product type exists Parameters `$productType` `mixed` $productType Throw Mage_Api_Exception
`protected`	# `_checkProductAttributeSet( mixed $attributeSetId )` Check if attributeSet is exits and in catalog_product entity group type Check if attributeSet is exits and in catalog_product entity group type Parameters `$attributeSetId` `mixed` $attributeSetId Throw Mage_Api_Exception

Methods inherited from Mage_Catalog_Model_Api_Resource
`_getProduct(), _getStoreId(), _isAllowedAttribute(), currentStore()`

Methods inherited from Mage_Api_Model_Resource_Abstract
`_fault(), _getConfig(), _getServer(), _getSession(), getResourceConfig(), setResourceConfig()`

Properties summary
`protected array`	`$_filtersMap`	`array( 'product_id' => 'entity_id', 'set' => 'attribute_set_id', 'type' => 'type_id' )`	#
`protected array`	`$_defaultProductAttributeList`	`array( 'type_id', 'category_ids', 'website_ids', 'name', 'description', 'short_description', 'sku', 'weight', 'status', 'url_key', 'url_path', 'visibility', 'has_options', 'gift_message_available', 'price', 'special_price', 'special_from_date', 'special_to_date', 'tax_class_id', 'tier_price', 'meta_title', 'meta_keyword', 'meta_description', 'custom_design', 'custom_layout_update', 'options_container', 'image_label', 'small_image_label', 'thumbnail_label', 'created_at', 'updated_at' )`	#

Properties inherited from Mage_Catalog_Model_Api_Resource
`$_ignoredAttributeCodes, $_ignoredAttributeTypes, $_resourceAttributeAclName, $_storeIdSessionField`

Properties inherited from Mage_Api_Model_Resource_Abstract
`$_resourceConfig`

Packages

Classes

Interfaces

Class Mage_Catalog_Model_Product_Api

Direct known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throw

Parameters

Throw