Install Jentic One Beta

Connect the Customers V3 to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Customers V3, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbigcommerce.com%2Fbigcommerce-customers-api" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbigcommerce.com%2Fbigcommerce-customers-api" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Customers V3 API.

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

GET STARTED

Start building with Customers V3 API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Customers V3 API for, with concrete tasks.

★ 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.

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.

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.

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

Key Endpoints

34 endpoints — 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.

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

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

Why Jentic?

What agents get from Jentic-routed access to this vendor.

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 isolation

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.

Intent-based discovery

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.

FAQs

Specific to using Customers V3 API through Jentic.

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.

Bigcommerce Customers V3

Browse all Bigcommerce APIs

AI ReadinessAI-Aware (B)66/100

See full scorecard

Official vendor OpenAPI document · agent-readyCRMContact ManagementapiKey34 EndpointsREST

For Agents

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

Use for: Create a new customer record for a shopper, Update a customer's email and name, Add a shipping address to a customer, Set a loyalty-tier attribute value on a customer

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

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.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: C+Signals: 4

95%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

42%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: BSignals: 4

23%

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

41%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: B-Signals: 4

56%

Description Coverage

Coverage of descriptions across API elements.

50%

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

43%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: C-Signals: 1

50%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: A-Signals: 1

71%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the Customers V3 to your agent

Capabilities

Start building with Customers V3 API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Bigcommerce Customers V3

Jentic AI Readiness Score

Customers V3

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness