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

Singer Community
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-bigcommerce
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:

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

Click to enlarge. The BigCommerce Create API Account page, with required permissions highlighted.

  1. Sign into your BigCommerce store as the store owner.
  2. Click Advanced Settings > API Accounts. This will display the Store API Accounts page.
  3. Click the Create API Account button.
  4. In the Name field, enter Stitch.

  5. 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
  6. 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:

Click to enlarge. A BigCommerce API credentials text file. The store has portion of the API path is highlighted.

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 be 123456.

Step 2: Add BigCommerce as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the BigCommerce icon.

  4. 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.

  5. In the Client ID field, paste the client ID from the .txt file you opened in Step 1.2.
  6. In the Access Token field, paste the access token from the .txt file you opened in Step 1.2.

  7. 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 between stores/ and /v3/ in the API path is your store hash. For example: If the API path were https://api.bigcommerce.com/stores/123456/v3/, the store hash would be 123456.

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:

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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.

  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.

  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. 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.

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

coupons

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Get all coupons

The coupons table contains info about the coupons in your BigCommerce store.

coupons table schema

id
INTEGER

The coupon ID.

amount
NUMBER

The discount to apply to an order as either an amount or a percentage. This field is determined by the coupon’s type.

For example: If type: percentage_discount, this value would represent a percentage discount.

applies_to
OBJECT

A list of product or category IDs the coupon can be applied to. The value of the applies_to__entity field indicates whether these are product or category IDs.

Click to expand applies_to

entity
STRING

The type of entity. For example: product

ids
ARRAY

The list of IDs the coupon can be applied to. The value of the entity field indicates whether these are product or category IDs.

Click to expand ids

value
INTEGER

The product or category ID.
coupons (table), ids (attribute)
coupons (table), applies_to (attribute)

code
STRING

The coupon code that customers will enter to receive the coupon’s discount.

date_created
DATE-TIME

The date the coupon was created, in RFC 2822 format.

enabled
BOOLEAN

Indicates if the coupon is enabled.

expires
DATE-TIME

The date the coupon was expires, in RFC 2822 format.

max_uses
INTEGER

The maximum number of times this coupon can be used.

max_uses_per_customer
INTEGER

The maximum number of times each customer can use the coupon.

min_purchase
NUMBER

The minimum value that an order must have before the coupon can be applied.

name
STRING

The name of the coupon.

num_uses
INTEGER

The number of times the coupon has been used.

restricted_to
ARRAY

A list of countries that the coupon is restricted to.

Click to expand restricted_to

countries
ARRAY

A list of countries that the coupon is restricted to.

Click to expand countries

value
STRING

The country the coupon is restricted to.
coupons (table), countries (attribute)
coupons (table), restricted_to (attribute)

shipping_methods
ARRAY

A list of shipping method names.

Click to expand shipping_methods

value
STRING

The name of the shipping method.
coupons (table), shipping_methods (attribute)

type
STRING

The type of coupon. Possible values are:

  • per_item_discount
  • per_total_discount
  • shipping_discount
  • free_shipping
  • percentage_discount

customers

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_modified
Primary Key :

id

 API endpoint :

Get all customers

The customers table contains info about the customers in your BigCommerce store.

customers table schema

id
INTEGER

The customer’s ID.

Reference:

date_modified
DATE-TIME

The date the customer was last modified, in RFC 2822 format.

accepts_marketing
BOOLEAN

Indicates whether the customer wants to receive marketing content from the store.

company
STRING

The name of the company the customer works for.

customer_group_id
INTEGER

The group the customer belongs to.

date_created
DATE-TIME

The date the customer was created, in RFC 2822 format.

email
STRING

The customer’s email address.

first_name
STRING

The customer’s first name.

form_fields
ARRAY

Custom form fields associated with the customer.

Click to expand form_fields

name
STRING

The name of the form field.

value
STRING

The value of the form field.
customers (table), form_fields (attribute)

last_name
STRING

The customer’s last name.

notes
STRING

Store-owner notes about the customer.

phone
STRING

The customer’s phone number.

registration_ip_address
STRING

The customer’s IP address when they signed up.

reset_pass_on_login
BOOLEAN

Indicates if a password change will be forced on the customer’s next login.

store_credit
NUMBER

The amount of store credit the customer has.

tax_exempt_category
STRING

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

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_modified
Primary Key :

id

 API endpoint :

Get all orders

The orders table contains info about the orders in your BigCommerce store.

orders table schema

id
INTEGER

The order ID.

