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 Order API

The Order API from BigCommerce — 1 operation(s) for order.

BigCommerce Order 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 Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 1 operation 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.

1 operations 1 paths 16 schemas 1 GET

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 Order 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Order 1
GET
/orders/{orderId}
BigCommerce Get Order
getOrder 2 params → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ShippingConsignment (30 properties), Order (26 properties), ItemPhysical (23 properties), OrderItemDigital (23 properties). Each schema is shown below with its type and property counts.

ConsignmentFormField
object
2 properties
Consignments
object
All the consignments of the order.
1 property
Status
string
Order status.
Currency
object
This will always be the same between cart and checkout.
4 properties
ItemPhysical
object
23 properties 1 required
ShippingConsignment
object
Shipping consignment
30 properties
OrderItemDigital
object
23 properties 1 required
AppliedCoupon
object
5 properties 1 required
GiftWrapping
object
3 properties
OrderLineItem
object
3 properties 3 required
Order
object
26 properties
OrderItemGiftCertificate
object
5 properties
ConsignmentLineItem
object
1 property
AppliedDiscount
object
1 property
CustomField
object
2 properties
AddressProperties
object
14 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-order-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 Order 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.