Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Module: Mage_Customer

Allows you to export/import customers from/to Magento

Resource: customer

Method:

  • customer.delete (SOAP V1)
  • customerCustomerDelete (SOAP V2)

Delete the required customer.

Arguments:

TypeNameDescription
stringsessionIdSession ID
intcustomerIdCustomer ID

Returns:

TypeDescription
booleanTrue if the customer is deleted

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, 'customer.delete', '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->customerCustomerDelete($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->customerCustomerDelete((object)array('sessionId' => $sessionId->result, 'customerId' => '2'));   
var_dump($result->result);