Skip to main content

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

ToolsStatus
Pre-built authorization (OAuth)โœ…
Credentials auto-refreshโœ…
Auth parameters validationโœ…
Pre-built authorization UIโœ…
Custom authorization UIโœ…
Expired credentials detectionโœ…
ToolsStatus
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โœ…
ToolsStatus
HTTP request loggingโœ…
End-to-end type safetyโœ…
Data runtime validationโœ…
OpenTelemetry exportโœ…
Slack alerts on errorsโœ…
Integration status APIโœ…
ToolsStatus
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 nameDescriptionTypeSource code
delete-categoryDelete a category.Action๐Ÿ”— Github
delete-couponDelete a coupon.Action๐Ÿ”— Github
delete-subscriberDelete an email subscriber.Action๐Ÿ”— Github
get-order-shipping-addressesList shipping addresses for an order.Action๐Ÿ”— Github
list-brandsList brandsAction๐Ÿ”— Github
list-categoriesList categories.Action๐Ÿ”— Github
list-channelsList all channels including the default storefrontAction๐Ÿ”— Github
list-couponsList coupons.Action๐Ÿ”— Github
list-customer-addressesList addresses for a customer.Action๐Ÿ”— Github
list-customersList customers.Action๐Ÿ”— Github
list-order-statusesList all available order statuses.Action๐Ÿ”— Github
list-ordersList orders.Action๐Ÿ”— Github
list-price-listsList price lists.Action๐Ÿ”— Github
list-product-variantsList variants for a product.Action๐Ÿ”— Github
list-productsList catalog products.Action๐Ÿ”— Github
list-subscribersList email newsletter subscribers.Action๐Ÿ”— Github
list-wishlistsList wishlists.Action๐Ÿ”— Github
update-categoryUpdate a category.Action๐Ÿ”— Github
update-couponUpdate a coupon.Action๐Ÿ”— Github
update-product-variantUpdate a product variant.Action๐Ÿ”— Github
update-productUpdate a product.Action๐Ÿ”— Github
brandsSync brands.Sync๐Ÿ”— Github
categoriesSync categories.Sync๐Ÿ”— Github
channel-listingsSync product listings for each channel.Sync๐Ÿ”— Github
couponsSync coupons.Sync๐Ÿ”— Github
ordersSync orders.Sync๐Ÿ”— Github
productsSync products.Sync๐Ÿ”— Github
subscribersSync email newsletter subscribers.Sync๐Ÿ”— Github
variantsSync product variants across all productsSync๐Ÿ”— Github
wishlistsSync wishlists.Sync๐Ÿ”— Github

Access requirements

Pre-RequisitesStatusComment
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
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