date_modified
DATE-TIME

The date the order was last modified, in RFC 2822 format.

base_handling_cost
NUMBER

The base handling cost.

base_shipping_cost
NUMBER

The base shipping cost.

base_wrapping_cost
NUMBER

The base wrapping cost.

billing_address
OBJECT

The billing address for the customer who placed the order.

Click to expand billing_address

city
STRING

The city of the address.

company
STRING

The company of the of the address.

country
STRING

The country of the address.

country_iso2
STRING

The country code of the country associated with the address.

email
STRING

The email address associated with the address.

first_name
STRING

The first name associated with the address.

form_fields
ARRAY

Details about the form fields associated with the address.

Click to expand form_fields

name
STRING

The name of the form field.

value
STRING

The value of the form field.
orders (table), form_fields (attribute)

last_name
STRING

The last name associated with the address.

phone
STRING

The phone number associated with the address.

state
STRING

The state of the address.

street_1
STRING

The first line of the street associated with the address.

street_2
STRING

The second line of the street associated with the address.

zip
STRING

The zip code of the address.
orders (table), billing_address (attribute)

cart_id
STRING

The ID of the cart that the order originated from.

channel_id
INTEGER

Indicates where the order originated.

coupon_discount
NUMBER

The value of the coupon discount applied to the order.

coupons
ARRAY

Details about the coupons applied to the order.

Click to expand coupons

id
INTEGER

The coupon code ID.

coupon_id
INTEGER

The coupon ID.

amount
NUMBER

The discount to apply to an order as either an amount or a percentage. This field is determined by the coupon’s type.

For example: If type: percentage_discount, this value would represent a percentage discount.

code
STRING

The coupon code entered to receive the discount.

discount
NUMBER

The discount amount applied to the order as a result of the coupon.

order_id
INTEGER

The ID of the order the coupon was applied to.

type
STRING

The type of coupon applied to the order. Possible values are:

  • 0 - per_item_discount
  • 1 - percentage_discount
  • 2 - per_total_discount
  • 3 - shipping_discount
  • 4 - free_shipping
orders (table), coupons (attribute)

currency_code
STRING

The currency code of the currency used in the order.

currency_exchange_rate
NUMBER

The exchange rate of the currency used in the order.

currency_id
INTEGER

The ID of the currency used in the order.

custom_status
STRING

customer_id
INTEGER

The ID of the customer who placed the order.

Reference:

customer_message
STRING

The message the customer entered into the Order Comments box during checkout.

date_created
DATE-TIME

The date the order was created, in RFC 2822 format.

date_shipped
DATE-TIME

The date the order shipped, in RFC 2822 format.

default_currency_code
STRING

The currency code of the default currency for this type of order.

default_currency_id
INTEGER

The ID of the default currency for this type of order.

discount_amount
STRING

The amount of discount applied to the order.

ebay_order_id
STRING

If the order was placed through eBay, this field will contain the eBay order number. Otherwise, the value will be 0.

external_id
STRING

The ID of the order in another system. For example: For Amazon orders, this field will contain the Amazon Order ID.

external_merchant_id
STRING

The ID of the external merchant.

external_source
STRING

The external source.

form_fields
ARRAY

The form fields associated with the order.

Click to expand form_fields

name
STRING

The name of the form field.

value
STRING

The value of the form field.
orders (table), form_fields (attribute)

geoip_country
STRING

The full name of the country where the customer made the purchase, based on the customer’s IP address.

geoip_country_iso2
STRING

The country where the customer made the purchase, in ISO2 format, based on the customer’s IP address.

gift_certificate_amount
NUMBER

The gift certificate amount applied to the order.

handling_cost_ex_tax
NUMBER

The handling cost, excluding tax.

handling_cost_inc_tax
NUMBER

The handling cost, including tax.

handling_cost_tax
NUMBER

The amount of tax associated with the handling cost.

handling_cost_tax_class_id
INTEGER

The ID of the tax class associated with the handling cost.

ip_address
STRING

The IP address of the customer who placed the order, if known.

is_deleted
BOOLEAN

Indicates whether the order was deleted (archived).

is_email_opt_in
BOOLEAN

Indicates whether the customer has selected an opt-in check box on the checkout page to receive emails.

items_shipped
INTEGER

The number of items that have been shipped.

items_total
INTEGER

The total number of items in the order.

order_is_digital
BOOLEAN

Indicates if the order is for digital products.

order_source
STRING

The source of the order. Orders submitted via the store’s website will include a www value, while orders submitted via the API will be set to external.

payment_method
STRING

The payment method for the order. Possible values include:

  • Manual
  • Credit Card
  • Cash
  • Test Payment Gateway

payment_provider_id
STRING

If a payment provider was used, the transaction/payment ID in the order’s payment provider’s system.

payment_status
STRING

The status of payment for the order.

products
ARRAY

Details about the products in the order.

Click to expand products

id
INTEGER

The product ID.

Reference:

applied_discounts
ARRAY

Details about the discounts applied to the product.

Click to expand applied_discounts

id
STRING

The ID of the coupon applied to the order.

amount
NUMBER

The amount of the discount applied to the product.

code
STRING

The code used to apply the discount to the product.

name
STRING

The name of the coupon applied to the order.

type
STRING

The type of coupon applied to the order.
orders (table), applied_discounts (attribute)

base_cost_price
NUMBER

The product’s cost price.

base_price
NUMBER

The product’s base price.

base_total
NUMBER

The product’s total base price.

base_wrapping_cost
NUMBER

The product’s base wrapping cost.

bin_picking_number
STRING

The BIN picking number for the product.

cost_price_ex_tax
NUMBER

The cost price of the product, excluding tax.

cost_price_inc_tax
NUMBER

The cost price of the product, including tax.

cost_price_tax
NUMBER

The total tax applied to the product’s cost price.

depth
STRING

The depth of the product, which can be used when calculating shipping costs.

ebay_item_id
STRING

The product’s eBay item ID.

ebay_transaction_id
STRING

The product’s eBay transaction ID.

event_date
DATE-TIME

The date of the product’s promotional event/scheduled delivery.

event_name
STRING

The name of the promotional event/delivery date.

external_id
INTEGER

The ID of the order in another system. For example: For Amazon orders, this field will contain the Amazon Order ID.

fixed_shipping_cost
NUMBER

The fixed shipping cost for the product.

height
STRING

The height of the product, which can be used when calculating shipping costs.

is_bundled_product
BOOLEAN

Indicates whether this product is bundled with other products.

is_refunded
BOOLEAN

Indicates whether the product has been refunded.

name
STRING

The name of the product.

option_set_id
INTEGER

The ID of the option set applied to the product.

order_address_id
INTEGER

The ID of the associated order address.

order_id
INTEGER

The ID of the order associated with the product.

parent_order_product_id
INTEGER

The ID of a parent product.

Reference:

price_ex_tax
NUMBER

The price of the product, excluding tax.

price_inc_tax
NUMBER

The price of the product, including tax.

price_tax
NUMBER

The total tax amount based on the product’s price.

product_id
INTEGER

The product ID.

product_options
ARRAY

Details about the product options applied to the product.

Click to expand product_options

id
INTEGER

The product option ID.

display_name
STRING

The product option’s display name.

display_style
STRING

Indicates how the product option is displayed on the storefront. For example: drop down

display_value
STRING

The name of the product option value as shown on the storefront.

name
STRING

The name of the product option.

option_id
INTEGER

The option ID.

order_product_id
INTEGER

The order product ID.

product_option_id
INTEGER

The product option ID.

type
STRING

The product option type.

value
NUMBER

orders (table), product_options (attribute)

quantity
INTEGER

The quantity of the product included in the order.

quantity_refunded
INTEGER

The quantity of the product refunded for the order.

quantity_shipped
INTEGER

The quantity of the product that has been shipped.

refund_amount
NUMBER

The amount refunded for the order.

return_id
INTEGER

The refund ID.

sku
STRING

The product SKU.

total_ex_tax
NUMBER

The total amount for the product included in the order, excluding tax.

total_inc_tax
NUMBER

The total amount for the product included in the order, including tax.

total_tax
NUMBER

The total tax amount based on the product’s price and quantity ordered.

type
STRING

The type of product. Possible values are physical or digital.

weight
NUMBER

The weight of the product, used to calculate shipping costs.

width
STRING

The width of the product, used to calculate shipping costs.

wrapping_cost_ex_tax
NUMBER

The total wrapping cost for the product included in the order, excluding tax.

wrapping_cost_inc_tax
NUMBER

The total wrapping cost for the product included in the order, including tax.

wrapping_cost_tax
NUMBER

The total tax amount for wrapping for the product included in the order.

wrapping_message
STRING

The message to accompany the gift wrapping.

wrapping_name
STRING

The name of the gift wrapping option.
orders (table), products (attribute)

refunded_amount
NUMBER

The amount refunded from the order.

shipping_address_count
INTEGER

The number of shipping addresses associated with the transaction.

shipping_addresses
ARRAY

The shipping addresses associated with the order.

Click to expand shipping_addresses

id
INTEGER

base_cost
NUMBER

The base value of the order’s items.

base_handling_cost
NUMBER

The base handling charge.

city
STRING

The city of the address.

company
STRING

The company of the of the address.

cost_ex_tax
NUMBER

The value of the order’s items, excluding tax.

cost_inc_tax
NUMBER

The value of the order’s items, including tax.

cost_tax
NUMBER

The tax amount on the order.

cost_tax_class_id
INTEGER

The ID of the tax class applied to the order.

country
STRING

The country of the address.

country_iso2
STRING

email
STRING

The email address associated with the address.

first_name
STRING

The first name associated with the address.

form_fields
ARRAY

Click to expand form_fields

name
STRING

The name of the form field.

value
STRING

The value of the form field.
orders (table), form_fields (attribute)

handling_cost_ex_tax
NUMBER

The handling charge for the order, excluding tax.

handling_cost_inc_tax
NUMBER

The handling charge for the order, including tax.

handling_cost_tax
NUMBER

The tax amount for the order, based on the handling cost.

handling_cost_tax_class_id
INTEGER

The tax class ID associated with the handling cost.

items_shipped
INTEGER

The number of items that have been shipped.

items_total
INTEGER

The total number of items in the order.

last_name
STRING

The last name associated with the address.

order_id
INTEGER

The order ID.

phone
STRING

The phone number associated with the address.

shipping_method
STRING

The shipping method selected by the customer. For example: Free Shipping

shipping_zone_id
INTEGER

The ID of the shipping zone.

shipping_zone_name
STRING

The name of the shipping zone.

state
STRING

The state of the address.

street_1
STRING

The first line of the street associated with the address.

street_2
STRING

The second line of the street associated with the address.

zip
STRING

The zip code of the address.
orders (table), shipping_addresses (attribute)

shipping_cost_ex_tax
NUMBER

The cost of shipping for the order, excluding tax.

shipping_cost_inc_tax
NUMBER

The cost of shipping for the order, including tax.

shipping_cost_tax
NUMBER

The amount of tax associated with the shipping cost.

shipping_cost_tax_class_id
INTEGER

The ID of the tax class associated with the shipping.

staff_notes
STRING

Additional notes for staff.

status
STRING

The status of the order.

status_id
INTEGER

The ID of the order status.

store_credit_amount
NUMBER

The amount of store credit applied to the order.

subtotal_ex_tax
NUMBER

The order subtotal, excluding tax.

subtotal_inc_tax
NUMBER

The order subtotal including tax.

subtotal_tax
NUMBER

The total tax applied to the order subtotal.

tax_provider_id
STRING

The ID of the tax provider associated with the order. Possible values are:

  • BasicTaxProvider - Tax is set to manual
  • AvaTaxProvider - Used for Avalara. Tax is set to automatic and the order was not created by the BigCommerce API.
  • "" (blank) - Tax provider is unknown

total_ex_tax
NUMBER

The order total, excluding tax.

total_inc_tax
NUMBER

The order total, including tax.

total_tax
NUMBER

The total tax applied to the order.

wrapping_cost_ex_tax
NUMBER

The wrapping cost, excluding tax.

wrapping_cost_inc_tax
NUMBER

The wrapping cost, including tax.

wrapping_cost_tax
NUMBER

The total tax applied to the wrapping cost.

wrapping_cost_tax_class_id
INTEGER

The ID of the tax class associated with the wrapping cost.

products

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_modified
Primary Key :

id

 API endpoint :

Get all products

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.

products table schema

id
INTEGER

The product ID.

Reference:

date_modified
DATE-TIME

The date the order was last modified, in RFC 2822 format.

availability
STRING

The availability of the product. Possible values are:

  • available - The product can be purchased on the storefront
  • disabled - The product is listed in the storefront but can’t be purchased
  • preorder - The product is listed for pre-order

availability_description
STRING

A description of the product’s availability that displays under the product title on the checkout page. This usually tells the customer how long it usually takes to ship this product. For example: Usually ships in 24 hours

base_variant_id
INTEGER

The ID of the base variant associated with a simple product. This value will be null for complex products.

bin_picking_number
STRING

The BIN picking number for the product.

brand_id
INTEGER

The ID of the brand associated with the product.

brand_name
STRING

The name of the brand associated with the product.

bulk_pricing_rules
ARRAY

