Magento API

SOAP

About Magento API

Module: Mage_Customer

Resource: customer_address

Method:

  • customer_address.delete (SOAP V1)
  • customerAddressDelete (SOAP V2)

Delete the required customer address.

Arguments:

Type Name Description
string sessionId Session ID
int addressId Address ID

Returns:

Type Description
boolean True if the customer address is deleted

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, 'customer_address.delete', '4');
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->customerAddressDelete($sessionId, '4');
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->customerAddressDelete((object)array('sessionId' => $sessionId->result, 'addressId' => '4'));   
var_dump($result->result);