# Bigcommerce

### Snapshot

| Features                        | Details                                                                            |
| ------------------------------- | ---------------------------------------------------------------------------------- |
| Release Status                  | Released                                                                           |
| Source API Version              | V2,V3                                                                              |
| Table Selection                 | Yes                                                                                |
| Column Selection                | Yes                                                                                |
| Edit Integration                | Yes                                                                                |
| Replication Type Selection      | No                                                                                 |
| Authentication Parameters       | <p>BigCommerce Store Hash<br>BigCommerce Client ID<br>BigCommerce Access Token</p> |
| Replication Type                | <p>Full Replication<br>Key Based Incremental</p>                                   |
| Replication Key                 | Date                                                                               |
| Suggested Replication Frequency | 1hr                                                                                |

| Tables/APIs Supported |             |
| --------------------- | ----------- |
| Catalog               | Brands      |
| Categories            | Products    |
| StoreCurrencies       | Orders      |
| Customers             | Subscribers |
| PriceLists            | Banners     |
| Coupons               |             |

### Integrate BigCommerce with Daton

1. Sign in to Daton.
2. Select BigCommerce from the list of Integrations.
3. Provide Integration Name, Replication Frequency, and History. The integration name would be used in creating tables for the integration and cannot be changed later.
4. Provide BigCommerce Store Hash, Client ID, and Access Token. Follow the [link](/daton/faqs/api-keys/bigcommerce-api-keys.md) to get your details.
5. Post successful authentication, you will be prompted to choose from the list of available tables.
6. Then select all required fields for each table.
7. Submit the integration.

### Workflow

1. Integrations would be in the Pending state initially and will be moved to the Active state as soon as the first job loads data successfully onto the configured warehouse.
2. Users would be able to edit/pause/re-activate/delete integration anytime.
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list.

### BigCommerce Data

**Catalog**

Purpose: This API is used to get the list of all variants in the catalog.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/catalog/catalog-api/catalog/getvariants>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                          | Target Datatype |
| ----------------------------- | --------------- |
| id                            | INTEGER         |
| product\_id                   | INTEGER         |
| sku                           | STRING          |
| sku\_id                       | INTEGER         |
| price                         | INTEGER         |
| calculated\_price             | INTEGER         |
| sale\_price                   | STRING          |
| retail\_price                 | STRING          |
| map\_price                    | STRING          |
| weight                        | INTEGER         |
| calculated\_weight            | INTEGER         |
| width                         | INTEGER         |
| height                        | STRING          |
| depth                         | STRING          |
| is\_free\_shipping            | BOOLEAN         |
| fixed\_cost\_shipping\_price  | STRING          |
| purchasing\_disabled          | BOOLEAN         |
| purchasing\_disabled\_message | STRING          |
| image\_url                    | STRING          |
| cost\_price                   | INTEGER         |
| upc                           | STRING          |
| mpn                           | STRING          |
| gtin                          | STRING          |
| inventory\_level              | INTEGER         |
| inventory\_warning\_level     | INTEGER         |
| bin\_picking\_number          | STRING          |
| option\_values                | record          |

**Brands**

Purpose: This API is used to get the list of all brands.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/catalog/catalog-api/brands/getbrands>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name              | Target Datatype |
| ----------------- | --------------- |
| id                | INTEGER         |
| name              | STRING          |
| page\_title       | STRING          |
| meta\_keywords    | STRING          |
| meta\_description | STRING          |
| image\_url        | STRING          |
| search\_keywords  | STRING          |
| custom\_url       | record          |

**Categories**

Purpose: This API is used to get the list of all Categories

Source API Documentation  <https://developer.bigcommerce.com/api-reference/catalog/catalog-api/category/getcategories>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                   | Target Datatype |
| ---------------------- | --------------- |
| id                     | INTEGER         |
| parent\_id             | INTEGER         |
| name                   | STRING          |
| description            | STRING          |
| views                  | INTEGER         |
| sort\_order            | INTEGER         |
| page\_title            | STRING          |
| meta\_keywords         | STRING          |
| meta\_description      | STRING          |
| layout\_file           | STRING          |
| image\_url             | STRING          |
| is\_visible            | BOOLEAN         |
| search\_keywords       | STRING          |
| default\_product\_sort | STRING          |
| custom\_url            | record          |

