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

Module: Mage_Catalog

Aliases:

  • product_link
Method:
  • catalog_product_link.assign (SOAP V1)
  • catalogProductLinkAssign (SOAP V2)

Allows you to assign a product link (cross_sell, grouped, related, or up_sell) to another product.

Aliases:

  • product_link.assign

Arguments:

TypeNameDescription
stringsessionIdSession ID
stringtypeType of the link (cross_sell, grouped, related, or up_sell)
stringproduct\productIdProduct ID or SKU
stringlinkedProduct\linkedProductIdProduct ID or SKU for the link
arraydataArray of catalogProductLinkEntity
stringidentifierTypeDefines whether the product ID or SKU is passed in the ‘product’ parameter

Returns:

TypeDescription
booleanTrue if the link is assigned to the product

The catalogProductLinkEntity content is as follows:

TypeNameDescription
stringproduct_idProduct ID
stringtypeType of the link (cross_sell, grouped, related, or up_sell)
stringsetProduct attribute set
stringskuProduct SKU
stringpositionPosition of the product
stringqtyQuantity of products

Examples

Request Example SOAP V1
$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires API authentication,
// then get a session token
$session = $client->login('apiUser', 'apikey');

$result = $client->call($session, 'catalog_product_link.assign', array('type' => 'related', 'product' => '1', 'linkedProduct' => '4'));
var_dump ($result);

// If you don't need the session anymore
//$client->endSession($session);
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->catalogProductLinkAssign($sessionId, 'related', '1', '4');
var_dump($result);
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->catalogProductLinkAssign((object)array('sessionId' => $sessionId->result, 'type' => 'related', 'productId' => '1', 'linkedProductId' => '4'));

var_dump($result->result);