这在任何地方(其他地方)都没有记录,但至少在 Magento 1.6 中,可以在源代码中找到产品选项的适当 API 方法。(我不知道该功能从哪个版本开始存在。)
API 本身定义在:app/code/core/Mage/Catalog/etc/api.xml
<catalog_product_custom_option translate="title" module="catalog">
<title>Catalog product custom options API</title>
<model>catalog/product_option_api</model>
<acl>catalog/product/option</acl>
<methods>
<add translate="title" module="catalog">
<title>Add new custom option into product</title>
<acl>catalog/product/option/add</acl>
</add>
<update translate="title" module="catalog">
<title>Update custom option of product</title>
<acl>catalog/product/option/update</acl>
</update>
<types translate="title" module="catalog">
<title>Get list of available custom option types</title>
<acl>catalog/product/option/types</acl>
</types>
<info translate="title" module="catalog">
<title>Get full information about custom option in product</title>
<acl>catalog/product/option/info</acl>
</info>
<list translate="title" module="catalog">
<title>Retrieve list of product custom options</title>
<acl>catalog/product/option/list</acl>
<method>items</method>
</list>
<remove translate="title" module="catalog">
<title>Remove custom option</title>
<acl>catalog/product/option/remove</acl>
</remove>
</methods>
</catalog_product_custom_option>
调用的函数定义在:app/code/core/Mage/Catalog/Model/Product/Option/Api.php
class Mage_Catalog_Model_Product_Option_Api extends Mage_Catalog_Model_Api_Resource
{
/**
* Add custom option to product
*
* @param string $productId
* @param array $data
* @param int|string|null $store
* @return bool $isAdded
*/
public function add( $productId, $data, $store = null )
/**
* Update product custom option data
*
* @param string $optionId
* @param array $data
* @param int|string|null $store
* @return bool
*/
public function update( $optionId, $data, $store = null )
/**
* Read list of possible custom option types from module config
*
* @return array
*/
public function types()
/**
* Get full information about custom option in product
*
* @param int|string $optionId
* @param int|string|null $store
* @return array
*/
public function info( $optionId, $store = null )
/**
* Retrieve list of product custom options
*
* @param string $productId
* @param int|string|null $store
* @return array
*/
public function items( $productId, $store = null )
/**
* Remove product custom option
*
* @param string $optionId
* @return boolean
*/
public function remove( $optionId )
/**
* Check is type in allowed set
*
* @param string $type
* @return bool
*/
protected function _isTypeAllowed( $type )
}
-array 也有点棘手,因为它的$data
键部分取决于所选的选项类型。基本的 $data-array 如下所示:
$data = array (
'is_delete' => 0,
'title' => 'Custom Option Label',
'type' => 'text',
'is_require' => 0,
'sort_order' => 1,
'additional_fields' => array (
0 => array (
'price' => '10.0000',
'price_type' => 'fixed', // 'fixed' or 'percent'
'sku' => '',
),
),
);
additional_fields
总是包含至少一行,至少有列price
,price_type
和sku
。根据类型,可能会添加更多附加字段(maf: ...)。组中的类型select
可能在 中指定了不止一行additional_fields
。自定义选项类型/类型组是:
- 文本 (maf:
'max_characters'
)
- 文件 (maf:
'file_extension', 'image_size_x', 'image_size_y'
)
- 选择 (maf:
'value_id', 'title', 'sort_order'
)
- 日期
完整选项数据数组的示例:
// type-group: select, type: checkbox
$data = array (
'is_delete' => 0,
'title' => 'extra Option for that product',
'type' => 'checkbox',
'is_require' => 0,
'sort_order' => 1,
'additional_fields' => array (
0 => array (
'value_id' => '3',
'title' => 'Yes',
'price' => 10.00,
'price_type' => 'fixed',
'sku' => NULL,
'sort_order' => 1,
),
1 => array (
'value_id' => 3,
'title' => 'No',
'price' => 0.00,
'price_type' => 'fixed',
'sku' => NULL,
'sort_order' => 2,
),
),
);
// type-group: text, type: field
$data = array (
'is_delete' => 0,
'title' => 'Custom Option Label',
'type' => 'text',
'is_require' => 0,
'sort_order' => 1,
'additional_fields' => array (
0 => array (
'price' => 10.00,
'price_type' => 'fixed',
'sku' => NULL,
'max_characters' => 150,
),
),
);