MAmailchimp
ecommerce

List customers

Get information about a store's customers.

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

Request

Path parameters

store_idstring required

The store id.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

email_addressstring

Restrict the response to customers with the email address.

Response

store_idstring

The store id.

total_itemsinteger

The total number of items matching the query regardless of pagination.

Example response

{
  "customers": [
    {
      "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.