Dev Center
Dev Center
API Docs
API Reference
Theme Docs
Tools
Library
Blog
Changelog
My Apps
Create Account
No results found.
Headless Commerce
Payments
Store Management
Customers
Customer Addresses
Customer Attributes
Customer Attribute Values
Customer Form Field Values
Customer Consent
Providers
Webhooks
Catalog
Customers & Subscribers
Marketing
Storefront
Customer Login SSO
Orders

Customers V3

  • Version: 3.0
  • Host: api.bigcommerce.com/stores/store_hash/v3
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json
More Info

OAuth Scopes

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

For more information on OAuth Scopes, see: Authentication.

Authentication

Requests can be authenticated by sending a client_id and access_token via X-Auth-Client and X-Auth-Token HTTP headers:

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

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

Available Endpoints

Resource / Endpoint Description
Customers Create an manage customers
Customers Addresses Create an manage customers Addresses
Customers Attribute Values Create and manage customer attribute values
Customers Attributes Create and manage customer attributes
Customers Form Field Values Create an manage customer form field values

Resources