Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Module: Product Attribute Set API

Resource: product_attribute_set

Method:
  • product_attribute_set.attributeAdd (SOAP V1)
  • catalogProductAttributeSetAttributeAdd (SOAP V2)

Allows you to add an existing attribute to an attribute set.

Arguments:

TypeNameDescription
stringsessionIdSession ID
stringattributeIdAttribute ID
stringattributeSetIdAttribute set ID
stringattributeGroupIdGroup ID (optional)
stringsortOrderSort order (optional)

Note: If the attributeGroupId parameter is not passed, the attribute is added to the General group by default.

Returns:

TypeNameDescription
booleanisAddedTrue if the attribute is added to an attribute set

Faults:

Fault CodeFault Message
104Attribute set with requested id does not exist.
106Attribute with requested id does not exist.
107Error while adding attribute to attribute set. Details in error message.
108Attribute group with requested id does not exist.
109Requested attribute is already in requested attribute set.

Examples

Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');

$setId = 5;
$attributeId = 83;

$result = $proxy->call(
    $sessionId,
    "product_attribute_set.attributeAdd",
    array(
         $attributeId,
         $setId
    )
);
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');

$setId = 5;
$attributeId = 83;

$result = $proxy->catalogProductAttributeSetAttributeAdd(
    $sessionId,
    $attributeId,
    $setId
);
Request Example SOAP V2 (WS-I Compliance Mode)
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

$sessionId = $proxy->login((object)array('username' => 'apiUser', 'apiKey' => 'apiKey'));

$result = $proxy->catalogProductAttributeSetAttributeAdd((object)array('sessionId' => $sessionId->result, 'attributeId' => '5', 'attributeSetId' => '83'));
var_dump($result->result);