BigCommerce

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

✅ Authorization

Tools	Status
Pre-built authorization (OAuth)	✅
Credentials auto-refresh	✅
Auth parameters validation	✅
Pre-built authorization UI	✅
Custom authorization UI	✅
Expired credentials detection	✅

✅ Read & write data

Tools	Status
Pre-built integrations	✅
API unification	✅
2-way sync	✅
Webhooks from Nango on data modifications	✅
Real-time webhooks from 3rd-party API	🚫 (time to contribute: <48h)
Proxy requests	✅

✅ Observability & data quality

Tools	Status
HTTP request logging	✅
End-to-end type safety	✅
Data runtime validation	✅
OpenTelemetry export	✅
Slack alerts on errors	✅
Integration status API	✅

✅ Customization

Tools	Status
Create or customize use-cases	✅
Pre-configured pagination	🚫 (time to contribute: <48h)
Pre-configured rate-limit handling	🚫 (time to contribute: <48h)
Per-customer configurations	✅

Others

Function name	Description	Type	Source code
delete-category	Delete a category.	Action	🔗 Github
delete-coupon	Delete a coupon.	Action	🔗 Github
delete-subscriber	Delete an email subscriber.	Action	🔗 Github
get-order-shipping-addresses	List shipping addresses for an order.	Action	🔗 Github
list-brands	List brands	Action	🔗 Github
list-categories	List categories.	Action	🔗 Github
list-channels	List all channels including the default storefront	Action	🔗 Github
list-coupons	List coupons.	Action	🔗 Github
list-customer-addresses	List addresses for a customer.	Action	🔗 Github
list-customers	List customers.	Action	🔗 Github
list-order-statuses	List all available order statuses.	Action	🔗 Github
list-orders	List orders.	Action	🔗 Github
list-price-lists	List price lists.	Action	🔗 Github
list-product-variants	List variants for a product.	Action	🔗 Github
list-products	List catalog products.	Action	🔗 Github
list-subscribers	List email newsletter subscribers.	Action	🔗 Github
list-wishlists	List wishlists.	Action	🔗 Github
update-category	Update a category.	Action	🔗 Github
update-coupon	Update a coupon.	Action	🔗 Github
update-product-variant	Update a product variant.	Action	🔗 Github
update-product	Update a product.	Action	🔗 Github
brands	Sync brands.	Sync	🔗 Github
categories	Sync categories.	Sync	🔗 Github
channel-listings	Sync product listings for each channel.	Sync	🔗 Github
coupons	Sync coupons.	Sync	🔗 Github
orders	Sync orders.	Sync	🔗 Github
products	Sync products.	Sync	🔗 Github
subscribers	Sync email newsletter subscribers.	Sync	🔗 Github
variants	Sync product variants across all products	Sync	🔗 Github
wishlists	Sync wishlists.	Sync	🔗 Github

Access requirements

Pre-Requisites	Status	Comment
Paid dev account	❓
Paid test account	❓
Partnership	❓
App review	❓
Security audit	❓

Setup guide

No setup guide yet.

Need help getting started? Get help in the community.

Contribute improvements to the setup guide by editing this page

Useful links

• How to register an Application
• OAuth-related docs
• List of OAuth scopes
• API rate limiting

Contribute useful links by editing this page

API gotchas

• BigCommerce offers various apps with different levels of visibility. For more details, see BigCommerce types of Apps
• After creating a new connection on Nango, you will need to rewrite your HTTP request headers to use the X-Auth-Token header to pass the API account’s access_token instead of the Authorization header as described in here. Please look at the following example:

const connection = await nango.getConnection();

if (!connection.credentials || typeof connection.credentials !== 'object') {
    throw new nango.ActionError({
        message: `credentials are missing or invalid`
    });
}

let access_token: string;
if ('access_token' in connection.credentials) {
    access_token = connection.credentials.access_token;
} else {
    throw new nango.ActionError({
        message: `access_token is missing`
    });
}

const config = {
    endpoint: '/v2/orders',
    headers: {
        'X-Auth-Token': access_token
    }
};

const response = await nango.get(config);

Contribute API gotchas by editing this page