**Products**

Purpose: This API returns the list of all products.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/catalog/catalog-api/products/getproducts>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                   | Target Datatype |
| ---------------------- | --------------- |
| id                     | INTEGER         |
| parent\_id             | INTEGER         |
| name                   | STRING          |
| description            | STRING          |
| views                  | INTEGER         |
| sort\_order            | INTEGER         |
| page\_title            | STRING          |
| meta\_keywords         | STRING          |
| meta\_description      | STRING          |
| layout\_file           | STRING          |
| image\_url             | STRING          |
| is\_visible            | BOOLEAN         |
| search\_keywords       | STRING          |
| default\_product\_sort | STRING          |
| custom\_url            | record          |

**StoreCurrencies**

Purpose: This API returns the list of all store currencies.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/store-management/currency-api/currency/getcurrencies>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                     | Target Datatype |
| ------------------------ | --------------- |
| id                       | INTEGER         |
| is\_default              | BOOLEAN         |
| last\_updated            | TIMESTAMP       |
| country\_iso2            | STRING          |
| currency\_code           | STRING          |
| currency\_exchange\_rate | STRING          |
| name                     | STRING          |
| token                    | STRING          |
| auto\_update             | BOOLEAN         |
| token\_location          | STRING          |
| decimal\_token           | STRING          |
| thousands\_token         | STRING          |
| decimal\_places          | INTEGER         |
| enabled                  | BOOLEAN         |

**Orders**

Purpose: This API is used to get the list of orders with parametered filters.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/orders/orders-api/orders/getorders>

Replication: Key-Based Incremental

Replication Key: max\_date\_modified

**Fields**

| Name                           | Target Datatype |
| ------------------------------ | --------------- |
| id                             | INTEGER         |
| customer\_id                   | INTEGER         |
| date\_created                  | TIMESTAMP       |
| date\_modified                 | TIMESTAMP       |
| date\_shipped                  | STRING          |
| status\_id                     | INTEGER         |
| status                         | STRING          |
| subtotal\_ex\_tax              | STRING          |
| subtotal\_inc\_tax             | STRING          |
| subtotal\_tax                  | STRING          |
| base\_shipping\_cost           | STRING          |
| shipping\_cost\_ex\_tax        | STRING          |
| shipping\_cost\_inc\_tax       | STRING          |
| shipping\_cost\_tax            | STRING          |
| shipping\_cost\_tax\_class\_id | INTEGER         |
| base\_handling\_cost           | STRING          |
| handling\_cost\_ex\_tax        | STRING          |
| handling\_cost\_inc\_tax       | STRING          |
| handling\_cost\_tax            | STRING          |
| handling\_cost\_tax\_class\_id | INTEGER         |
| base\_wrapping\_cost           | STRING          |
| wrapping\_cost\_ex\_tax        | STRING          |
| wrapping\_cost\_inc\_tax       | STRING          |
| wrapping\_cost\_tax            | STRING          |
| wrapping\_cost\_tax\_class\_id | INTEGER         |
| total\_ex\_tax                 | STRING          |
| total\_inc\_tax                | STRING          |
| total\_tax                     | STRING          |
| items\_total                   | INTEGER         |
| items\_shipped                 | INTEGER         |
| payment\_method                | STRING          |
| payment\_provider\_id          | STRING          |
| payment\_status                | STRING          |
| refunded\_amount               | STRING          |
| order\_is\_digital             | BOOLEAN         |
| store\_credit\_amount          | STRING          |
| gift\_certificate\_amount      | STRING          |
| ip\_address                    | STRING          |
| geoip\_country                 | STRING          |
| geoip\_country\_iso2           | STRING          |
| currency\_id                   | INTEGER         |
| currency\_code                 | STRING          |
| currency\_exchange\_rate       | STRING          |
| default\_currency\_id          | INTEGER         |
| default\_currency\_code        | STRING          |
| staff\_notes                   | STRING          |
| customer\_message              | STRING          |
| discount\_amount               | STRING          |
| coupon\_discount               | STRING          |
| shipping\_address\_count       | INTEGER         |
| is\_deleted                    | BOOLEAN         |
| ebay\_order\_id                | STRING          |
| cart\_id                       | STRING          |
| billing\_address               | record          |
| is\_email\_opt\_in             | BOOLEAN         |
| credit\_card\_type             | STRING          |
| order\_source                  | STRING          |
| channel\_id                    | INTEGER         |
| external\_source               | STRING          |
| products                       | record          |
| shipping\_addresses            | record          |
| coupons                        | record          |
| external\_id                   | STRING          |
| external\_merchant\_id         | STRING          |
| tax\_provider\_id              | STRING          |
| custom\_status                 | STRING          |

