Media List

Module: Mage_Catalog

Resource:catalog_product_attribute_media

Aliases:

product_attribute_media
product_media

Method:

catalog_product_attribute_media.list (SOAP V1)
catalogProductAttributeMediaList (SOAP V2)

Allows you to retrieve the list of product images.

Aliases:

product_attribute_media.list
product_media.list

Arguments:

Type	Name	Description
string	sessionId	Session ID
string	product\productId	Product ID or SKU
string	storeView	Store view ID or code (optional)
string	identifierType	Defines whether the product ID or sku is passed in the ‘product’ parameter

Returns:

Type	Name	Description
array	result	Array of catalogProductImageEntity

The catalogProductImageEntity content is as follows:

Type	Name	Description
string	file	Image file name
string	label	Image label
string	position	Image position
string	exclude	Defines whether the image will associate only to one of three image types
string	url	Image URL
ArrayOfString	types	Array of types

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_attribute_media.list', '2');
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->catalogProductAttributeMediaList($sessionId, '2');
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->catalogProductAttributeMediaList((object)array('sessionId' => $sessionId->result, 'productId' => '2'));

var_dump($result->result);

Response Example SOAP V1

array
  0 =>
    array
      'file' => string '/b/l/blackberry8100_2.jpg' (length=25)
      'label' => string '' (length=0)
      'position' => string '1' (length=1)
      'exclude' => string '0' (length=1)
      'url' => string 'http://magentopath/blackberry8100_2.jpg' (length=71)
      'types' =>
        array
          0 => string 'image' (length=5)
          1 => string 'small_image' (length=11)
          2 => string 'thumbnail' (length=9)