The bulk pricing rules associated with the product.

Click to expand bulk_pricing_rules

id
INTEGER

The bulk pricing rule ID.

amount
NUMBER

The value of the adjustment by the bulk pricing rule.

quantity_max
INTEGER

The maximum inclusive quantity of a product needed to satisfy the rule. Must be greater than the quantity_min value.

quantity_min
INTEGER

The minimum inclusive quantity of a product needed to satisfy the rule.

type
STRING

The type of adjustment made when the rule is satisfied. Possible values are:

  • price - The adjustment amount per product
  • percent - The adjustment as a percentage of the original price
  • fixed - The adjusted aboslute price of the product
products (table), bulk_pricing_rules (attribute)

calculated_price
NUMBER

The price of the product as seen on the storefront. This will be equal to the sale_price if set, otherwise this will be equal to price.

categories
ARRAY

A list of IDs for the categories that the product belongs to.

Click to expand categories

value
INTEGER

The category ID.
products (table), categories (attribute)

condition
STRING

The product condition, which is shown on the product page if is_condition_shown: true. Possible values are:

  • New
  • Used
  • Refurbished

cost_price
NUMBER

The cost price of the product.

custom_fields
OBJECT

Custom fields associated with the product.

Click to expand custom_fields

id
INTEGER

The ID of the custom field.

name
STRING

The name of the custom field.

value
STRING

The value of the custom field.
products (table), custom_fields (attribute)

custom_url
OBJECT

The custom URL for the product on the storefront.

Click to expand custom_url

is_customized
BOOLEAN

Indicates if the product URL has been customized.

url
STRING

The custom URL for the product.
products (table), custom_url (attribute)

date_created
DATE-TIME

The date the order was created, in RFC 2822 format.

depth
NUMBER

The depth of the product, which can be used when calculating shipping costs.

description
STRING

The product description, which can include HTML formatting.

fixed_cost_shipping_price
NUMBER

The fixed shipping cost for the product.

gift_wrapping_options_list
ARRAY

A list of gift wrapping option IDs associated with the product.

Click to expand gift_wrapping_options_list

value
INTEGER

The gift wrapping option ID.
products (table), gift_wrapping_options_list (attribute)

gift_wrapping_options_type
STRING

The type of the gift wrapping options available for the product. Possible values are:

  • any - Allows any gift wrapping options in the store
  • none - Disallows gift wrapping on the product
  • list - Gift wrapping options listed in gift_wrapping_options_list are allowed for the product

gtin
STRING

The Global Trade Item Number for the product.

height
NUMBER

The height of the product, which can be used when calculating shipping costs.

images
ARRAY

Images associated with the product.

Click to expand images

id
INTEGER

The image ID.

product_id
INTEGER

The ID of the product associated with the image.

Reference:

date_modified
DATE-TIME

The date the image was last modified, in RFC 2822 format.

description
STRING

The description for the image.

image_file
STRING

The local path to the original image file uploaded to BigCommerce.

is_thumbnail
BOOLEAN

Indicates if the image is to be used as the product’s thumbnail.

sort_order
INTEGER

The order in which the image will be displayed on the product page. Higher integers give the image a lower priority.

url_standard
STRING

The standard URL for the image.

url_thumbnail
STRING

The thumbnail URL for the image.

url_tiny
STRING

The tiny URL for the image.

url_zoom
STRING

The zoom URL for the image.
products (table), images (attribute)

inventory_level
INTEGER

The current inventory level of the product.

inventory_tracking
STRING

The type of inventory tracking for the product. Possible values are:

  • none - Inventory levels aren’t tracked
  • product - Inventory levels are tracked using inventory_level and inventory_warning_level
  • variant - Inventory levels are tracked based on variants

inventory_warning_level
INTEGER

The inventory warning level for the product.

is_condition_shown
BOOLEAN

Indicates whether the product condition is shown to the customer on the product page.

is_featured
BOOLEAN

Indicates whether the product should be included in the Featured Products panel when viewing the store.

is_free_shipping
BOOLEAN

Indicates whether the product has free shipping.

is_preorder_only
BOOLEAN

When true, the release date and the preorder status will be automatically removed.

When false, the release date and preorder status will not be automatically removed; these settings must be changed in the BigCommerce control panel.

is_price_hidden
BOOLEAN

Indicates whether the product’s price should be shown on the product page.

is_visible
BOOLEAN

Indicates whether the product should be displayed to customers browsing the store.

layout_file
STRING

The layout template file used to render the product category.

