Mage_Customer

magento-1

Módulo Mage_Customer: gerenciamento de customers, customer groups e customer addresses via SOAP v1/v2.

Module: Mage_Customer

The Mage_Customer module exposes three SOAP resources that together cover the customer lifecycle: customers, customer groups, and customer addresses. All calls require a sessionId obtained from login().

Nota (PT-BR): este módulo agrupa 3 recursos diferentes do devdocs-m1 em uma mesma página. Use o filtro do TOC à esquerda para saltar rapidamente entre customer.*, customer_group.* e customer_address.*.

Resource: `customer`

Allows you to create, retrieve, update, and delete customers (5 methods: list, create, info, update, delete).

Faults — `customer`

Code	Message
`100`	Invalid customer data. Details in error message.
`101`	Invalid filters specified. Details in error message.
`102`	Customer does not exist.
`103`	Customer not deleted. Details in error message.

Resource: `customer_group`

Read-only access to customer groups (1 method: list). This resource has no specific faults — apenas os Global API Faults.

Resource: `customer_address`

Create, retrieve, update, and delete addresses attached to a customer (5 methods: list, create, info, update, delete).

Faults — `customer_address`

Code	Message
`100`	Invalid address data. Details in error message.
`101`	Customer not exists.
`102`	Address not exists.
`103`	Address not deleted. Details in error message.

v1 × v2 — detalhes práticos para `customer.create`

Na API v1, customer.create costuma receber password_hash (MD5 com ou sem salt, formato md5($salt.$password).":".$salt). Na API v2 o campo é password em texto — o próprio Magento calcula o hash. Misturar os dois formatos gera login quebrado: se você passar password na v1 em versões < 1.3.2.4, a senha pode ser gravada em claro sem hash. Padronize por versão, não misture.

Exemplos oficiais de CRUD (SOAP V1)

Os blocos abaixo reproduzem verbatim os exemplos do devdocs-m1 (customer.html e customerAddress/customerAddress.html). Useful como referência end-to-end para quem está começando.

1 · View, create, update, and delete a customer

$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');

$newCustomer = array(
    'firstname'     => 'First',
    'lastname'      => 'Last',
    'email'         => 'test@example.com',
    // em Magento < 1.3.2.4 NÃO hashear a senha manualmente;
    // 'password_hash' => md5($password) ou md5($salt.$password).":".$salt
    'password_hash' => md5('password'),
    'store_id'      => 0,
    'website_id'    => 0,
);

$newCustomerId = $proxy->call($sessionId, 'customer.create', array($newCustomer));

// Read
var_dump($proxy->call($sessionId, 'customer.info', $newCustomerId));

// Update
$proxy->call($sessionId, 'customer.update', array($newCustomerId, ['firstname' => 'Changed Firstname']));
var_dump($proxy->call($sessionId, 'customer.info', $newCustomerId));

// Delete
$proxy->call($sessionId, 'customer.delete', $newCustomerId);

2 · Working with customer address

$proxy = new SoapClient('http://magentohost/api/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');

$newCustomerId = $proxy->call($sessionId, 'customer.create', array([
    'firstname'  => 'First',
    'lastname'   => 'Last',
    'email'      => 'test@example.com',
    'password'   => 'password',
    'store_id'   => 0,
    'website_id' => 0,
]));

$newAddressId = $proxy->call($sessionId, 'customer_address.create', array($newCustomerId, [
    'firstname'           => 'First',
    'lastname'            => 'Last',
    'country_id'          => 'USA',
    'region_id'           => '43',
    'region'              => 'New York',
    'city'                => 'New York',
    'street'              => ['street1', 'street2'],
    'telephone'           => '5555-555',
    'postcode'            => 10021,
    'is_default_billing'  => true,
    'is_default_shipping' => true,
]));

var_dump($proxy->call($sessionId, 'customer_address.list', $newCustomerId));
$proxy->call($sessionId, 'customer_address.update', array($newAddressId, ['firstname' => 'Changed Firstname']));
$proxy->call($sessionId, 'customer_address.delete', $newAddressId);

SOAP


                                    customer.list

Session_token

Retrieve the list of customers

Allows you to retrieve the list of customers.

The response is an array of customerCustomerEntity. Optional filters can narrow results by any customer attribute — in SOAP V2 prefer complex_filter with operators (in, gt, eq, …).

SOAP V2 method: customerCustomerList.

Returns

Type	Name	Description
`array`	`storeView`	Array of customerCustomerEntity

Entity: `customerCustomerEntity`

