customer.md

Customer

create

Create a new customer.

customerData is an array of customerCustomerEntityToCreate objects.

magento.customer.create({
  customerData: [ val, val, val ]
}, callback);

// or a single cell of customer data

magento.customer.create({
  customerData: val
}, callback);

delete

Delete the required customer.

magento.customer.delete({
  customerId: val
}, callback);

info

Retrieve information about the specified customer.

magento.customer.info({
  customerId: val,
  attributes: [ val, val, val ]   /* optional */
}, callback);

// or a single attribute

magento.customer.info({
  customerId: val,
  attributes: val   /* optional */
}, callback);

list

Allows you to retrieve the list of customers.

magento.customer.list({
  filters: [ val, val, val ]
}, callback);

// or a single attribute

magento.customer.list({
  filters: val
}, callback);

update

Update information about the required customer.

Note that you need to pass only those arguments which you want to be updated.

customerData is an array of customerCustomerEntityToCreate objects.

magento.customer.update({
  customerId:   val,
  customerData: [ val, val, val ]
}, callback);

// or a single attribute

magento.customer.update({
  customerId:   val,
  customerData: val
}, callback);