Magento API

SOAP

About Magento API

Module: Mage_Catalog

Resource: catalog_product_link

Aliases:

  • product_link
Method:
  • catalog_product_link.remove (SOAP V1)
  • catalogProductLinkRemove (SOAP V2)

Allows you to remove the product link from a specific product.

Aliases:

  • product_link.remove

Arguments:

Type Name Description
string sessionId
Session ID
string
type
Type of the link (cross_sell, up_sell, related, or grouped)
string
product\productId
Product ID or SKU
string
linkedProduct\linkedProductId
Product ID or SKU for the link
string identifierType Defines whether the product ID or SKU is passed in the 'product' parameter

Returns:

Type Description
boolean\int True (1) if the link is removed from a product

Examples

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

// If somestuff requires api authentification,
// then get a session token
$session = $client->login('apiUser', 'apiKey');

$result = $client->call($session, 'catalog_product_link.remove', 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->catalogProductLinkRemove($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->catalogProductLinkRemove((object)array('sessionId' => $sessionId->result, 'type' => 'related', 'productId' => '1', 'linkedProductId' => '4'));

var_dump($result->result);