BigCommerce API Documentation
This is the complete API documentation for connecting to the BigCommerce API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet BigCommerce: Enterprise eCommerce, simplified. Keep reading to get started.
Quickstart
Before you run your first BigCommerce request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one BigCommerce connection — create or choose one in Connections. Note its
connectionId.
Every BigCommerce action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/bigcommerce/latest/actions/{actionSlug}You need a MindCloud API Key and a BigCommerce connection. Then call an action such as Get a Product:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/bigcommerce/latest/actions/get-a-product" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected BigCommerce account that should run the action. MindCloud stores and refreshes the BigCommerce credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
BigCommerce actions
All 56 published actions for this BigCommerce version. Each page documents the endpoint, arguments, and response controls.
- POSTAdd Cart Item
- POSTCreate a Channel
- POSTCreate Customer
- POSTCreate Customer Address
- POSTCreate Product Metafield
- POSTCreate Product Modifier
- POSTCreate Product Variant
- POSTCreate Product Variant Image
- POSTCreate Product Variant Option
- PUTCreate Products Channel Assignments
- POSTCreate Refund
- POSTCreate Refund Quote
- POSTCreate Shipping For Order
- DELETEDelete Cart Item
- DELETEDelete Product Image
- DELETEDelete Webhook
- GETGet a Product
- GETGet Accepted Payment Methods
- GETGet All Countries
- GETGet All Customers (v2)
- GETGet All Product Images
- GETGet All Product Modifiers
- GETGet All Product Variant Options
- GETGet All Product Variants
- GETGet All States By Country
- GETGet Cart
- GETGet Cart v2
- GETGet Channel Listings
- GETGet Checkout
- GETGet Order Coupons
- GETGet Order Custom Fields
- GETGet Order Shipping Addresses
- GETGet Order Statuses
- GETGet Orders
- GETGet Product Channel Assignments
- GETGet Product Metafield
- GETGet Product Metafields
- GETGet Products
- GETGet Products In Order
- GETGet Shipment from Order
- GETGet Shipping Method
- GETGet Sites
- GETGet Store Information
- GETGet Webhooks Admin Info
- GETList Customer Addresses
- GETList Order Transactions
- PUTUpdate Checkout
- PUTUpdate Customer
- PUTUpdate Customer Address
- PUTUpdate Order
- PUTUpdate Product
- PUTUpdate Product Image
- PUTUpdate Product Metafield
- PUTUpdate Product Variant
- PUTUpdate Product Variant Option
- PUTUpdate Shipping for Order
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.