canonical: https://jentic.com/apis/bigcommerce.com/bigcommerce-customers-api

# Bigcommerce Customers V3

The BigCommerce Customers API holds the shopper records behind a store: it creates, updates, and deletes customers in batch, manages their addresses, and defines customer attributes with per-customer values for segmentation. It records each customer's consent state, validates login credentials, and stores metafields of structured data, and it exposes per-channel customer settings and stored payment instruments. It is the customer source of truth that a storefront reads for sign-in and personalization.

## For AI agents

Create, update, and delete BigCommerce customers in batch, manage addresses and attributes, record consent, validate credentials, and store customer metafields.

## Scope

Does not handle products, orders, or payment capture. Use for managing BigCommerce customer records, addresses, attributes, and consent only.

## Capabilities

- Create, update, and delete customer records in batch
- Manage the addresses attached to a customer
- Define customer attributes and set attribute values for segmentation
- Record and read a customer's consent state
- Validate a customer's login credentials
- Store metafields of structured data on a customer

## Use cases

### Agent-managed customer records

An AI agent keeps BigCommerce customers in sync with an external system of record, creating new shoppers, updating contact details, and attaching addresses as they change. Because customers can be created and updated in batch, the agent can reconcile a large list in one pass rather than editing each profile by hand.

Example prompt: Create a customer with name and email, add a shipping address, and set a loyalty-tier attribute value

### Segmentation with customer attributes

Marketing needs shoppers grouped by traits the core profile does not capture. The Customers API defines custom attributes and stores a value per customer, so an agent can tag shoppers by tier, source, or preference and later read those values to build a segment for a campaign.

Example prompt: Create a customer attribute for acquisition source and set its value on a batch of customers

### Consent and credential checks

Storefront sign-in and privacy compliance need consent and credential handling the agent can drive. The API records and returns a customer's consent state and validates login credentials, so an agent can confirm marketing opt-in before sending or verify a shopper's password during a support flow.

Example prompt: Validate a customer's credentials, then read the customer's consent state before any marketing send

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/customers` | List customers |
| POST | `/customers` | Create customers in batch |
| PUT | `/customers` | Update customers in batch |
| DELETE | `/customers` | Delete customers |
| GET | `/customers/addresses` | List customer addresses |
| POST | `/customers/validate-credentials` | Validate a customer's credentials |
| GET | `/customers/{customerId}/consent` | Get a customer's consent state |
| POST | `/customers/{customerId}/metafields` | Create customer metafields |

## Key resources

- **Customers** — Create, update, delete, and list customer records in batch
- **Addresses** — Addresses attached to customer records
- **Attributes** — Customer attributes and per-customer attribute values for segmentation
- **Consent and credentials** — Record consent state and validate customer login credentials
- **Metafields** — Structured extra data stored against customers

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 59 / 100
  - Developer Experience & Jentic Compatibility: 66 / 100
  - AI-Readiness & Agent Experience: 62 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 71 / 100
- **View full report:** https://jentic.com/apis/bigcommerce.com/bigcommerce-customers-api/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the BigCommerce Customers API by hand means creating a store API account, scoping its X-Auth-Token to customer permissions, and substituting your store hash into every request path. Through Jentic you install once, import it from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The customer id travels in the URL path for per-customer operations, so a rule can pin your agent to one customer, or allow a chosen set of operations. You choose the operations it may call, so batch deletion is not included unless you add it.
- **Credential handling:** Your BigCommerce store token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a customer' or 'set a customer attribute', and Jentic returns the matching Customers operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **Zoho CRM** — Zoho CRM manages contacts and leads as a standalone CRM rather than a store's shopper records.
- **HubSpot CRM** — HubSpot models contacts and custom objects for marketing and sales rather than storefront customers.
- **Salesloft** — Salesloft runs sales engagement against the people a store's customer records describe.

## FAQ

### What authentication does the BigCommerce Customers API use?

The BigCommerce Customers API authenticates with a store API account token sent in the X-Auth-Token header, as declared in its OpenAPI spec, scoped by the OAuth permissions granted to that token. Through Jentic the token is stored encrypted by your own Jentic One instance and injected when a call runs, so it never reaches the agent's prompt or logs.

### Can I segment customers with custom attributes using this API?

Yes. The Customers API defines custom attributes and stores an attribute value per customer, so an agent can tag shoppers by tier or source and later read those values to build a segment.

### What are the rate limits for the BigCommerce Customers API?

The OpenAPI spec does not state rate limits. BigCommerce enforces per-plan API quotas documented on its developer portal at developer.bigcommerce.com, so check there before running large batch customer updates.

### Is there a BigCommerce Customers MCP server?

You do not need an MCP server to give your agent the BigCommerce Customers API. Jentic connects it directly from the API Directory: import it, store your store token once, and your agent creates and updates customers on demand.

### Can I limit what my agent is allowed to do with the BigCommerce Customers API?

Yes. The customer id travels in the URL path for per-customer operations, so a rule can pin the agent to one customer, or you can allow only the read operations so the agent can list customers and read consent but cannot delete records, with every call logged.

### How do I create a customer with this API through Jentic?

Search Jentic for an intent like 'create a BigCommerce customer' and it returns the matching operation with its input schema, then your agent calls it with the store token Jentic injects at runtime. To run it on your own infrastructure, install Jentic One from its GitHub repo.