m openmage

OpenMage LTS Developer Documentation

Product Tag Info

Edit this page on GitHub

Module: Tag API

Resource: catalog_product_tag

Aliases: product_tag


Allows you to retrieve information about the required product tag.


Type Name Description
string sessionId Session ID
string tagId Tag ID
string store Store view code or ID


Type Name Description
array result Array of catalogProductTagInfoEntity

The catalogProductTagInfoEntity content is as follows:

Type Name Description
string name Tag name
string status Tag status
string base_popularity Tag base popularity for a specific store
associativeArray products Associative array of tagged products with related product ID as a key and popularity as a value


Fault Code Fault Message
101 Requested store does not exist.
104 Requested tag does not exist.


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_tag.info', array('tagId' => '4', 'store' => '2'));
var_dump ($result);
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->catalogProductTagInfo($sessionId, '4', '2');
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->catalogProductTagInfo((object)array('sessionId' => $sessionId->result, 'tagId' => '4', 'store' => '2'));
Response Example SOAP V1
  'status' => string '1' (length=1)
  'name' => string 'digital' (length=7)
  'base_popularity' => int 0
  'products' =>
      1 => string '1' (length=1)
      3 => string '1' (length=1)
      4 => string '1' (length=1)