**Customers**

Purpose: This API is used to get the list of all Customers.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/customer-subscribers/v3-customers-api/customers/customersget>

Replication: Key-Based Incremental

Replication Key: max\_date\_modified

**Fields**

| Name                      | Target Datatype |
| ------------------------- | --------------- |
| id                        | INTEGER         |
| company                   | STRING          |
| first\_name               | STRING          |
| last\_name                | STRING          |
| email                     | STRING          |
| phone                     | STRING          |
| form\_fields              | record          |
| date\_created             | TIMESTAMP       |
| date\_modified            | TIMESTAMP       |
| store\_credit             | STRING          |
| registration\_ip\_address | STRING          |
| customer\_group\_id       | INTEGER         |
| notes                     | STRING          |
| tax\_exempt\_category     | STRING          |
| reset\_pass\_on\_login    | BOOLEAN         |
| accepts\_marketing        | BOOLEAN         |
| addresses                 | record          |

**Subscribers**

Purpose: This API returns list of all Subscribers

Source API Documentation  <https://developer.bigcommerce.com/api-reference/customer-subscribers/subscribers-api/subscribers/getsubscribers>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                      | Target Datatype |
| ------------------------- | --------------- |
| id                        | INTEGER         |
| company                   | STRING          |
| first\_name               | STRING          |
| last\_name                | STRING          |
| email                     | STRING          |
| phone                     | STRING          |
| form\_fields              | record          |
| date\_created             | TIMESTAMP       |
| date\_modified            | TIMESTAMP       |
| store\_credit             | STRING          |
| registration\_ip\_address | STRING          |
| customer\_group\_id       | INTEGER         |
| notes                     | STRING          |
| tax\_exempt\_category     | STRING          |
| reset\_pass\_on\_login    | BOOLEAN         |
| accepts\_marketing        | BOOLEAN         |
| addresses                 | record          |

**PriceLists**

Purpose: This API returns all Price Lists.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/catalog/pricelists-api/price-lists/getpricelistcollection>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name           | Target Datatype |
| -------------- | --------------- |
| id             | INTEGER         |
| name           | STRING          |
| date\_created  | TIMESTAMP       |
| date\_modified | TIMESTAMP       |
| active         | BOOLEAN         |

**Banners**

Purpose: This API returns all banners

Source API Documentation  <https://developer.bigcommerce.com/api-reference/marketing/marketing-api/banners/getallbanners>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name          | Target Datatype |
| ------------- | --------------- |
| id            | INTEGER         |
| name          | STRING          |
| content       | STRING          |
| page          | STRING          |
| item\_id      | STRING          |
| location      | STRING          |
| date\_created | STRING          |
| date\_type    | STRING          |
| date\_from    | STRING          |
| date\_to      | STRING          |
| visible       | STRING          |

**Coupons**

Purpose: This API returns all the coupons.

Source API Documentation  <https://developer.bigcommerce.com/api-reference/marketing/marketing-api/coupons/getallcoupons>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                     | Target Datatype |
| ------------------------ | --------------- |
| id                       | INTEGER         |
| name                     | STRING          |
| type                     | STRING          |
| amount                   | STRING          |
| min\_purchase            | STRING          |
| expires                  | STRING          |
| enabled                  | BOOLEAN         |
| code                     | STRING          |
| applies\_to              | record          |
| num\_uses                | INTEGER         |
| max\_uses                | INTEGER         |
| max\_uses\_per\_customer | INTEGER         |
| shipping\_methods        | STRING          |
| date\_created            | TIMESTAMP       |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/ecommerce/bigcommerce.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.