ecommerce

Add customer

Add a new customer to a store.

post/3.0/ecommerce/stores/{store_id}/customers

Request

Path parameters

store_idstring required

The store id.

Request body

companystring

The customer's company.

email_addressstring

The customer's email address.

first_namestring

The customer's first name.

idstring required

A unique identifier for the customer. Limited to 50 characters.

last_namestring

The customer's last name.

opt_in_statusboolean required

The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.

sms_phone_numberstring

A US phone number for SMS contact.

Example request

{
  "address": {
    "address1": "675 Ponce de Leon Ave NE",
    "address2": "Suite 5000",
    "city": "Atlanta",
    "country": "United States",
    "country_code": "US",
    "postal_code": "30308",
    "province": "Georgia",
    "province_code": "GA"
  }
}

Response

companystring

The customer's company.

created_atstring date-time

The date and time the customer was created in ISO 8601 format.

email_addressstring

The customer's email address.

first_namestring

The customer's first name.

idstring

A unique identifier for the customer.

last_namestring

The customer's last name.

opt_in_statusboolean

The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.

orders_countinteger

The customer's total order count.

sms_phone_numberstring

A US phone number for SMS contact.

updated_atstring date-time

The date and time the customer was last updated in ISO 8601 format.

Example response

{
  "address": {
    "address1": "675 Ponce de Leon Ave NE",
    "address2": "Suite 5000",
    "city": "Atlanta",
    "country": "United States",
    "country_code": "US",
    "postal_code": "30308",
    "province": "Georgia",
    "province_code": "GA"
  },
  "created_at": "2015-07-15T19:28:00+00:00",
  "orders_count": 4,
  "updated_at": "2015-07-15T19:28:00+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.