Type	Name	Description
`int`	`customer_id`	ID of the customer
`string`	`created_at`	Date when the customer was created
`string`	`updated_at`	Date when the customer was updated
`string`	`increment_id`	Increment ID
`int`	`store_id`	Store ID
`int`	`website_id`	Website ID
`string`	`created_in`	Store view the customer was created in
`string`	`email`	Customer email
`string`	`firstname`	Customer first name
`string`	`middlename`	Customer middle name
`string`	`lastname`	Customer last name
`int`	`group_id`	Customer group ID
`string`	`prefix`	Customer prefix
`string`	`suffix`	Customer suffix
`string`	`dob`	Customer date of birth
`string`	`taxvat`	Tax/VAT number
`boolean`	`confirmation`	Confirmation flag
`string`	`password_hash`	Password hash
`string`	`rp_token`	Reset password token (apenas em customer.info)
`string`	`rp_token_created_at`	Date when the password was reset (apenas em customer.info)

Note: The password_hash only matches if you replicate the exact MD5+salt format Magento used at write time — there is no server-side re-hash for comparison.

Applies resource faults — customer (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid customer data. Details in error message.
`101`	Invalid filters specified. Details in error message.
`102`	Customer does not exist.
`103`	Customer not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID returned by login()
filters	array	Não	Map of customer attribute → value. In V2 use complex_filter for operators.

Exemplo de Resposta

array
  0 =>
    array
      'customer_id' => string '2' (length=1)
      'created_at' => string '2012-03-29 12:37:23' (length=19)
      'updated_at' => string '2012-04-03 11:20:18' (length=19)
      'store_id' => string '2' (length=1)
      'website_id' => string '2' (length=1)
      'created_in' => string 'English' (length=7)
      'default_billing' => string '3' (length=1)
      'default_shipping' => string '3' (length=1)
      'disable_auto_group_change' => string '0' (length=1)
      'email' => string 'test@example.com' (length=16)
      'firstname' => string 'John' (length=4)
      'group_id' => string '1' (length=1)
      'lastname' => string 'Doe' (length=3)
      'password_hash' => string 'cccfb3ecf54c9644a34106783148eff2:sp' (length=35)
      'rp_token' => string '15433dd072f1f4e5aae83231b93f72d0' (length=32)
      'rp_token_created_at' => string '2012-03-30 15:10:31' (length=19)
  1 =>
    array
      'customer_id' => string '4' (length=1)
      'created_at' => string '2012-04-03 11:21:15' (length=19)
      'email' => string 'shon@example.com' (length=16)
      'firstname' => string 'Shon' (length=4)
      'group_id' => string '1' (length=1)
      'lastname' => string 'McMiland' (length=8)

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

// Sem filtro — retorna todos os customers visíveis para o usuário da API.
$result = $client->call($session, 'customer.list');
var_dump($result);

// Com filtros simples (V1): chaves = atributos, valores = comparação exata.
$result = $client->call($session, 'customer.list', [['group_id' => '1']]);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');

$result = $proxy->customerCustomerList($sessionId);

// Complex filter: group_id IN (1,3)
$result = $proxy->customerCustomerList($sessionId, [
    'complex_filter' => [
        ['key' => 'group_id', 'value' => ['key' => 'in', 'value' => '1,3']],
    ],
]);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerCustomerList((object) ['sessionId' => $sessionId->result, 'filters' => null]);
var_dump($result->result);

Documentação oficial

SOAP


                                    customer.create

Session_token

Create a new customer

Create a new customer. The required fields vary by Magento configuration — at minimum supply email, firstname, lastname, website_id, group_id and the appropriate password field for your API version (see overview → v1 × v2).

SOAP V2 method: customerCustomerCreate.

Returns

Type	Name	Description
`int`	`result`	ID of the created customer

Entity: `customerCustomerEntityToCreate`

Type	Name	Description
`string`	`email`	Customer email
`string`	`firstname`	Customer first name
`string`	`lastname`	Customer last name
`string`	`password`	Customer password (v2 text; em v1 prefira password_hash — ver overview)
`int`	`website_id`	Website ID
`int`	`store_id`	Store ID
`int`	`group_id`	Group ID
`string`	`prefix`	Customer prefix (optional)
`string`	`suffix`	Customer suffix (optional)
`string`	`dob`	Customer date of birth (optional)
`string`	`taxvat`	Customer tax/VAT number (optional)
`int`	`gender`	Customer gender: 1 - Male, 2 - Female (optional)
`string`	`middlename`	Customer middle name/initial (optional)

Applies resource faults — customer (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid customer data. Details in error message.
`101`	Invalid filters specified. Details in error message.
`102`	Customer does not exist.
`103`	Customer not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID returned by login()
customerData	customerCustomerEntityToCreate	Sim	Objeto com os atributos do novo customer (ver schema abaixo)

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$newCustomerId = $client->call($session, 'customer.create', [[
    'email'      => 'mail@example.org',
    'firstname'  => 'Dough',
    'lastname'   => 'Deeks',
    'password'   => 'password',   // V1 aceita 'password' OU 'password_hash'; padronize por projeto
    'website_id' => 1,
    'store_id'   => 1,
    'group_id'   => 1,
]]);
echo "New customer ID: {$newCustomerId}\n";

$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$newCustomerId = $client->customerCustomerCreate($session, [
    'email'      => 'customer-mail@example.org',
    'firstname'  => 'Dough',
    'lastname'   => 'Deeks',
    'password'   => 'password',   // V2: sempre em claro; o servidor gera o hash
    'website_id' => 1,
    'store_id'   => 1,
    'group_id'   => 1,
]);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);

$result = $proxy->customerCustomerCreate((object) [
    'sessionId'    => $sessionId->result,
    'customerData' => (object) [
        'email'      => 'customer-mail@example.org',
        'firstname'  => 'John',
        'lastname'   => 'Dou',
        'password'   => '123123',
        'website_id' => '0',
        'group_id'   => '1',
    ],
]);
var_dump($result->result);

<!--
  Envelope SOAP cru — customer.create (V1).
  Sintético, derivado do WSDL em http://magentohost/api/?wsdl.
  Útil para integrações fora do ecossistema PHP (Java/.NET/Node raw).
-->
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:ns1="urn:Magento">
  <SOAP-ENV:Body>
    <ns1:call>
      <sessionId xsi:type="xsd:string">SESSION_ID_FROM_LOGIN</sessionId>
      <resourcePath xsi:type="xsd:string">customer.create</resourcePath>
      <args SOAP-ENC:arrayType="xsd:anyType[1]" xsi:type="SOAP-ENC:Array">
        <item xsi:type="SOAP-ENC:Struct">
          <email xsi:type="xsd:string">mail@example.org</email>
          <firstname xsi:type="xsd:string">Dough</firstname>
          <lastname xsi:type="xsd:string">Deeks</lastname>
          <password xsi:type="xsd:string">password</password>
          <website_id xsi:type="xsd:int">1</website_id>
          <store_id xsi:type="xsd:int">1</store_id>
          <group_id xsi:type="xsd:int">1</group_id>
        </item>
      </args>
    </ns1:call>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<!-- Resposta típica (HTTP 200): -->
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:ns1="urn:Magento">
  <SOAP-ENV:Body>
    <ns1:callResponse>
      <callReturn xsi:type="xsd:int">42</callReturn>
    </ns1:callResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Documentação oficial

SOAP


                                    customer.info

Session_token

Retrieve information about the specified customer

Retrieve information about the specified customer. When attributes is provided, only those attributes are returned — customer_id is always included regardless.

SOAP V2 method: customerCustomerInfo.

Returns

Type	Name	Description
`array`	`customerInfo`	Array/objeto customerCustomerEntity (ver schema abaixo)

Entity: `customerCustomerEntity`

Type	Name	Description
`int`	`customer_id`	ID of the customer
`string`	`created_at`	Date when the customer was created
`string`	`updated_at`	Date when the customer was updated
`string`	`increment_id`	Increment ID
`int`	`store_id`	Store ID
`int`	`website_id`	Website ID
`string`	`created_in`	Store view the customer was created in
`string`	`email`	Customer email
`string`	`firstname`	Customer first name
`string`	`middlename`	Customer middle name
`string`	`lastname`	Customer last name
`int`	`group_id`	Customer group ID
`string`	`prefix`	Customer prefix
`string`	`suffix`	Customer suffix
`string`	`dob`	Customer date of birth
`string`	`taxvat`	Tax/VAT number
`boolean`	`confirmation`	Confirmation flag
`string`	`password_hash`	Password hash
`string`	`rp_token`	Reset password token (apenas em customer.info)
`string`	`rp_token_created_at`	Date when the password was reset (apenas em customer.info)

Applies resource faults — customer (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid customer data. Details in error message.
`101`	Invalid filters specified. Details in error message.
`102`	Customer does not exist.
`103`	Customer not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
customerId	int	Sim	ID of the target customer
attributes	ArrayOfString	Não	Lista de atributos a retornar; vazio = todos

Exemplo de Resposta

array
  'customer_id' => string '2' (length=1)
  'created_at' => string '2012-03-29 12:37:23' (length=19)
  'updated_at' => string '2012-03-30 12:59:21' (length=19)
  'increment_id' => null
  'store_id' => string '2' (length=1)
  'website_id' => string '2' (length=1)
  'confirmation' => null
  'created_in' => string 'English' (length=7)
  'default_billing' => null
  'default_shipping' => string '2' (length=1)
  'disable_auto_group_change' => string '0' (length=1)
  'dob' => null
  'email' => string 'john@example.com' (length=16)
  'firstname' => string 'johny' (length=5)
  'gender' => null
  'group_id' => string '1' (length=1)
  'lastname' => string 'doe' (length=3)
  'middlename' => null
  'password_hash' => string 'cccfb3ecf54c9644a34106783148eff2:sp' (length=35)
  'prefix' => null
  'rp_token' => string '15433dd072f1f4e5aae83231b93f72d0' (length=32)
  'rp_token_created_at' => string '2012-03-30 15:10:31' (length=19)
  'suffix' => null
  'taxvat' => null

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$customer = $client->call($session, 'customer.info', 2);

// Apenas alguns atributos:
$slim = $client->call($session, 'customer.info', [2, ['customer_id', 'email', 'firstname']]);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$customer = $proxy->customerCustomerInfo($sessionId, 2, ['email', 'firstname', 'lastname']);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerCustomerInfo((object) [
    'sessionId'  => $sessionId->result,
    'customerId' => 2,
]);
var_dump($result->result);

Documentação oficial

SOAP


                                    customer.update

Session_token

Update information about the required customer

Update information about the required customer. Pass only the fields you want to change. Fields omitted from customerData are left as-is; fields set to an empty string "" are overwritten with empty.

SOAP V2 method: customerCustomerUpdate.

Returns

Type	Description
`boolean`	True if the customer was updated

Entity: `customerCustomerEntityToCreate`

Type	Name	Description
`string`	`email`	Customer email
`string`	`firstname`	Customer first name
`string`	`lastname`	Customer last name
`string`	`password`	Customer password (v2 text; em v1 prefira password_hash — ver overview)
`int`	`website_id`	Website ID
`int`	`store_id`	Store ID
`int`	`group_id`	Group ID
`string`	`prefix`	Customer prefix (optional)
`string`	`suffix`	Customer suffix (optional)
`string`	`dob`	Customer date of birth (optional)
`string`	`taxvat`	Customer tax/VAT number (optional)
`int`	`gender`	Customer gender: 1 - Male, 2 - Female (optional)
`string`	`middlename`	Customer middle name/initial (optional)

Applies resource faults — customer (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid customer data. Details in error message.
`101`	Invalid filters specified. Details in error message.
`102`	Customer does not exist.
`103`	Customer not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
customerId	int	Sim	ID of the customer to update
customerData	customerCustomerEntityToCreate	Sim	Campos a atualizar (passe só os que mudam)

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$ok = $client->call($session, 'customer.update', [
    2,                                  // customerId
    ['firstname' => 'John', 'lastname' => 'Doe'],  // apenas os campos que mudam
]);
var_dump($ok);   // bool(true)

$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');
$ok = $client->customerCustomerUpdate($session, 2, [
    'firstname' => 'Dough',
    'lastname'  => 'Deekson',
]);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);

$result = $proxy->customerCustomerUpdate((object) [
    'sessionId'    => $sessionId->result,
    'customerId'   => 2,
    'customerData' => (object) [
        'email'     => 'customer-mail@example.org',
        'firstname' => 'Dough',
        'lastname'  => 'Deekson',
    ],
]);
var_dump($result->result);

<!--
  Envelope SOAP cru — customer.update (V1).
  Sintético, derivado do WSDL em http://magentohost/api/?wsdl.
-->
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:ns1="urn:Magento">
  <SOAP-ENV:Body>
    <ns1:call>
      <sessionId xsi:type="xsd:string">SESSION_ID_FROM_LOGIN</sessionId>
      <resourcePath xsi:type="xsd:string">customer.update</resourcePath>
      <args SOAP-ENC:arrayType="xsd:anyType[2]" xsi:type="SOAP-ENC:Array">
        <item xsi:type="xsd:int">2</item>
        <item xsi:type="SOAP-ENC:Struct">
          <firstname xsi:type="xsd:string">John</firstname>
          <lastname xsi:type="xsd:string">Doe</lastname>
        </item>
      </args>
    </ns1:call>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<!-- Resposta típica (HTTP 200): -->
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:ns1="urn:Magento">
  <SOAP-ENV:Body>
    <ns1:callResponse>
      <callReturn xsi:type="xsd:boolean">true</callReturn>
    </ns1:callResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Documentação oficial

SOAP


                                    customer.delete

Session_token

Delete the required customer

Delete the required customer. Operação é irreversível — registros relacionados (endereços, pedidos antigos) seguem as regras de exclusão definidas no admin Magento.

SOAP V2 method: customerCustomerDelete.

Returns

Type	Description
`boolean`	True if the customer was deleted

Applies resource faults — customer (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid customer data. Details in error message.
`101`	Invalid filters specified. Details in error message.
`102`	Customer does not exist.
`103`	Customer not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
customerId	int	Sim	ID of the customer to delete

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$ok = $client->call($session, 'customer.delete', 2);
var_dump($ok);   // bool(true) se deletou

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$ok = $proxy->customerCustomerDelete($sessionId, 2);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerCustomerDelete((object) [
    'sessionId'  => $sessionId->result,
    'customerId' => 2,
]);

Documentação oficial

SOAP


                                    customer_group.list

Session_token

Retrieve the list of customer groups

Retrieve the list of customer groups defined in Magento (configuráveis em Customers → Customer Groups no admin). Sem argumentos além do sessionId.

SOAP V2 method: customerGroupList.

Returns

Type	Name	Description
`array`	`result`	Array of customerGroupEntity

Entity: `customerGroupEntity`

Type	Name	Description
`int`	`customer_group_id`	ID of the customer group
`string`	`customer_group_code`	Human-readable group code (ex.: General, Wholesale)

Sem faults específicos — aplicam-se apenas os Global API Faults Ver na Introduction ↗

O devdocs-m1 não lista faults para o resource customer_group. Erros caem nos faults globais (0 Unknown, 1 Internal, 2 Access denied, 3 Invalid API path, 4 Resource path is not callable).

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID

Exemplo de Resposta

array
  0 =>
    array
      'customer_group_id' => string '0' (length=1)
      'customer_group_code' => string 'NOT LOGGED IN' (length=13)
  1 =>
    array
      'customer_group_id' => string '1' (length=1)
      'customer_group_code' => string 'General' (length=7)
  2 =>
    array
      'customer_group_id' => string '2' (length=1)
      'customer_group_code' => string 'Wholesale' (length=9)
  3 =>
    array
      'customer_group_id' => string '3' (length=1)
      'customer_group_code' => string 'Retailer' (length=8)

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');
$groups = $client->call($session, 'customer_group.list');

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$groups = $proxy->customerGroupList($sessionId);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerGroupList((object) ['sessionId' => $sessionId->result]);
var_dump($result->result);

Documentação oficial

SOAP


                                    customer_address.list

Session_token

Retrieve the list of customer addresses

Retrieve all addresses of a given customer. Retorna array vazio se o customer não tem endereços.

SOAP V2 method: customerAddressList.

Returns

Type	Name	Description
`array`	`result`	Array of customerAddressEntity

Entity: `customerAddressEntity` (alias de `customerAddressEntityItem`)

Type	Name	Description
`int`	`customer_address_id`	ID of the customer address
`string`	`created_at`	Date when the address was created
`string`	`updated_at`	Date when the address was updated
`string`	`increment_id`	Increment ID
`string`	`city`	City
`string`	`company`	Name of the company
`string`	`country_id`	ISO country ID (ex.: US, BR)
`string`	`fax`	Fax
`string`	`firstname`	Customer first name
`string`	`lastname`	Customer last name
`string`	`middlename`	Customer middle name
`string`	`postcode`	Postcode
`string`	`prefix`	Customer prefix
`string`	`region`	Region name
`int`	`region_id`	Region ID (lookup via directory_region.list)
`string`	`street`	Street line(s)
`string`	`suffix`	Customer suffix
`string`	`telephone`	Telephone number
`boolean`	`is_default_billing`	True if this is the default billing address
`boolean`	`is_default_shipping`	True if this is the default shipping address

Applies resource faults — customer_address (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer_address podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid address data. Details in error message.
`101`	Customer not exists.
`102`	Address not exists.
`103`	Address not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
customerId	int	Sim	Customer ID

Exemplo de Resposta

array
  0 =>
    array
      'customer_address_id' => string '2' (length=1)
      'created_at' => string '2012-03-29 13:20:08' (length=19)
      'updated_at' => string '2012-03-29 13:39:29' (length=19)
      'city' => string 'Las Vegas' (length=9)
      'country_id' => string 'US' (length=2)
      'firstname' => string 'johny' (length=5)
      'lastname' => string 'doe' (length=3)
      'postcode' => string '89032' (length=5)
      'region' => string 'Nevada' (length=6)
      'region_id' => string '39' (length=2)
      'street' => string '3406 Hiney Road' (length=15)
      'telephone' => string '702-283-9556' (length=12)
      'is_default_billing' => boolean false
      'is_default_shipping' => boolean true

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');
$addresses = $client->call($session, 'customer_address.list', 2);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$addresses = $proxy->customerAddressList($sessionId, 2);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerAddressList((object) [
    'sessionId'  => $sessionId->result,
    'customerId' => 2,
]);

Documentação oficial

SOAP


                                    customer_address.create

Session_token

Create a new address for the customer

Create a new address for the specified customer and return its numeric ID. street deve ser um array mesmo com uma única linha. Campos opcionais podem ser omitidos ou enviados como string vazia.

SOAP V2 method: customerAddressCreate.

Returns

Type	Name	Description
`int`	`result`	ID of the created address

Entity: `customerAddressEntityCreate`

Type	Name	Description
`string`	`city`	City
`string`	`company`	Company (optional)
`string`	`country_id`	ISO country ID
`string`	`fax`	Fax (optional)
`string`	`firstname`	First name
`string`	`lastname`	Last name
`string`	`middlename`	Middle name (optional)
`string`	`postcode`	Postcode
`string`	`prefix`	Prefix (optional)
`int`	`region_id`	Region ID
`string`	`region`	Region name (use region_id OR region; region_id tem precedência)
`ArrayOfString`	`street`	Lista de linhas de endereço (street1, street2, …)
`string`	`suffix`	Suffix (optional)
`string`	`telephone`	Telephone
`boolean`	`is_default_billing`	Marca como endereço default de billing
`boolean`	`is_default_shipping`	Marca como endereço default de shipping

Note: If you want to leave any address fields empty, specify them as empty strings in the request body.

Applies resource faults — customer_address (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer_address podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid address data. Details in error message.
`101`	Customer not exists.
`102`	Address not exists.
`103`	Address not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
customerId	int	Sim	Customer ID (dono do novo endereço)
addressdata	customerAddressEntityCreate	Sim	Dados do endereço (ver schema abaixo)

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$newAddressId = $client->call($session, 'customer_address.create', [
    2,
    [
        'firstname'           => 'John',
        'lastname'            => 'Doe',
        'street'              => ['Street line 1', 'Street line 2'],
        'city'                => 'Weaverville',
        'country_id'          => 'US',
        'region'              => 'Texas',
        'region_id'           => 3,
        'postcode'            => '96093',
        'telephone'           => '530-623-2513',
        'is_default_billing'  => false,
        'is_default_shipping' => false,
    ],
]);

$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$newAddressId = $client->customerAddressCreate($session, 2, [
    'firstname'           => 'John',
    'lastname'            => 'Doe',
    'street'              => ['Street line 1', 'Street line 2'],
    'city'                => 'Weaverville',
    'country_id'          => 'US',
    'region'              => 'Texas',
    'region_id'           => 3,
    'postcode'            => '96093',
    'telephone'           => '530-623-2513',
    'is_default_billing'  => false,
    'is_default_shipping' => false,
]);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);

$result = $proxy->customerAddressCreate((object) [
    'sessionId'   => $sessionId->result,
    'customerId'  => 2,
    'addressData' => (object) [
        'city'       => 'Weaverville',
        'country_id' => 'US',
        'postcode'   => '96093',
        'region'     => 'Texas',
        'street'     => ['Street line 1', 'Street line 2'],
        'telephone'  => '847-431-7700',
        'lastname'   => 'Doe',
        'firstname'  => 'John',
        'is_default_billing' => true,
    ],
]);
var_dump($result->result);

<!--
  Envelope SOAP cru — customer_address.create (V1).
  Sintético, derivado do WSDL em http://magentohost/api/?wsdl.
-->
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:ns1="urn:Magento">
  <SOAP-ENV:Body>
    <ns1:call>
      <sessionId xsi:type="xsd:string">SESSION_ID_FROM_LOGIN</sessionId>
      <resourcePath xsi:type="xsd:string">customer_address.create</resourcePath>
      <args SOAP-ENC:arrayType="xsd:anyType[2]" xsi:type="SOAP-ENC:Array">
        <item xsi:type="xsd:int">2</item>
        <item xsi:type="SOAP-ENC:Struct">
          <firstname xsi:type="xsd:string">John</firstname>
          <lastname xsi:type="xsd:string">Doe</lastname>
          <street SOAP-ENC:arrayType="xsd:string[2]" xsi:type="SOAP-ENC:Array">
            <item xsi:type="xsd:string">Street line 1</item>
            <item xsi:type="xsd:string">Street line 2</item>
          </street>
          <city xsi:type="xsd:string">Weaverville</city>
          <country_id xsi:type="xsd:string">US</country_id>
          <region xsi:type="xsd:string">Texas</region>
          <region_id xsi:type="xsd:int">3</region_id>
          <postcode xsi:type="xsd:string">96093</postcode>
          <telephone xsi:type="xsd:string">530-623-2513</telephone>
          <is_default_billing xsi:type="xsd:boolean">false</is_default_billing>
          <is_default_shipping xsi:type="xsd:boolean">false</is_default_shipping>
        </item>
      </args>
    </ns1:call>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<!-- Resposta típica (HTTP 200): -->
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:ns1="urn:Magento">
  <SOAP-ENV:Body>
    <ns1:callResponse>
      <callReturn xsi:type="xsd:int">17</callReturn>
    </ns1:callResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Documentação oficial

SOAP


                                    customer_address.info

Session_token

Retrieve information about the required customer address

Retrieve information about the required customer address by its ID. Retorna o schema completo (customerAddressEntityItem) incluindo os campos vat_* (VAT validation) quando o módulo VAT está habilitado no admin.

SOAP V2 method: customerAddressInfo.

Returns

Type	Name	Description
`array`	`info`	Array de customerAddressEntityItem (ver schema abaixo)

Entity: `customerAddressEntityItem` (alias de `customerAddressEntity`)

Type	Name	Description
`int`	`customer_address_id`	ID of the customer address
`string`	`created_at`	Date when the address was created
`string`	`updated_at`	Date when the address was updated
`string`	`increment_id`	Increment ID
`string`	`city`	City
`string`	`company`	Name of the company
`string`	`country_id`	ISO country ID (ex.: US, BR)
`string`	`fax`	Fax
`string`	`firstname`	Customer first name
`string`	`lastname`	Customer last name
`string`	`middlename`	Customer middle name
`string`	`postcode`	Postcode
`string`	`prefix`	Customer prefix
`string`	`region`	Region name
`int`	`region_id`	Region ID (lookup via directory_region.list)
`string`	`street`	Street line(s)
`string`	`suffix`	Customer suffix
`string`	`telephone`	Telephone number
`boolean`	`is_default_billing`	True if this is the default billing address
`boolean`	`is_default_shipping`	True if this is the default shipping address

Applies resource faults — customer_address (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer_address podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid address data. Details in error message.
`101`	Customer not exists.
`102`	Address not exists.
`103`	Address not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
addressId	int	Sim	Address ID

Exemplo de Resposta

array
  'customer_address_id' => string '2' (length=1)
  'created_at' => string '2012-03-29 13:20:08' (length=19)
  'updated_at' => string '2012-03-29 13:20:08' (length=19)
  'increment_id' => null
  'city' => string 'Las Vegas' (length=9)
  'company' => null
  'country_id' => string 'US' (length=2)
  'fax' => null
  'firstname' => string 'johny' (length=5)
  'lastname' => string 'doe' (length=3)
  'middlename' => null
  'postcode' => string '89032' (length=5)
  'prefix' => null
  'region' => string 'Nevada' (length=6)
  'region_id' => string '39' (length=2)
  'street' => string '3406 Hiney Road' (length=15)
  'suffix' => null
  'telephone' => string '702-283-9556' (length=12)
  'vat_id' => null
  'vat_is_valid' => null
  'vat_request_date' => null
  'vat_request_id' => null
  'vat_request_success' => null
  'is_default_billing' => boolean false
  'is_default_shipping' => boolean true

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');
$address = $client->call($session, 'customer_address.info', 2);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$address = $proxy->customerAddressInfo($sessionId, 2);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerAddressInfo((object) [
    'sessionId' => $sessionId->result,
    'addressId' => 2,
]);

Documentação oficial

SOAP


                                    customer_address.update

Session_token

Update address data of the required customer

Update address data of the required customer. Campos omitidos permanecem inalterados. Para trocar qual endereço é o default de billing/shipping, passe is_default_billing/is_default_shipping explicitamente.

SOAP V2 method: customerAddressUpdate.

Returns

Type	Description
`boolean`	True if the address was updated

Entity: `customerAddressEntityCreate`

Type	Name	Description
`string`	`city`	City
`string`	`company`	Company (optional)
`string`	`country_id`	ISO country ID
`string`	`fax`	Fax (optional)
`string`	`firstname`	First name
`string`	`lastname`	Last name
`string`	`middlename`	Middle name (optional)
`string`	`postcode`	Postcode
`string`	`prefix`	Prefix (optional)
`int`	`region_id`	Region ID
`string`	`region`	Region name (use region_id OR region; region_id tem precedência)
`ArrayOfString`	`street`	Lista de linhas de endereço (street1, street2, …)
`string`	`suffix`	Suffix (optional)
`string`	`telephone`	Telephone
`boolean`	`is_default_billing`	Marca como endereço default de billing
`boolean`	`is_default_shipping`	Marca como endereço default de shipping

Applies resource faults — customer_address (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer_address podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid address data. Details in error message.
`101`	Customer not exists.
`102`	Address not exists.
`103`	Address not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
addressId	int	Sim	ID do endereço a atualizar
addressdata	customerAddressEntityCreate	Sim	Campos a atualizar

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');

$ok = $client->call($session, 'customer_address.update', [
    8,
    ['firstname' => 'John', 'is_default_billing' => true],
]);

$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');
$ok = $client->customerAddressUpdate($session, 8, [
    'firstname' => 'John',
    'lastname'  => 'Doe',
]);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerAddressUpdate((object) [
    'sessionId'   => $sessionId->result,
    'addressId'   => 8,
    'addressData' => (object) ['firstname' => 'John', 'lastname' => 'Doe'],
]);

Documentação oficial

SOAP


                                    customer_address.delete

Session_token

Delete the required customer address

Delete the required customer address by its ID. Não toca nos demais endereços do customer.

SOAP V2 method: customerAddressDelete.

Returns

Type	Description
`boolean`	True if the address was deleted

Applies resource faults — customer_address (4 faults: 100–103) Ver no overview ↗

Todos os métodos do resource customer_address podem lançar os faults abaixo além dos Global API Faults.

Code	Message
`100`	Invalid address data. Details in error message.
`101`	Customer not exists.
`102`	Address not exists.
`103`	Address not deleted. Details in error message.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
sessionId	string	Sim	Session ID
addressId	int	Sim	Address ID

Exemplos de Código

$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client->login('apiUser', 'apiKey');
$ok = $client->call($session, 'customer_address.delete', 4);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$ok = $proxy->customerAddressDelete($sessionId, 4);

$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login((object) ['username' => 'apiUser', 'apiKey' => 'apiKey']);
$result = $proxy->customerAddressDelete((object) [
    'sessionId' => $sessionId->result,
    'addressId' => 4,
]);

Documentação oficial

Mage_Customer

Module: Mage_Customer

Resource: customer

Faults — customer

Resource: customer_group

Resource: customer_address

Faults — customer_address

v1 × v2 — detalhes práticos para customer.create

Exemplos oficiais de CRUD (SOAP V1)

1 · View, create, update, and delete a customer

2 · Working with customer address

Returns

Entity: customerCustomerEntity

Parâmetros

Exemplo de Resposta

Exemplos de Código

Returns

Entity: customerCustomerEntityToCreate

Parâmetros

Exemplos de Código

Returns

Entity: customerCustomerEntity

Parâmetros

Exemplo de Resposta

Exemplos de Código

Returns

Entity: customerCustomerEntityToCreate

Parâmetros

Exemplos de Código

Returns

Parâmetros

Exemplos de Código

Returns

Entity: customerGroupEntity

Parâmetros

Exemplo de Resposta

Exemplos de Código

Returns

Entity: customerAddressEntity (alias de customerAddressEntityItem)

Parâmetros

Exemplo de Resposta

Exemplos de Código

Returns

Entity: customerAddressEntityCreate

Parâmetros

Exemplos de Código

Returns

Entity: customerAddressEntityItem (alias de customerAddressEntity)

Parâmetros

Exemplo de Resposta

Exemplos de Código

Returns

Entity: customerAddressEntityCreate

Parâmetros

Exemplos de Código

Returns

Parâmetros

Exemplos de Código

Resource: `customer`

Faults — `customer`

Resource: `customer_group`

Resource: `customer_address`

Faults — `customer_address`

v1 × v2 — detalhes práticos para `customer.create`

Entity: `customerCustomerEntity`

Entity: `customerCustomerEntityToCreate`

Entity: `customerCustomerEntity`

Entity: `customerCustomerEntityToCreate`

Entity: `customerGroupEntity`

Entity: `customerAddressEntity` (alias de `customerAddressEntityItem`)

Entity: `customerAddressEntityCreate`

Entity: `customerAddressEntityItem` (alias de `customerAddressEntity`)

Entity: `customerAddressEntityCreate`