Customers
magento-1Endpoints REST para listar, criar, consultar, atualizar e remover clientes.
/api/rest/customers
OAuth 1.0a
List customers (admin only)
Retrieve the list of existing customers. Admin only.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page | integer | Não | Page number |
| limit | integer | Não | Items per page (max 100) |
/api/rest/customers
OAuth 1.0a
Create a new customer (admin only)
Create a new customer. Admin only.
Required: firstname, lastname, email, password (min 7 chars), website_id, group_id.
Optional: prefix, middlename, suffix, taxvat, disable_auto_group_change.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| firstname | string | Sim | |
| lastname | string | Sim | |
| string | Sim | ||
| password | string | Sim | min 7 chars |
| website_id | integer | Sim | |
| group_id | integer | Sim |
/api/rest/customers/:customerId
OAuth 1.0a
Retrieve a customer
Retrieve information of an existing customer. Admin (any) or Customer (own data only).
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| customerId | integer | Sim |
/api/rest/customers/:customerId
OAuth 1.0a
Update a customer
Update an existing customer. Admin or Customer (own data only).
Note: website_id and created_in attributes are not allowed for updating.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| customerId | integer | Sim |
/api/rest/customers/:customerId
OAuth 1.0a
Delete a customer (admin only)
Delete an existing customer. Admin only.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| customerId | integer | Sim |