m openmage

OpenMage LTS Developer Documentation

Store Info

Edit this page on GitHub

Module: Store View API

Resource: store


Allows you to retrieve information about the required store view.


Type Name Description
string sessionId Session ID
string storeId Store view ID or code (optional)


Type Name Description
array result Array of storeEntity

The storeEntity content is as follows:

Type Name Description
int store_id
Store view ID
string code
Store view code
int website_id
Website ID
int group_id
Group ID
string name
Store name
int sort_order
Store view sort order
int is_active
Defines whether the store is active


Fault Code Fault Message
101 Requested store view not found.


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, 'store.info', '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->storeInfo($sessionId, '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->storeInfo((object)array('sessionId' => $sessionId->result, 'storeId' => '2'));   

Response Example SOAP V1
  'store_id' => string '2' (length=1)
  'code' => string 'english' (length=7)
  'website_id' => string '2' (length=1)
  'group_id' => string '2' (length=1)
  'name' => string 'English' (length=7)
  'sort_order' => string '0' (length=1)
  'is_active' => string '1' (length=1)