> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# BigCommerce

> Integrate your application with the BigCommerce API

## 🚀 Quickstart

Connect to BigCommerce with Nango and see data flow in 2 minutes.

<Steps>
  <Step id="create-integration" title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *BigCommerce*. Enter the Client ID and Client Secret from your BigCommerce app (see the setup guide below).
  </Step>

  <Step id="authorize-bigcommerce" title="Authorize BigCommerce">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then enter the store's Store Hash (see the connect guide below for where to find it) and log in to BigCommerce to approve access. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step id="call-bigcommerce-api" title="Call the BigCommerce API">
    Let's make your first request to the BigCommerce API (fetch a list of orders). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/v2/orders" \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.get({
            endpoint: '/v2/orders',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/reference/backend/backend-sdk/node#get-a-connection-with-credentials) or [API](/reference/backend/http-api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step id="implement-nango" title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/auth/auth-guide) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 BigCommerce Integration Guides

Nango maintained guides for common use cases.

* [How to register your own BigCommerce OAuth app](/api-integrations/bigcommerce/how-to-register-your-own-bigcommerce-api-oauth-app)\
  Register an OAuth app with BigCommerce and obtain credentials to connect it to Nango

* [How to link your BigCommerce account](/api-integrations/bigcommerce/connect)\
  Find your store's Store Hash to connect your BigCommerce account to Nango

Official docs: [BigCommerce API documentation](https://docs.bigcommerce.com/developer/docs/overview/quick-start)

## 🧩 Pre-built syncs & actions for BigCommerce

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

| Function name                  | Description                                        | Type                                           | Source code                                                                                                                              |
| ------------------------------ | -------------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `create-brand`                 | Create a brand.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-brand.ts)                 |
| `create-category`              | Create a category.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-category.ts)              |
| `create-coupon`                | Create a coupon.                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-coupon.ts)                |
| `create-customer`              | Create customers.                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-customer.ts)              |
| `create-order`                 | Create an order.                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-order.ts)                 |
| `create-price-list`            | Create a price list.                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-price-list.ts)            |
| `create-product-variant`       | Create a variant for a product.                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-product-variant.ts)       |
| `create-product`               | Create a product.                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-product.ts)               |
| `create-subscriber`            | Create an email subscriber.                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-subscriber.ts)            |
| `create-wishlist`              | Create a wishlist                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/create-wishlist.ts)              |
| `delete-brand`                 | Delete a brand.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/delete-brand.ts)                 |
| `delete-category`              | Delete a category.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/delete-category.ts)              |
| `delete-coupon`                | Delete a coupon.                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/delete-coupon.ts)                |
| `delete-customer`              | Delete a customer.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/delete-customer.ts)              |
| `delete-product-variant`       | Delete a product variant.                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/delete-product-variant.ts)       |
| `delete-product`               | Delete a product                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/delete-product.ts)               |
| `delete-subscriber`            | Delete an email subscriber.                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/delete-subscriber.ts)            |
| `get-brand`                    | Retrieve a brand.                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/get-brand.ts)                    |
| `get-category`                 | Retrieve a category.                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/get-category.ts)                 |
| `get-coupon`                   | Retrieve a coupon.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/get-coupon.ts)                   |
| `get-order-products`           | List line items for an order.                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/get-order-products.ts)           |
| `get-order-shipping-addresses` | List shipping addresses for an order.              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/get-order-shipping-addresses.ts) |
| `get-order`                    | Retrieve an order.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/get-order.ts)                    |
| `get-product`                  | Retrieve a product.                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/get-product.ts)                  |
| `list-brands`                  | List brands                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-brands.ts)                  |
| `list-categories`              | List categories.                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-categories.ts)              |
| `list-channel-listings`        | List product listings for a channel.               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-channel-listings.ts)        |
| `list-channels`                | List all channels including the default storefront | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-channels.ts)                |
| `list-coupons`                 | List coupons.                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-coupons.ts)                 |
| `list-customer-addresses`      | List addresses for a customer.                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-customer-addresses.ts)      |
| `list-customers`               | List customers.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-customers.ts)               |
| `list-order-statuses`          | List all available order statuses.                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-order-statuses.ts)          |
| `list-orders`                  | List orders.                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-orders.ts)                  |
| `list-price-lists`             | List price lists.                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-price-lists.ts)             |
| `list-product-variants`        | List variants for a product.                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-product-variants.ts)        |
| `list-products`                | List catalog products.                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-products.ts)                |
| `list-subscribers`             | List email newsletter subscribers.                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-subscribers.ts)             |
| `list-wishlists`               | List wishlists.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/list-wishlists.ts)               |
| `update-brand`                 | Update a brand.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-brand.ts)                 |
| `update-category`              | Update a category.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-category.ts)              |
| `update-coupon`                | Update a coupon.                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-coupon.ts)                |
| `update-customer`              | Update a customer.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-customer.ts)              |
| `update-order`                 | Update an order.                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-order.ts)                 |
| `update-product-variant`       | Update a product variant.                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-product-variant.ts)       |
| `update-product`               | Update a product.                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-product.ts)               |
| `update-subscriber`            | Update an email subscriber.                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/actions/update-subscriber.ts)            |
| `brands`                       | Sync brands.                                       | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/brands.ts)                         |
| `categories`                   | Sync categories.                                   | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/categories.ts)                     |
| `channel-listings`             | Sync product listings for each channel.            | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/channel-listings.ts)               |
| `channels`                     | Sync channels                                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/channels.ts)                       |
| `coupons`                      | Sync coupons.                                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/coupons.ts)                        |
| `customers`                    | Sync customers.                                    | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/customers.ts)                      |
| `orders`                       | Sync orders.                                       | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/orders.ts)                         |
| `products`                     | Sync products.                                     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/products.ts)                       |
| `subscribers`                  | Sync email newsletter subscribers.                 | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/subscribers.ts)                    |
| `variants`                     | Sync product variants across all products          | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/variants.ts)                       |
| `wishlists`                    | Sync wishlists.                                    | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/bigcommerce/syncs/wishlists.ts)                      |

***