map_price
NUMBER

meta_description
STRING

The custom meta description for the product page.

meta_keywords
STRING

The custom meata keywords for the product page.

mpn
STRING

The Manufacturer Part Number for the product.

name
STRING

The product name.

open_graph_description
STRING

The description to use for the product.

open_graph_title
STRING

The title of the product.

open_graph_type
STRING

The type of the product.

open_graph_use_image
BOOLEAN

Indicates whether the product image or open graph image is used.

open_graph_use_meta_description
BOOLEAN

Indicates whether the product description or open_graph_description is used.

open_graph_use_product_name
BOOLEAN

Indicates whether the product name or open_graph_title is used.

option_set_display
STRING

option_set_id
INTEGER

order_quantity_maximum
INTEGER

The maximum quantity an order can contain when purchasing the product.

order_quantity_minimum
INTEGER

The minimum order an order must contain when purchasing the product.

page_title
STRING

The custom title for the product page.

preorder_message
STRING

The custom expected-date message to display on the product page.

preorder_release_date
STRING

If the product is a preorder, this will contain the release date.

price
NUMBER

The price of the product. Note: Depending on your store settings, this value may or may not include tax.

price_hidden_label
STRING

product_tax_code
STRING

The tax code associated with the product.

related_products
ARRAY

A list of IDs of related products.

retail_price
NUMBER

The retail cost of the product.

reviews_count
INTEGER

The number of times the product has been rated.

reviews_rating_sum
INTEGER

The total rating for the product.

sale_price
NUMBER

The sale price for the product.

search_keywords
STRING

A comma-separated list of keywords used to locate the product when searching the store.

sku
STRING

The product’s SKU.

sort_order
INTEGER

The priority to give the product when included in product lists on category pages and search results.

tax_class_id
INTEGER

The ID of the tax class applied to the product.

total_sold
INTEGER

The total number of times the product has been sold.

type
STRING

The product type. Possible values are:

  • physical
  • ditial

upc
STRING

The upc’s UPC.

variants
ARRAY

Click to expand variants

id
INTEGER

The variant ID.

product_id
INTEGER

The product ID.

Reference:

bin_picking_number
STRING

The BIN picking number for the .

calculated_price
NUMBER

The price of the as seen on the storefront. This will be equal to the sale_price if set, otherwise this will be equal to price.

cost_price
NUMBER

The cost price of the .

depth
NUMBER

The depth of the , which can be used when calculating shipping costs.

fixed_cost_shipping_price
NUMBER

The fixed shipping cost for the .

height
NUMBER

The height of the , which can be used when calculating shipping costs.

image_url
STRING

The image that will be displayed when this variant is selected on the storefront.

inventory_level
INTEGER

The current inventory level of the .

inventory_warning_level
INTEGER

The inventory warning level for the .

is_free_shipping
BOOLEAN

Indicates whether the has free shipping.

map_price
NUMBER

option_values
ARRAY

A list of option and option value IDs that make up the variant.

Click to expand option_values

id
INTEGER

The option value ID.

option_id
INTEGER

The option ID.

label
STRING

The label of the option value.

option_display_name
STRING

The name of the option.
products (table), option_values (attribute)

price
NUMBER

The price of the . Note: Depending on your store settings, this value may or may not include tax.

purchasing_disabled
BOOLEAN

Indicates if the variant is available for purchase on the storefront.

purchasing_disabled_message
STRING

The message that displays when the variant is disabled for purchasing and selected on the storefront.

sale_price
NUMBER

The sale price for the .

sku
STRING

The ‘s SKU.

sku_id
INTEGER

A reference to BigCommerce’s v2 API SKU ID.

upc
STRING

The ‘s UPC.

weight
NUMBER

The weight of the , used to calculate shipping costs.

width
NUMBER

The width of the , used to calculate shipping costs.
products (table), variants (attribute)

videos
ARRAY

Click to expand videos

id
INTEGER

The product video ID.

description
STRING

The description of the video.

length
STRING

The length of the video.

product_id
INTEGER

The ID of the product associated with the video.

sort_order
INTEGER

The order in which the video will be displayed on the product page. Higher integers give a lower priority.

title
STRING

The title of the video.

type
STRING

The video type.

video_id
STRING

The ID of the video on a host site.
products (table), videos (attribute)

view_count
INTEGER

The number of times the product has been viewed.

warranty
STRING

The warranty information for the product, displayed on the product page.

weight
NUMBER

The weight of the product, used to calculate shipping costs.

width
NUMBER

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.