Customers V2

  • Host: api.bigcommerce.com/stores/store_hash/v2
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json

Create and Manage Customers, Customer Addresses, and Customer Groups. Additionally, validate customer passwords. To learn more about Customers see here.

Authentication

Requests can be authenticated by sending an access_token via X-Auth-Token HTTP header:

GET /stores/store_hash/v3/catalog/summary
host: api.bigcommerce.com
Accept: application/json
X-Auth-Token: {access_token}
Header Parameter Description
X-Auth-Token access_token Obtained by creating an API account or installing an app in a BigCommerce control panel.

OAuth Scopes

UI Name Permission Parameter
Customers modify store_v2_customers
Customers read-only store_v2_customers_read_only

For more information on Authenticating BigCommerce APIs, see: Authentication.

Available Endpoints

Resource / Endpoint Description
Customers Identity and account details for customers shopping on BigCommerce stores
Customers Addresses Postal address belonging to a customer.
Customers Groups Groupings of customers who share the same level of access and discounts
Customers Validate Password Validate customer passwords

Usage Notes

Customer Groups

  • Customer Groups are only available on specific plans.

Customers vs. Subscribers

  • A subscriber is not always a customer. Someone can sign up for the newsletter only and not create an account.
  • A customer is not always a subscriber. Signing up for the newsletter is a separate action from creating an account and purchasing an item.
  • A customer and a subscriber can be the same. If a shopper checks out on the storefront, creates an account and opts into the newsletter, they are a customer and a subscriber.

Resources

Related APIs / Endpoints

Customer Login API

Webhooks