Bigcommerce Orders V3
Browse all Bigcommerce APIs67
AI ReadinessAI-Aware (B)67/100
Official vendor OpenAPI document · agent-readyE CommerceOrder ManagementapiKey21 EndpointsREST
For Agents
Capture and void order payments, read order transactions, create refund quotes and refunds, manage global and channel order settings, and store order metafields.
Use for: Capture the authorized payment on a paid order, Void a payment on a cancelled order, Get the transactions for an order, Create a refund quote for a returned item
Not supported: Does not create orders, manage products, or edit customer records. Use for order payment actions, refunds, transactions, and order settings only.
The BigCommerce Orders API handles the money and settings side of an order: it captures and voids authorized payments, reads an order's transactions, and creates refund quotes and refunds against a paid order. It also manages global and per-channel order settings and stores order metafields of structured data. It is the post-purchase payment and configuration surface for orders already placed in a store.
Install Jentic One Beta
Connect the Orders V3 to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Orders 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.
1
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-orders-api" | sh2
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-orders-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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 Orders V3 API.
Capture an authorized payment on an order
Void an authorized order payment before capture
Read the transactions recorded against an order
Create a refund quote and issue a refund on an order
Set global and per-channel order settings
Store metafields of structured data on an order
Use Cases
Patterns agents use Orders V3 API for, with concrete tasks.
★ Agent-driven payment capture and refunds
An AI agent manages the money on orders as they move through fulfillment: it captures the authorized payment when an order ships, voids it when an order is cancelled before capture, and issues refunds against returns. Because the API exposes refund quotes before the refund itself, the agent can confirm the exact amount and tax split before committing the refund.
Create a refund quote for an order, then issue the refund for the quoted amount and confirm the transaction
Returns and refund reconciliation
Support teams need refunds that match the original transaction exactly. The Orders API reads an order's transactions and generates a refund quote before the refund, so an agent can reconcile what was charged against what is being returned and issue a precise partial or full refund without overpaying.
Read an order's transactions, create a refund quote for one line item, and issue the partial refund
Order settings and metadata automation
Multi-channel stores need order behavior configured per channel and extra data attached to orders. The API manages global and per-channel order settings and stores order metafields, so an agent can apply a channel's settings and tag orders with structured attributes that downstream systems read.
Update the order settings for a sales channel and attach a fulfillment-priority metafield to an order
Key Endpoints
21 endpoints — the bigcommerce orders api handles the money and settings side of an order: it captures and voids authorized payments, reads an order's transactions, and creates refund quotes and refunds against a paid order.
METHOD
PATH
DESCRIPTION
POST
/orders/{order_id}/payment_actions/capture
Capture an order payment
POST
/orders/{order_id}/payment_actions/void
Void an order payment
GET
/orders/{order_id}/transactions
Get an order's transactions
POST
/orders/{order_id}/payment_actions/refund_quotes
Create a refund quote
POST
/orders/{order_id}/payment_actions/refunds
Create a refund
GET
/orders/{order_id}/payment_actions/refunds
Get refunds for an order
GET
/orders/settings
Get global order settings
POST
/orders/{order_id}/metafields
Create order metafields
POST
/orders/{order_id}/payment_actions/capture
Capture an order payment
POST
/orders/{order_id}/payment_actions/void
Void an order payment
GET
/orders/{order_id}/transactions
Get an order's transactions
POST
/orders/{order_id}/payment_actions/refund_quotes
Create a refund quote
POST
/orders/{order_id}/payment_actions/refunds
Create a refund
GET
/orders/{order_id}/payment_actions/refunds
Get refunds for an order
GET
/orders/settings
Get global order settings
POST
/orders/{order_id}/metafields
Create order metafields
Jentic AI Readiness Score
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.
O
Orders V3
- AI-Aware (B)67/100
68
Foundational Compliance67
Developer Experience & Jentic Compatibility60
AI-Readiness & Agent Experience94
Agent Usability50
Security69
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
68
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: B+Signals: 4
96%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
67
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
18%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
49%
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.
60
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: B-Signals: 4
64%
Description Coverage
Coverage of descriptions across API elements.
19%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
58%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
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.
50
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).
69
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
69%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the BigCommerce Orders API by hand means creating a store API account, scoping its X-Auth-Token to transaction 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 order id travels in the URL path (/orders/{order_id}/...), so a rule can pin your agent to one order, or allow a chosen set of operations. You choose the operations it may call, so payment capture and refunds are not included unless you add them.
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 'capture an order payment' or 'issue a refund', and Jentic returns the matching Orders operation with its input schema so the agent calls the right endpoint without reading the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Orders V3 API through Jentic.
What authentication does the BigCommerce Orders API use?
The BigCommerce Orders API authenticates with a store API account token sent in the X-Auth-Token header, as declared in its OpenAPI spec, scoped by the transaction and order 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 issue a partial refund with this API?
Yes. The Orders API creates a refund quote that breaks down the refundable amount, then issues a refund against the order for the quoted figure, so an agent can refund a single line item rather than the whole order.
What are the rate limits for the BigCommerce Orders 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 processing captures or refunds in bulk.
Is there a BigCommerce Orders MCP server?
You do not need an MCP server to give your agent the BigCommerce Orders API. Jentic connects it directly from the API Directory: import it, store your store token once, and your agent captures payments and issues refunds on demand.
Can I limit what my agent is allowed to do with the BigCommerce Orders API?
Yes. The order id travels in the URL path, so a rule can pin the agent to one order, or you can allow only the read operations so the agent can inspect transactions and refunds but cannot capture payments or issue refunds, with every call logged.
How do I issue a refund with this API through Jentic?
Search Jentic for an intent like 'refund a BigCommerce order' 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.
GET STARTED