BOboldcommerce
Customers

List Customers

Lists the customers that have placed orders on the store.

All query parameters must be URL-encoded. For more information about searching, refer to Query & Pagination.

get/v2/shops/{shop_identifier}/customers

Request

Path parameters

shop_identifierstring required

A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint.

Query parameters

since_idinteger

Specifies results that fall after the given ID.

updated_at_minstring date-time

The earliest date (in RFC3339 format) that the customer was updated.

updated_at_maxstring date-time

The latest date (in RFC3339 format) that the customer was updated.

searchstring

A search term used to perform a fuzzy search across the customer's first_name, last_name, email, and phone.

idsstring

A comma-separated list of customer IDs.

orderbystring

The method of ordering the returned results. Must be paired with the orderdirection query parameter.

orderdirectionstring

The direction of ordering returned results. Must be paired with the orderby query parameter. Possible values include asc and desc.

filterstring[]

The filtering mechanism to apply to the query. For more information, refer to Query & Pagination.

[
  "eq(id:11)"
]
labelstring

The label assigned to the customer.

limitinteger

The number of results per page.

pageinteger

The page of results to return.

Response

A successful response.

Example response

{
  "pagination": {
    "total": 143,
    "count": 143,
    "per_page": 50,
    "current_page": 2,
    "total_pages": 3,
    "next_url": "https://api.boldcommerce.com/customers/v2/shops/zp3oafdor9/customers?page=3",
    "previous_url": "https://api.boldcommerce.com/customers/v2/shops/zp3oafdor9/customers?page=1"
  },
  "customers": [
    {
      "tags": "member, 2021",
      "shop_identifier": "zp3oafdor9",
      "platform_created_at": "2021-11-04T19:09:52Z",
      "id": 142329453,
      "platform_type": "bigcommerce",
      "last_name": "Doe",
      "first_name": "John",
      "labels": [
        {
          "id": 1,
          "customer_id": 82435920147,
          "name": "loyal_cust",
          "created_at": "2021-11-04T19:09:55Z",
          "updated_at": "2021-11-04T19:09:55Z"
        }
      ],
      "groups": [
        {
          "id": 1,
          "name": "active_sub",
          "description": "The customer is a subscriber to a product on this store via Bold Subscriptions",
          "shop_identifier": "zp3oafdor9",
          "platform_id": "group_1_plat",
          "created_at": "2021-08-01T20:11:31Z"
        }
      ],
      "updated_at": "2021-11-04T19:09:52Z",
      "phone": "2041438851",
      "platform_id": "1",
      "addresses": [
        {
          "city": "Winnipeg",
          "province": "Manitoba",
          "province_code": "MB",
          "country": "Canada",
          "created_at": "2021-11-04T19:09:52Z",
          "zip": "R3L0L6",
          "address_type": "residential",
          "platform_customer_id": "1",
          "address_use": "shipping",
          "company": "Acme Inc.",
          "street_2": "Suite 200",
          "platform_id": "address1234",
          "shop_identifier": "zp3oafdor9",
          "platform_type": "bigcommerce",
          "first_name": "John",
          "address_source": "platform",
          "last_name": "Doe",
          "updated_at": "2021-11-04T19:09:52Z",
          "phone": "2041438851",
          "is_default": true,
          "bold_customer_id": 1423294,
          "country_iso2": "CA",
          "street_1": "50 Fultz Blvd",
          "id": 90235719
        }
      ],
      "created_at": "2021-11-04T19:09:52Z",
      "email": "john.doe@example.com",
      "default_address": {
        "city": "Winnipeg",
        "province": "Manitoba",
        "province_code": "MB",
        "country": "Canada",
        "created_at": "2021-11-04T19:09:52Z",
        "zip": "R3L0L6",
        "address_type": "residential",
        "platform_customer_id": "1",
        "address_use": "shipping",
        "company": "Acme Inc.",
        "street_2": "Suite 200",
        "platform_id": "address1234",
        "shop_identifier": "zp3oafdor9",
        "platform_type": "bigcommerce",
        "first_name": "John",
        "address_source": "platform",
        "last_name": "Doe",
        "updated_at": "2021-11-04T19:09:52Z",
        "phone": "2041438851",
        "is_default": true,
        "bold_customer_id": 1423294,
        "country_iso2": "CA",
        "street_1": "50 Fultz Blvd",
        "id": 90235719
      }
    }
  ]
}

Changes

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