This integration is powered by Singer's BigCommerce tap. For support, visit the GitHub repo or join the Singer Slack.
BigCommerce integration summary
Stitch’s BigCommerce integration replicates data using the BigCommerce REST API . Refer to the Schema section for a list of objects available for replication.
BigCommerce feature snapshot
A high-level look at Stitch's BigCommerce (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on March 12, 2019 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting BigCommerce
BigCommerce setup requirements
To set up BigCommerce in Stitch, you need:
-
Store owner privileges in BigCommerce. This is required to create an API account, which will generate BigCommerce API credentials. In BigCommerce, only store owners can create API accounts.
Step 1: Generate BigCommerce API credentials
In this step, you’ll create an API account and generate read-only API credentials for the BigCommerce store you want to connect to Stitch.
Step 1.1: Create an API account for the store
- Sign into your BigCommerce store as the store owner.
- Click Advanced Settings > API Accounts. This will display the Store API Accounts page.
- Click the Create API Account button.
- In the Name field, enter
Stitch
. -
In the OAuth Scopes section, you’ll set the permissions that Stitch has. Define the following fields:
- Customers - Set to Read-only
- Marketing - Set to Read-only
- Orders - Set to Read-only
- Products - Set to Read-only
- When finished, click the Save button.
Step 1.2: Retrieve your API credentials
After the API account has been successfully created, a pop-up will display and you’ll be prompted to download a .txt
file containing the API credentials. If you aren’t prompted to download the .txt
file or you encounter other issues, contact BigCommerce support.
Download the file to your computer, and then open it. It’ll look similar to the following:

