Magento API

SOAP

About Magento API

Module: Mage_Catalog

Resource: catalog_product_link

Aliases:

  • product_link
Method:
  • catalog_product_link.attributes (SOAP V1)
  • catalogProductLinkAttributes (SOAP V2)

Allows you to retrieve the product link type attributes.

Aliases:

  • product_link.attributes

Arguments:

Type Name Description
string sessionId
Session ID
string type
Type of the link (cross_sell, up_sell, related, or grouped)

Returns:

Type Name Description
array result Array of catalogProductLinkAttributeEntity

The catalogProductLinkAttributeEntity content is as follows:

Type Name Description
string code Attribute code
string type Attribute type

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.attributes', 'related');
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->catalogProductLinkAttributes($sessionId, 'related');
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->catalogProductLinkAttributes((object)array('sessionId' => $sessionId->result, 'type' => 'related'));

var_dump($result->result);
Response Example SOAP V1
array
  0 =>
    array
      'code' => string 'position' (length=8)
      'type' => string 'int' (length=3)