How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BigCommerce Customers API

The Customers API from BigCommerce — 1 operation(s) for customers.

BigCommerce Customers API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 1 path, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.

4 operations 1 paths 16 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

BigCommerce Customers API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

  • X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 4
GET
/customers
BigCommerce Get All Customers
getCustomers 17 params → 200
POST
/customers
BigCommerce Create Customers
createCustomers body → 200413422
PUT
/customers
BigCommerce Update Customers
updateCustomers body → 200413422
DELETE
/customers
BigCommerce Delete Customers
deleteCustomers 1 param → 204

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are customer_Full (22 properties), customer_Put (16 properties), customer_Post (16 properties), address_Full (15 properties). Each schema is shown below with its type and property counts.

_metaCollection
object
Data about the response, including pagination and collection totals.
1 property
customerAttributes_Base
object
2 properties
CustomerStoredCreditAmounts
array
Store credit.
customer_Post
object
16 properties 3 required
customerChannelIds
array
Array of channel ids the Customer has access to.
formFieldValue
object
2 properties 2 required
customer_Put
object
16 properties 1 required
customerAddresses_CustomerPost
object
The address object for the customer objectʼs addresses array.
12 properties 5 required
customerAuthentication_PostPut
object
customer_Full
object
22 properties
address_Full
object
15 properties 9 required
attribute_Full
object
6 properties
Pagination
object
Data about the response, including pagination and collection totals.
6 properties
ErrorResponse
object
5 properties
Links
object
Pagination links for the previous and next parts of the whole collection.
3 properties
formFieldValue_Customer
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-customers-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
Big Commerce Locations
Big Commerce Customer Segmentation
Big Commerce Promotions
Big Commerce Promotion Settings
Big Commerce Pickup Methods
Big Commerce Storefront Pickup Options
Big Commerce Transactions
BigCommerce Abandoned Cart Emails API
BigCommerce Abandoned Cart Settings API
BigCommerce Abandoned Carts API
BigCommerce Abandoned Carts Settings API
Where this information came from

This is an independent, third-party profile of BigCommerce Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.