====== Product links API (related, cross sells, up sells) ====== Allows to import/export linked products **Module: ** Mage_Catalog **Resource:** catalog_product_link **Aliases:** * product_link ===== Methods ===== ==== catalog_product_link.list ==== Retrieve linked products **Return: ** array **Arguments:** * string type - link type (cross_sell, up_sell, related) * mixed product - product ID or Sku **Aliases:** * product_link.list ====== ==== catalog_product_link.assign ==== Assign product link **Return:** boolean **Arguments:** * string type - link type (up_sell, cross_sell, related) * mixed product - product ID or Sku * mixed linkedProduct - product ID or Sku for link * array data - link data (position, qty, etc ...) (optional) **Aliases:** * product_link.assign ====== ==== catalog_product_link.update ==== Update product link **Return:** boolean **Arguments:** * string type - link type (up_sell, cross_sell, related) * mixed product - product ID or Sku * mixed linkedProduct - product ID or Sku for link * array data - link data (position, qty, etc ...) (optional) **Aliases:** * product_link.update ====== ==== catalog_product_link.remove ==== Remove product link **Return:** boolean **Arguments:** * string type - link type (up_sell, cross_sell, related) * mixed product - product ID or Sku * mixed linkedProduct - product ID or Sku for link **Aliases:** * product_link.remove ====== ==== catalog_product_link.types ==== Retrieve product link types **Return:** array **Aliases:** * product_link.types ====== ==== catalog_product_link.attributes ==== Retrieve product link type attributes **Return: ** array **Arguments:** * string type - link type (cross_sell, up_sell, related) **Aliases:** * product_link.attributes ====== ===== Faults ===== ^ Fault Code ^ Fault Message ^ | 100 | Given invalid link type. | | 101 | Product not exists. | | 102 | Invalid data given. Details in error message. | | 104 | Product link not removed. | ===== Examples ===== ==== Example 1. Working with product links ==== $proxy = new SoapClient('http://magentohost/api/soap/?wsdl'); $sessionId = $proxy->login('apiUser', 'apiKey'); // Get list of related products var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku'))); // Assign related product $proxy->call($sessionId, 'product_link.assign', array('related', 'Sku', 'Sku2', array('position'=>0, 'qty'=>56))); var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku'))); // Update related product $proxy->call($sessionId, 'product_link.update', array('related', 'Sku', 'Sku2', array('position'=>2))); var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku'))); // Remove related product $proxy->call($sessionId, 'product_link.remove', array('related', 'Sku', 'Sku2')); var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));