Pular para o conteúdo
Documentação API Reference FAQ Changelog Status

Customers

magento-2

Customers, customer addresses, customer groups, password reset, accounts.

POST /rest/V1/customers

Create a customer account (storefront)

Create a customer account (storefront).

Anônimo — usado por registros no storefront.

GET /rest/V1/customers/search Bearer

Search customers (admin)

Search customers (admin).

Admin only. Use searchCriteria.

GET /rest/V1/customers/me Bearer

Get authenticated customer data

Get authenticated customer data.

Use customer token.

PUT /rest/V1/customers/me Bearer

Update authenticated customer

Update authenticated customer.

PUT /rest/V1/customers/me/password Bearer

Change password (self)

Change password (self).

Requer currentPassword + newPassword.

GET /rest/V1/customers/:customerId Bearer

Get customer by ID (admin)

Get customer by ID (admin).

Admin only.

PUT /rest/V1/customers/:customerId Bearer

Update customer (admin)

Update customer (admin).

DELETE /rest/V1/customers/:customerId Bearer

Delete customer (admin)

Delete customer (admin).

PUT /rest/V1/customers/password

Request password reset token (email)

Request password reset token (email).

Envia e-mail com link de reset.

POST /rest/V1/customers/resetPassword

Reset password with token

Reset password with token.

PUT /rest/V1/customers/confirm Bearer

Confirm customer account

Confirm customer account.

GET /rest/V1/customers/:customerId/confirm Bearer

Check account confirmation status

Check account confirmation status.

PUT /rest/V1/customers/:customerId/activate Bearer

Activate account

Activate account.

PUT /rest/V1/customers/me/activate Bearer

Activate own account

Activate own account.

GET /rest/V1/customers/validate Bearer

Validate customer data without saving

Validate customer data without saving.

POST /rest/V1/customers/isEmailAvailable

Check if email is available

Check if email is available.

GET /rest/V1/customers/:customerId/billingAddress Bearer

Get default billing address

Get default billing address.

GET /rest/V1/customers/:customerId/shippingAddress Bearer

Get default shipping address

Get default shipping address.

GET /rest/V1/customerGroups/search Bearer

List customer groups

List customer groups.

POST /rest/V1/customerGroups Bearer

Create customer group

Create customer group.

GET /rest/V1/customerGroups/:groupId Bearer

Get customer group

Get customer group.

PUT /rest/V1/customerGroups/:groupId Bearer

Update customer group

Update customer group.

DELETE /rest/V1/customerGroups/:groupId Bearer

Delete customer group

Delete customer group.

GET /rest/V1/customerGroups/default Bearer

Get default group

Get default group.

GET /rest/V1/customerGroups/default/:storeId Bearer

Get default group for store

Get default group for store.

DELETE /rest/V1/addresses/:addressId Bearer

Delete customer address

Delete customer address.