- Introduction
-
Catalog
-
Catalog Category
- catalog_category.assignedProducts
- catalog_category.assignProduct
- catalog_category.create
- catalog_category.currentStore
- catalog_category.delete
- catalog_category.info
- catalog_category.level
- catalog_category.move
- catalog_category.removeProduct
- catalog_category.tree
- catalog_category.update
- catalog_category.updateProduct
- Catalog Category Attributes
- Catalog Product
- Catalog Product Attribute
-
Catalog Product Attribute
Media - Catalog Product Attribute Set
-
Catalog Product Custom
Option - Catalog Product Custom Option Value
- Catalog Product Downloadable Link
- Catalog Product Link
- Catalog Product Tag
- Catalog Product Tier Price
- Catalog Product Types
-
Catalog Category
- Catalog Inventory
- Checkout
- Create Your Own API
- Customer
- Directory
- Sales
- Enterprise Customer Balance
- Enterprise Gift Card
- Enterprise Gift Message
- Miscellaneous
- WS-I Compliance
Module: Product API
Resource: product
Method:
- product.listOfAdditionalAttributes (SOAP V1)
- catalogProductListOfAdditionalAttributes (SOAP V2)
Get the list of additional attributes. Additional attributes are attributes that are not in the default set of attributes.
Arguments:
Type | Name | Description |
---|---|---|
string | sessionId | Session ID |
string | productType | Product type (e.g., simple) |
string | attributeSetId | Attribute set ID |
Returns:
Type | Name | Description |
---|---|---|
int | attribute_id | Attribute ID |
string | code | Attribute code |
string |
type | Attribute type (e.g., text, select, date, etc.) |
string |
required | Defines whether the attribute is required |
string |
scope | Attribute scope (global, website, or store) |
Faults:
Fault Code | Fault Message |
---|---|
104 | Product type is not in allowed types. |
105 | Product attribute set is not existed |
106 | Product attribute set is not belong catalog product entity type |
Examples
Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl'); $sessionId = $proxy->login('apiUser', 'apiKey'); $listAttributes = $proxy->call( $sessionId, 'product.listOfAdditionalAttributes', array( 'simple', 13 ) );
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url $sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary $result = $proxy->catalogProductListOfAdditionalAttributes($sessionId, 'simple', '13'); var_dump($result);
Response Example SOAP V1
array 0 => array 'attribute_id' => string '89' (length=2) 'code' => string 'old_id' (length=6) 'type' => string 'text' (length=4) 'required' => string '0' (length=1) 'scope' => string 'global' (length=6) 1 => array 'attribute_id' => string '93' (length=2) 'code' => string 'news_from_date' (length=14) 'type' => string 'date' (length=4) 'required' => string '0' (length=1) 'scope' => string 'website' (length=7) 2 => array ...