A BigCommerce API credentials text file. The highlighted portion of the API path is the store hash.
You’ll need the following credentials from this file:
- Client ID
- Access Token
-
API Path. This contains your store hash. The value between
stores/
and/v3/
in the API path is your store hash - this is highlighted in the image above.For example: If the API path were
https://api.bigcommerce.com/stores/123456/v3/
, the store hash would be123456
.
Step 2: Add BigCommerce as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the BigCommerce icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch BigCommerce” would create a schema called
stitch_bigcommerce
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Client ID field, paste the client ID from the
.txt
file you opened in Step 1.2. - In the Access Token field, paste the access token from the
.txt
file you opened in Step 1.2. -
In the Store Hash field, paste the store hash from the
.txt
file you opened in Step 1.2.To find your store hash, locate the API Path in the
.txt
file. The value betweenstores/
and/v3/
in the API path is your store hash. For example: If the API path werehttps://api.bigcommerce.com/stores/123456/v3/
, the store hash would be123456
.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your BigCommerce integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond BigCommerce’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
BigCommerce integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For BigCommerce integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up BigCommerce, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
BigCommerce table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the BigCommerce integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
coupons
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The coupons
table contains info about the coupons in your BigCommerce store.
id
The coupon ID. |
||
amount
The discount to apply to an order as either an amount or a percentage. This field is determined by the coupon’s For example: If |
||
applies_to
A list of product or category IDs the coupon can be applied to. The value of the
|
||
code
The coupon code that customers will enter to receive the coupon’s discount. |
||
date_created
The date the coupon was created, in RFC 2822 format. |
||
enabled
Indicates if the coupon is enabled. |
||
expires
The date the coupon was expires, in RFC 2822 format. |
||
max_uses
The maximum number of times this coupon can be used. |
||
max_uses_per_customer
The maximum number of times each customer can use the coupon. |
||
min_purchase
The minimum value that an order must have before the coupon can be applied. |
||
name
The name of the coupon. |
||
num_uses
The number of times the coupon has been used. |
||
restricted_to
A list of countries that the coupon is restricted to.
|
||
shipping_methods
A list of shipping method names.
|
||
type
The type of coupon. Possible values are:
|
customers
Replication Method : |
Key-based Incremental |
Replication Key |
date_modified |
Primary Key |
id |
API endpoint : |
The customers
table contains info about the customers in your BigCommerce store.
id
The customer’s ID. Reference: |
||
date_modified
The date the customer was last modified, in RFC 2822 format. |
||
accepts_marketing
Indicates whether the customer wants to receive marketing content from the store. |
||
company
The name of the company the customer works for. |
||
customer_group_id
The group the customer belongs to. |
||
date_created
The date the customer was created, in RFC 2822 format. |
||
email
The customer’s email address. |
||
first_name
The customer’s first name. |
||
form_fields
Custom form fields associated with the customer.
|
||
last_name
The customer’s last name. |
||
notes
Store-owner notes about the customer. |
||
phone
The customer’s phone number. |
||
registration_ip_address
The customer’s IP address when they signed up. |
||
reset_pass_on_login
Indicates if a password change will be forced on the customer’s next login. |
||
store_credit
The amount of store credit the customer has. |
||
tax_exempt_category
Indicates the tax exempt category applied to the customer. This field can be blank, or can contain a single case-sensitive AvaTax code. Stores that subscribe to BigCommerce’s Avalara Premium integration will use this code to determine how/whether to apply sales tax. This doesn’t affect sales-tax calculations for stores that do not subscribe to Avalara Premium. |
orders
Replication Method : |
Key-based Incremental |
Replication Key |
date_modified |
Primary Key |
id |
API endpoint : |
The orders
table contains info about the orders in your BigCommerce store.
id
The order ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date_modified
The date the order was last modified, in RFC 2822 format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_handling_cost
The base handling cost. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_shipping_cost
The base shipping cost. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_wrapping_cost
The base wrapping cost. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_address
The billing address for the customer who placed the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cart_id
The ID of the cart that the order originated from. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channel_id
Indicates where the order originated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
coupon_discount
The value of the coupon discount applied to the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
coupons
Details about the coupons applied to the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency_code
The currency code of the currency used in the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency_exchange_rate
The exchange rate of the currency used in the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency_id
The ID of the currency used in the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_status
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id
The ID of the customer who placed the order. Reference: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_message
The message the customer entered into the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date_created
The date the order was created, in RFC 2822 format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date_shipped
The date the order shipped, in RFC 2822 format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
default_currency_code
The currency code of the default currency for this type of order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
default_currency_id
The ID of the default currency for this type of order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_amount
The amount of discount applied to the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ebay_order_id
If the order was placed through eBay, this field will contain the eBay order number. Otherwise, the value will be |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_id
The ID of the order in another system. For example: For Amazon orders, this field will contain the Amazon Order ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_merchant_id
The ID of the external merchant. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_source
The external source. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_fields
The form fields associated with the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoip_country
The full name of the country where the customer made the purchase, based on the customer’s IP address. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoip_country_iso2
The country where the customer made the purchase, in ISO2 format, based on the customer’s IP address. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gift_certificate_amount
The gift certificate amount applied to the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
handling_cost_ex_tax
The handling cost, excluding tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
handling_cost_inc_tax
The handling cost, including tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
handling_cost_tax
The amount of tax associated with the handling cost. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
handling_cost_tax_class_id
The ID of the tax class associated with the handling cost. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ip_address
The IP address of the customer who placed the order, if known. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_deleted
Indicates whether the order was deleted (archived). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_email_opt_in
Indicates whether the customer has selected an opt-in check box on the checkout page to receive emails. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items_shipped
The number of items that have been shipped. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items_total
The total number of items in the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_is_digital
Indicates if the order is for digital products. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_source
The source of the order. Orders submitted via the store’s website will include a |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_method
The payment method for the order. Possible values include:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_provider_id
If a payment provider was used, the transaction/payment ID in the order’s payment provider’s system. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_status
The status of payment for the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products
Details about the products in the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
refunded_amount
The amount refunded from the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_address_count
The number of shipping addresses associated with the transaction. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_addresses
The shipping addresses associated with the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_cost_ex_tax
The cost of shipping for the order, excluding tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_cost_inc_tax
The cost of shipping for the order, including tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_cost_tax
The amount of tax associated with the shipping cost. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_cost_tax_class_id
The ID of the tax class associated with the shipping. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
staff_notes
Additional notes for staff. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
The status of the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status_id
The ID of the order status. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
store_credit_amount
The amount of store credit applied to the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subtotal_ex_tax
The order subtotal, excluding tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subtotal_inc_tax
The order subtotal including tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subtotal_tax
The total tax applied to the order subtotal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_provider_id
The ID of the tax provider associated with the order. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_ex_tax
The order total, excluding tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_inc_tax
The order total, including tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_tax
The total tax applied to the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
wrapping_cost_ex_tax
The wrapping cost, excluding tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
wrapping_cost_inc_tax
The wrapping cost, including tax. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
wrapping_cost_tax
The total tax applied to the wrapping cost. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
wrapping_cost_tax_class_id
The ID of the tax class associated with the wrapping cost. |
products
Replication Method : |
Key-based Incremental |
Replication Key |
date_modified |
Primary Key |
id |
API endpoint : |
The products
table contains info about the products in your BigCommerce store.
Note: During the initial replication job for a BigCommerce integration, all products will be replicated. On subsequent replication jobs, only new and updated product records will be replicated.
id
The product ID. Reference: |
|||||||||||||||||||||||||||
date_modified
The date the order was last modified, in RFC 2822 format. |
|||||||||||||||||||||||||||
availability
The availability of the product. Possible values are:
|
|||||||||||||||||||||||||||
availability_description
A description of the product’s |
|||||||||||||||||||||||||||
base_variant_id
The ID of the base variant associated with a simple product. This value will be null for complex products. |
|||||||||||||||||||||||||||
bin_picking_number
The BIN picking number for the product. |
|||||||||||||||||||||||||||
brand_id
The ID of the brand associated with the product. |
|||||||||||||||||||||||||||
brand_name
The name of the brand associated with the product. |
|||||||||||||||||||||||||||
bulk_pricing_rules
The bulk pricing rules associated with the product.
|
|||||||||||||||||||||||||||
calculated_price
The price of the product as seen on the storefront. This will be equal to the |
|||||||||||||||||||||||||||
categories
A list of IDs for the categories that the product belongs to. |
|||||||||||||||||||||||||||
condition
The product condition, which is shown on the product page if
|
|||||||||||||||||||||||||||
cost_price
The cost price of the product. |
|||||||||||||||||||||||||||
custom_fields
Custom fields associated with the product.
|
|||||||||||||||||||||||||||
custom_url
The custom URL for the product on the storefront.
|
|||||||||||||||||||||||||||
date_created
The date the order was created, in RFC 2822 format. |
|||||||||||||||||||||||||||
depth
The depth of the product, which can be used when calculating shipping costs. |
|||||||||||||||||||||||||||
description
The product description, which can include HTML formatting. |
|||||||||||||||||||||||||||
fixed_cost_shipping_price
The fixed shipping cost for the product. |
|||||||||||||||||||||||||||
gift_wrapping_options_list
A list of gift wrapping option IDs associated with the product.
|
|||||||||||||||||||||||||||
gift_wrapping_options_type
The type of the gift wrapping options available for the product. Possible values are:
|
|||||||||||||||||||||||||||
gtin
The Global Trade Item Number for the product. |
|||||||||||||||||||||||||||
height
The height of the product, which can be used when calculating shipping costs. |
|||||||||||||||||||||||||||
images
Images associated with the product.
|
|||||||||||||||||||||||||||
inventory_level
The current inventory level of the product. |
|||||||||||||||||||||||||||
inventory_tracking
The type of inventory tracking for the product. Possible values are:
|
|||||||||||||||||||||||||||
inventory_warning_level
The inventory warning level for the product. |
|||||||||||||||||||||||||||
is_condition_shown
Indicates whether the product condition is shown to the customer on the product page. |
|||||||||||||||||||||||||||
is_featured
Indicates whether the product should be included in the Featured Products panel when viewing the store. |
|||||||||||||||||||||||||||
is_free_shipping
Indicates whether the product has free shipping. |
|||||||||||||||||||||||||||
is_preorder_only
When When |
|||||||||||||||||||||||||||
is_price_hidden
Indicates whether the product’s price should be shown on the product page. |
|||||||||||||||||||||||||||
is_visible
Indicates whether the product should be displayed to customers browsing the store. |
|||||||||||||||||||||||||||
layout_file
The layout template file used to render the product category. |
|||||||||||||||||||||||||||
map_price
|
|||||||||||||||||||||||||||
meta_description
The custom meta description for the product page. |
|||||||||||||||||||||||||||
meta_keywords
The custom meata keywords for the product page. |
|||||||||||||||||||||||||||
mpn
The Manufacturer Part Number for the product. |
|||||||||||||||||||||||||||
name
The product name. |
|||||||||||||||||||||||||||
open_graph_description
The description to use for the product. |
|||||||||||||||||||||||||||
open_graph_title
The title of the product. |
|||||||||||||||||||||||||||
open_graph_type
The type of the product. |
|||||||||||||||||||||||||||
open_graph_use_image
Indicates whether the product image or open graph image is used. |
|||||||||||||||||||||||||||
open_graph_use_meta_description
Indicates whether the product |
|||||||||||||||||||||||||||
open_graph_use_product_name
Indicates whether the product |
|||||||||||||||||||||||||||
option_set_display
|
|||||||||||||||||||||||||||
option_set_id
|
|||||||||||||||||||||||||||
order_quantity_maximum
The maximum quantity an order can contain when purchasing the product. |
|||||||||||||||||||||||||||
order_quantity_minimum
The minimum order an order must contain when purchasing the product. |
|||||||||||||||||||||||||||
page_title
The custom title for the product page. |
|||||||||||||||||||||||||||
preorder_message
The custom expected-date message to display on the product page. |
|||||||||||||||||||||||||||
preorder_release_date
If the product is a preorder, this will contain the release date. |
|||||||||||||||||||||||||||
price
The price of the product. Note: Depending on your store settings, this value may or may not include tax. |
|||||||||||||||||||||||||||
price_hidden_label
|
|||||||||||||||||||||||||||
product_tax_code
The tax code associated with the product. |
|||||||||||||||||||||||||||
related_products
A list of IDs of related products. |
|||||||||||||||||||||||||||
retail_price
The retail cost of the product. |
|||||||||||||||||||||||||||
reviews_count
The number of times the product has been rated. |
|||||||||||||||||||||||||||
reviews_rating_sum
The total rating for the product. |
|||||||||||||||||||||||||||
sale_price
The sale price for the product. |
|||||||||||||||||||||||||||
search_keywords
A comma-separated list of keywords used to locate the product when searching the store. |
|||||||||||||||||||||||||||
sku
The product’s SKU. |
|||||||||||||||||||||||||||
sort_order
The priority to give the product when included in product lists on category pages and search results. |
|||||||||||||||||||||||||||
tax_class_id
The ID of the tax class applied to the product. |
|||||||||||||||||||||||||||
total_sold
The total number of times the product has been sold. |
|||||||||||||||||||||||||||
type
The product type. Possible values are:
|
|||||||||||||||||||||||||||
upc
The upc’s UPC. |
|||||||||||||||||||||||||||
variants
|
|||||||||||||||||||||||||||
videos
|
|||||||||||||||||||||||||||
view_count
The number of times the product has been viewed. |
|||||||||||||||||||||||||||
warranty
The warranty information for the product, displayed on the product page. |
|||||||||||||||||||||||||||
weight
The weight of the product, used to calculate shipping costs. |
|||||||||||||||||||||||||||
width
The width of the product, used to calculate shipping costs. |
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.