Last modified by jubin ri on Sat, January 14, 2012 07:13
Source|Old Revisions  

This is an old revision of the document!

Supported types


SOAP adapter is default adapter for webservices. If you want to connect to Magento SOAP webservices you should load WSDL from this link (http://youmagentohost/api/?wsdl or http://youmagentohost/api/soap/?wsdl) in your SoapClient

As of v1.3 you may also use http://yourmagentohost/api/v2_soap?wsdl=1 which has been added to improve compatbility with Java and .NET.


  1. $client = new SoapClient('http://youmagentohost/api/?wsdl');
  2. // If soap isn't default use this link instead
  3. // http://youmagentohost/api/soap/?wsdl
  5. // If somestuff requires api authentification,
  6. // we should get session token
  7. $session = $client->login('apiUser', 'apiKey');
  9. $result = $client->call($session, 'somestuff.method');
  10. $result = $client->call($session, 'somestuff.method', 'arg1');
  11. $result = $client->call($session, 'somestuff.method', array('arg1', 'arg2', 'arg3'));
  12. $result = $client->multiCall($session, array(
  13.      array('somestuff.method'),
  14.      array('somestuff.method', 'arg1'),
  15.      array('somestuff.method', array('arg1', 'arg2'))
  16. ));
  19. // If you don't need the session anymore
  20. $client->endSession($session);


Xml rpc is available at http://youmagentohost/api/xmlrpc/


  1. $client = new Zend_XmlRpc_Client('http://youmagentohost/api/xmlrpc/');
  3. // If somestuff requires api authentification,
  4. // we should get session token
  5. $session = $client->call('login', array('apiUser', 'apiKey'));
  7. $client->call('call', array($session, 'somestuff.method', array('arg1', 'arg2', 'arg3')));
  8. $client->call('call', array($session, 'somestuff.method', 'arg1'));
  9. $client->call('call', array($session, 'somestuff.method'));
  10. $client->call('multiCall', array($session,
  11.      array(
  12.         array('somestuff.method', 'arg1'),
  13.         array('somestuff.method', array('arg1', 'arg2')),
  14.         array('somestuff.method')
  15.      )
  16. ));
  18. // If you don't need the session anymore
  19. $client->call('endSession', array($session));

Basic API met hhhh hods

Method Description Return Value
startSession() start API session and return sessionId string
endSession(sessionId) end API session boolean
login(apiUser, apiKey) start API session, return sessionId and authorize apiUser string
call(sessionId, resourcePath,array arguments) call api resource that is allowed in current session (if no session is specified, you can call only resources that are not protected by ACL) mixed
multiCall(sessionId, array calls,array options) call api resource’s methods that are allowed for current session (if no session is specified, you can call only resources that are not protected by ACL). If “break” option is specified, multicall breaks on first error array
resources(sessionId) return list of available API resources and methods allowed for current session. array
globalFaults(sessionId) return list of fault messages and their codes, that do not depend on any resource. array
resourceFaults(sessionId, resourceName) return list of the specified resource fault messages, if this resource is allowed in current session. array

Global API Faults

Fault Code Fault Message
0 Unknown Error
1 Internal Error. Please see log for details.
2 Access denied.
3 Invalid api path.
4 Resource path is not callable.

Magento Core API

The list of available Magento Core API calls can be found here

Create your own API

The tutorial on how to create custom API for your own modules or to add more API calls in core modules is available here.