Integration Specifications
This article will help you learn about how Daasity replicates data from BigCommerce, limitations to the data we can extract and where the data is stored in the BigCommerce schema.
Integration Overview
BigCommerce is an e-commerce platform that empowers businesses to build, scale, and optimize online stores with a wide range of features and integrations.
This document provides context on what kind of data is being gathered through this extractor, which endpoints that data is coming from, and how the extracted tables relate to each other.
Integration Availability
This integration is available for:
Enterprise
Growth
NOTE: The Store Manager user will need to install and allow Daasity App through BigCommerce Marketplace for the OAuth authentication process, or use an API Account.
To use the API Account, please contact support@daasity.com to have the connection between platforms configured.
API Endpoints
The Daasity BigCommerce extractor is built based on the BigCommerce REST API documentation. The following endpoints are used by Daasity to replicate data from BigCommerce:
Entity Relationship Diagram (ERD)
Click here to view the ERD for the Daasity BigCommerce integration illustrating the different tables and keys to join across tables.
BigCommerce Schema
The Daasity BigCommerce extractor creates these tables using the endpoints and replication methods listed. The data is mapped from the source API endpoint to the table based on the mapping logic outlined in each table.
Brands
Brand Meta Fields
Brand Meta Keywords
Categories
Category Meta Keywords
Category Meta Fields
Channels
Channel Meta Fields
Customer Settings Per Channel
Coupons
Coupon Shipping Methods
Customers
Customer Attributes
Customer Settings
Customer Addresses
Customer Store Credits
Customer Attribute Values
Customer Form Fields
Customer Channel Ids
Customer Segment Ids
Orders
Order Coupons
Order Messages
Order Products
Order Refunds
Order Return Items
Order Refund Payments
Order Shipments
Order Shipment Items
Order Shipping Addresses
Order Shipping Address Form Fields
Order Statuses
Order Taxes
Order Transactions
Products
Product Complex Rules
Product Meta Fields
Product Reviews
Product Variants
Product Variant Option Values
Product Bulk Pricing Rules
Product Modifiers
Product Modifiers Option Values
Sites
URLs
Banners
Endpoint: Banners
Update Method: UPSERT
Table Name: [
big_commerce.banners]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
content | content |
page | page |
item_id | item_id |
location | location |
date_created | date_created |
date_type | date_type |
date_from | date_from |
date_to | date_to |
visible | (visible == 1) = true : false |
Brands
Brands
Endpoint: Brands
Update Method: UPSERT
Table Name: [
big_commerce.brands]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
page_title | page_title |
meta_description | meta_description |
image_url | image_url |
search_keywords | search_keywords |
custom_url :: url | custom_url |
custom_url :: is_customized | custom_url_is_customized |
Brand Meta Fields
Endpoint: Brands Meta Fields
Update Method: UPSERT
Table Name: [
big_commerce.brand_meta_fields]
| JSON Element | Database Column |
|---|---|
id | id |
brand_id (path param) | brand_id |
key | key |
value | value |
namespace | namespace |
permission_set | permission_set |
resource_type | resource_type |
resource_id | resource_id |
description | description |
date_created | date_created |
date_modified | date_modified |
Brand Meta Keywords
Endpoint: Brand
Update Method: UPSERT
Table Name: [
big_commerce.brand_meta_keywords]
| JSON Element | Database Column |
|---|---|
brand_id (path param) | brand_id |
keyword | keyword |
Categories
Categories
Endpoint: Categories
Update Method: UPSERT
Table Name: [
big_commerce.categories]
| JSON Element | Database Column |
|---|---|
id | id |
parent_id | parent_id |
name | name |
description | description |
views | views |
sort_order | sort_order |
page_title | page_title |
meta_description | meta_description |
layout_file | layout_file |
image_url | image_url |
is_visible | is_visible |
search_keywords | search_keywords |
default_product_sort | default_product_sort |
custom_url :: url | custom_url |
custom_url :: is_customized | custom_url_is_customized |
Category Meta Keywords
Endpoint: Categories
Update Method: UPSERT
Table Name: [
big_commerce.category_meta_keywords]
| JSON Element | Database Column |
|---|---|
category_id (path param) | category_id |
keyword | keyword |
Category Meta Fields
Endpoint: Category Meta Fields
Update Method: UPSERT
Table Name: [
big_commerce.category_meta_fields]
| JSON Element | Database Column |
|---|---|
id | id |
category_id (path param) | category_id |
key | key |
value | value |
namespace | namespace |
permission_set | permission_set |
resource_type | resource_type |
resource_id | resource_id |
description | description |
date_created | date_created |
date_modified | date_modified |
Channels
Channels
Endpoint: Channels
Update Method: UPSERT
Table Name: [
big_commerce.channels]
| JSON Element | Database Column |
|---|---|
id | id |
external_id | external_id |
is_listable_from_ui | is_listable_from_ui |
is_visible | is_visible |
status | status |
name | name |
type | type |
platform | platform |
date_created | date_created |
date_modified | date_modified |
icon_url | icon_url |
Channel Meta Fields
Endpoint: Channel Meta Fields
Update Method: UPSERT
Table Name: [
big_commerce.channel_meta_fields]
| JSON Element | Database Column |
|---|---|
id | id |
channel_id (path param) | channel_id |
permission_set | permission_set |
namespace | namespace |
key | key |
value | value |
description | description |
resource_type | resource_type |
resource_id | resource_id |
date_created | date_created |
date_modified | date_modified |
Customer Settings Per Channel
Endpoint: Settings Per Channel
Update Method: UPSERT
Table Name: [
big_commerce.customer_settings_per_channel]
| JSON Element | Database Column |
|---|---|
privacy_settings :: ask_shopper_for_tracking_consent | privacy_settings_ask_shopper_for_tracking_consent |
privacy_settings :: ask_shopper_for_tracking_consent_on_checkout | privacy_settings_ask_shopper_for_tracking_consent_on_checkout |
privacy_settings :: policy_url | privacy_settings_policy_url |
customer_group_settings :: guest_customer_group_id | customer_group_settings_guest_customer_group_id |
customer_group_settings :: default_customer_group_id | customer_group_settings_default_customer_group_id |
allow_global_logins | allow_global_logins |
Coupons
Coupons
Endpoint: Coupons
Update Method: UPSERT
Table Name: [
big_commerce.coupons]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
type | type |
amount | amount |
min_purchase | min_purchase |
expires | expires |
enabled | enabled |
code | code |
applies_to :: entity | applies_to_entity |
applies_to :: ids (joins values using ‘,’ as separator) | applies_to_ids |
num_uses | num_uses |
max_uses | max_uses |
max_uses_per_customer | max_uses_per_customer |
date_created | date_created |
Coupon Shipping Methods
Endpoint: Coupons
Update Method: UPSERT
Table Name: [
big_commerce.coupon_shipping_methods]
| JSON Element | Database Column |
|---|---|
coupon_id (from the parent record) | coupon_id |
shipping_method (from the list of values) | shipping_method |
Currencies
Endpoint: Currencies
Update Method: UPSERT
Table Name: [
big_commerce.currencies]
| JSON Element | Database Column |
|---|---|
id | id |
is_default | is_default |
last_updated | last_updated |
country_iso2 | country_iso2 |
currency_code | currency_code |
currency_exchange_rate | currency_exchange_rate |
name | name |
token | token |
auto_update | auto_update |
token_location | token_location |
decimal_token | decimal_token |
thousands_token | thousands_token |
decimal_places | decimal_places |
enabled | enabled |
is_transactional | is_transactional |
use_default_name | use_default_name |
Customers
Customers
Endpoint: Customers
Update Method: UPSERT
Table Name: [
big_commerce.customers]
JSON Element | Database Column |
id | id |
authentication :: force_password_reset | authentication_force_password_reset |
company | company |
customer_group_id | customer_group_id |
first_name | first_name |
last_name | last_name |
notes | notes |
phone | phone |
registration_ip_address | registration_ip_address |
tax_exempt_category | tax_exempt_category |
date_created | date_created |
date_modified | date_modified |
accepts_product_review_abandoned_cart_emails | accepts_product_review_abondoned_cart_emails |
origin_channel_id | origin_channel_id |
shopper_profile_id | shopper_profile_id |
Customer Attributes
Endpoint: Customer Attributes
Update Method: UPSERT
Table Name: [
big_commerce.customer_attributes]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
type | type |
date_created | date_created |
date_modified | date_modified |
Customer Settings
Endpoint: Customer Settings
Update Method: UPSERT
Table Name: [
big_commerce.customer_settings]
| JSON Element | Database Column |
|---|---|
privacy_settings :: ask_shopper_for_tracking_consent | privacy_settings_ask_shopper_for_tracking_consent |
privacy_settings :: ask_shopper_for_tracking_consent_on_checkout | privacy_settings_ask_shopper_for_tracking_consent_on_checkout |
privacy_settings :: policy_url | privacy_settings_policy_url |
customer_group_settings :: guest_customer_group_id | customer_group_settings_guest_customer_group_id |
customer_group_settings :: default_customer_group_id | customer_group_settings_default_customer_group_id |
Customer Addresses
Endpoint: Customers
Update Method: UPSERT
Table Name: [
big_commerce.customer_addresses]
| JSON Element | Database Column |
|---|---|
id | id |
address1 | address1 |
address2 | address2 |
address_type | address_type |
city | city |
company | company |
country | country |
country_code | country_code |
customer_id | customer_id |
first_name | first_name |
last_name | last_name |
phone | phone |
postal_code | postal_code |
state_or_province | state_or_province |
Customer Store Credits
Endpoint: Customers
Update Method: UPSERT
Table Name: [
big_commerce.customer_store_credits]
| JSON Element | Database Column |
|---|---|
customer_id (from the parent record) | customer_id |
amount | amount |
Customer Attribute Values
Endpoint: Customers
Update Method: UPSERT
Table Name: [
big_commerce.customer_attribute_values]
| JSON Element | Database Column |
|---|---|
id | id |
customer_id | customer_id |
attribute_id | attribute_id |
attribute_value | attribute_value |
date_created | date_created |
date_modified | date_modified |
Customer Form Fields
Endpoint:
Update Method: UPSERT
Table Name: [
big_commerce.customer_form_fields]
| JSON Element | Database Column |
|---|---|
customer_id (from the parent record) | customer_id |
name | name |
value | value |
Customer Channel Ids
Endpoint: Customers
Update Method: UPSERT
Table Name: [
big_commerce.customer_channel_ids]
| JSON Element | Database Column |
|---|---|
customer_id (from the parent record) | customer_id |
channel_id (from the list of values) | channel_id |
Customer Segment Ids
Endpoint: Customers
Update Method: UPSERT
Table Name: [
big_commerce.customer_segment_ids]
| JSON Element | Database Column |
|---|---|
customer_id (from the parent record) | customer_id |
segment_id (from the list of values) | segment_id |
Gift Certificates
Endpoint: Gift Certificates
Update Method: UPSERT
Table Name: [
big_commerce.gift_certificates]
| JSON Element | Database Column |
|---|---|
id | id |
code | code |
amount | amount |
status | status |
balance | balance |
to_name | to_name |
order_id | order_id |
template | template |
to_email | to_email |
from_name | from_name |
from_email | from_email |
customer_id | customer_id |
expiry_date | expiry_date |
purchase_date | purchase_date |
Orders
Orders
Endpoint: Orders
Update Method: UPSERT
Table Name: [
big_commerce.orders]
| JSON Element | Database Column |
|---|---|
id | id |
customer_id | customer_id |
date_created | date_created |
date_modified | date_modified |
date_shipped | date_shipped |
status_id | status_id |
status | status |
subtotal_ex_tax | subtotal_ex_tax |
subtotal_inc_tax | subtotal_inc_tax |
subtotal_tax | subtotal_tax |
base_shipping_cost | base_shipping_cost |
shipping_cost_ex_tax | shipping_cost_ex_tax |
shipping_cost_inc_tax | shipping_cost_inc_tax |
shipping_cost_tax | shipping_cost_tax |
shipping_cost_tax_class_id | shipping_cost_tax_class_id |
base_handling_cost | base_handling_cost |
handling_cost_ex_tax | handling_cost_ex_tax |
handling_cost_inc_tax | handling_cost_inc_tax |
handling_cost_tax | handling_cost_tax |
handling_cost_tax_class_id | handling_cost_tax_class_id |
base_wrapping_cost | base_wrapping_cost |
wrapping_cost_ex_tax | wrapping_cost_ex_tax |
wrapping_cost_inc_tax | wrapping_cost_inc_tax |
wrapping_cost_tax | wrapping_cost_tax |
wrapping_cost_tax_class_id | wrapping_cost_tax_class_id |
total_ex_tax | total_ex_tax |
total_inc_tax | total_inc_tax |
total_tax | total_tax |
items_total | items_total |
items_shipped | items_shipped |
payment_method | payment_method |
payment_provider_id | payment_provider_id |
payment_status | payment_status |
refunded_amount | refunded_amount |
order_is_digital | order_is_digital |
store_credit_amount | store_credit_amount |
gift_certificate_amount | gift_certificate_amount |
ip_address | ip_address |
ip_address_v6 | ip_address_v6 |
geoip_country | geoip_country |
geoip_country_iso2 | geoip_country_iso2 |
currency_id | currency_id |
currency_code | currency_code |
currency_exchange_rate | currency_exchange_rate |
default_currency_id | default_currency_id |
default_currency_code | default_currency_code |
staff_notes | staff_notes |
customer_message | customer_message |
discount_amount | discount_amount |
coupon_discount | coupon_discount |
shipping_address_count | shipping_address_count |
is_deleted | is_deleted |
ebay_order_id | ebay_order_id |
cart_id | cart_id |
is_email_opt_in | is_email_opt_in |
credit_card_type | credit_card_type |
order_source | order_source |
channel_id | channel_id |
external_source | external_source |
external_id | external_id |
external_merchant_id | external_merchant_id |
tax_provider_id | tax_provider_id |
customer_locale | customer_locale |
external_order_id | external_order_id |
store_default_currency_code | store_default_currency_code |
store_default_to_transactional_exchange_rate | store_default_to_transactional_exchange_rate |
custom_status | custom_status |
billing_address :: first_name | billing_address_first_name |
billing_address :: last_name | billing_address_last_name |
billing_address :: company | billing_address_company |
billing_address :: street_1 | billing_address_street_1 |
billing_address :: street_2 | billing_address_street_2 |
billing_address :: city | billing_address_city |
billing_address :: state | billing_address_state |
billing_address :: zip | billing_address_zip |
billing_address :: country | billing_address_country |
billing_address :: country_iso2 | billing_address_country_iso2 |
billing_address :: phone | billing_address_phone |
billing_address :: email | billing_address_email |
products :: url | product_url |
products :: resource | product_resource |
shipping_addresses :: url | shipping_addresses_url |
shipping_addresses :: resource | shipping_addresses_resource |
coupons :: url | coupons_url |
coupons :: resource | coupons_resource |
Order Coupons
Endpoint: Order Coupons
Update Method: UPSERT
Table Name: [
big_commerce.order_coupons]
| JSON Element | Database Column |
|---|---|
order_id | order_id |
id | id |
coupon_id | coupon_id |
code | code |
amount | amount |
type | type |
discount | discount |
Order Messages
Endpoint: Order Messages
Update Method: UPSERT
Table Name: [
big_commerce.order_messages]
| JSON Element | Database Column |
|---|---|
id | id |
order_id | order_id |
staff_id | staff_id |
customer_id | customer_id |
type | type |
subject | subject |
message | message |
status | status |
is_flagged | is_flagged |
date_created | date_created |
Order Products
Endpoint: Order Products
Update Method: UPSERT
Table Name: [
big_commerce.order_products]
| JSON Element | Database Column |
|---|---|
order_id | order_id |
id | id |
product_id | product_id |
variant_id | variant_id |
order_address_id | order_address_id |
name | name |
name_customer | name_customer |
name_merchant | name_merchant |
sku | sku |
upc | upc |
type | type |
base_price | base_price |
price_ex_tax | price_ex_tax |
price_inc_tax | price_inc_tax |
price_tax | price_tax |
base_total | base_total |
total_ex_tax | total_ex_tax |
total_inc_tax | total_inc_tax |
total_tax | total_tax |
weight | weight |
width | width |
height | height |
depth | depth |
quantity | quantity |
base_cost_price | base_cost_price |
cost_price_inc_tax | cost_price_inc_tax |
cost_price_ex_tax | cost_price_ex_tax |
cost_price_tax | cost_price_tax |
is_refunded | is_refunded |
quantity_refunded | quantity_refunded |
refund_amount | refund_amount |
return_id | return_id |
wrapping_id | wrapping_id |
wrapping_name | wrapping_name |
base_wrapping_cost | base_wrapping_cost |
wrapping_cost_ex_tax | wrapping_cost_ex_tax |
wrapping_cost_inc_tax | wrapping_cost_inc_tax |
wrapping_cost_tax | wrapping_cost_tax |
wrapping_message | wrapping_cost_tax |
quantity_shipped | quantity_shipped |
event_name | event_name |
event_date | event_date |
fixed_shipping_cost | fixed_shipping_cost |
ebay_item_id | ebay_item_id |
ebay_transaction_id | ebay_transaction_id |
option_set_id | option_set_id |
parent_order_product_id | parent_order_product_id |
is_bundled_product | is_bundled_product |
bin_picking_number | bin_picking_number |
external_id | external_id |
fulfillment_source | fulfillment_source |
brand | brand |
gift_certificate_id | gift_certificate_id |
Order Refunds
Endpoint: Refunds
Update Method: UPSERT
Table Name: [
big_commerce.order_refunds]
| JSON Element | Database Column |
|---|---|
id | id |
order_id | order_id |
user_id | user_id |
created | created |
reason | reason |
total_amount | total_amount |
total_tax | total_tax |
uses_merchant_override_values | uses_merchant_override_values |
Order Return Items
Endpoint: Refunds
Update Method: UPSERT
Table Name: [
big_commerce.order_refund_items]
| JSON Element | Database Column |
|---|---|
item_type | item_type |
item_id | item_id |
quantity | quantity |
requested_amount | requested_amount |
reason | reason |
order_id (from the parent record) | order_id |
refund_id (from the parent record) | refund_id |
Order Refund Payments
Endpoint: Refunds
Update Method: UPSERT
Table Name: [
big_commerce.order_refund_payments]
| JSON Element | Database Column |
|---|---|
id | id |
provider_id | provider_id |
amount | amount |
offline | offline |
is_declined | is_declined |
declined_message | declined_message |
order_id (from the parent record) | order_id |
refund_id (from the parent record) | refund_id |
Order Shipments
Endpoint: Order Shipments
Update Method: UPSERT
Table Name: [
big_commerce.order_shipments]
| JSON Element | Database Column |
|---|---|
id | id |
order_id | order_id |
customer_id | customer_id |
order_address_id | order_address_id |
date_created | date_created |
tracking_number | tracking_number |
merchant_shipping_cost | merchant_shipping_cost |
shipping_method | shipping_method |
comments | comments |
shipping_provider | shipping_provider |
tracking_carrier | tracking_carrier |
tracking_link | tracking_link |
billing_address :: first_name | billing_address_first_name |
billing_address :: last_name | billing_address_last_name |
billing_address :: company | billing_address_company |
billing_address :: street_1 | billing_address_street_1 |
billing_address :: street_2 | billing_address_street_2 |
billing_address :: city | billing_address_city |
billing_address :: state | billing_address_state |
billing_address :: zip | billing_address_zip |
billing_address :: country | billing_address_country |
billing_address :: country_iso2 | billing_address_country_iso2 |
billing_address :: phone | billing_address_phone |
billing_address :: email | billing_address_email |
shipping_address :: first_name | shipping_address_first_name |
shipping_address :: last_name | shipping_address_last_name |
shipping_address :: company | shipping_address_company |
shipping_address :: street_1 | shipping_address_street_1 |
shipping_address :: street_2 | shipping_address_street_2 |
shipping_address :: city | shipping_address_city |
shipping_address :: zip | shipping_address_zip |
shipping_address :: country | shipping_address_country |
shipping_address :: country_iso2 | shipping_address_country_iso2 |
shipping_address :: phone | shipping_address_phone |
shipping_address :: email | shipping_address_email |
Order Shipment Items
Endpoint: Order Shipments
Update Method: UPSERT
Table Name: [
big_commerce.order_shipment_items]
| JSON Element | Database Column |
|---|---|
order_product_id | order_product_id |
product_id | product_id |
quantity | quantity |
shipment_id (from the parent record) | shipment_id |
Order Shipping Addresses
Endpoint: Order Shipping Address
Update Method: UPSERT
Table Name: [
big_commerce.order_shipping_addresses]
| JSON Element | Database Column |
|---|---|
id | id |
order_id | order_id |
first_name | first_name |
last_name | last_name |
company | company |
street_1 | street_1 |
street_2 | street_2 |
city | city |
zip | zip |
country | country |
country_iso2 | country_iso2 |
state | state |
phone | phone |
items_total | items_total |
items_shipped | items_shipped |
shipping_method | shipping_method |
base_cost | base_cost |
cost_ex_tax | cost_ex_tax |
cost_inc_tax | cost_inc_tax |
cost_tax | cost_tax |
cost_tax_class_id | cost_tax_class_id |
base_handling_cost | base_handling_cost |
handling_cost_ex_tax | handling_cost_ex_tax |
handling_cost_inc_tax | handling_cost_inc_tax |
handling_cost_tax | handling_cost_tax |
handling_cost_tax_class_id | handling_cost_tax_class_id |
shipping_zone_id | shipping_zone_id |
shipping_zone_name | shipping_zone_name |
shipping_quotes :: url | shipping_quotes_url |
shipping_quotes :: resource | shipping_quotes_resource |
Order Shipping Address Form Fields
Endpoint: Order Shipping Address
Update Method: UPSERT
Table Name: [
big_commerce.order_shipping_address_form_fields
| JSON Element | Database Column |
|---|---|
order_shipping_address_id (from the parent record) | order_shipping_address_id |
name | name |
value | value |
Order Statuses
Endpoint: Order Statuses
Update Method: UPSERT
Table Name: [
big_commerce.order_statuses]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
system_label | system_label |
custom_label | custom_label |
system_description | system_description |
order_value | order_value |
Order Taxes
Endpoint: Order Taxes
Update Method: UPSERT
Table Name: [
big_commerce.order_taxes]
| JSON Element | Database Column |
|---|---|
id | id |
order_id | order_id |
order_address_id | order_address_id |
tax_rate_id | tax_rate_id |
sales_tax_id | sales_tax_id |
tax_class_id | tax_class_id |
name | name |
class | class |
rate | rate |
priority | priority |
priority_amount | priority_amount |
line_amount | line_amount |
Order Transactions
Endpoint: Order Transactions
Update Method: UPSERT
Table Name: [
big_commerce.order_transactions]
| JSON Element | Database Column |
|---|---|
id | id |
order_id | order_id |
event | event |
method | method |
amount | amount |
currency | currency |
gateway | gateway |
gateway_transaction_id | gateway_transaction_id |
payment_method_id | payment_method_id |
status | status |
test | test |
fraud_review | fraud_review |
reference_transaction_id | reference_transaction_id |
date_created | date_created |
avs_result | avs_result |
cvv_result | cvv_result |
credit_card | credit_card |
gift_certificate | gift_certificate |
store_credit | store_credit |
offline | offline |
custom | custom |
payment_instrument_token | payment_instrument_token |
custom_provider_field_result | custom_provider_field_result |
Payment Methods
Endpoint: Payment Methods
Update Method: UPSERT
Table Name: [
big_commerce.payment_methods]
| JSON Element | Database Column |
|---|---|
code | code |
name | name |
test_mode | test_mode |
Price Lists
Endpoint: Price Lists
Update Method: UPSERT
Table Name: [
big_commerce.price_lists]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
date_modified | date_modified |
date_created | date_created |
active | active |
Products
Products
Endpoint: Products
Update Method: UPSERT
Table Name: [
big_commerce.products]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
type | type |
description | description |
weight | weight |
width | width |
depth | depth |
height | height |
price | price |
cost_price | cost_price |
retail_price | retail_price |
sale_price | sale_price |
map_price | map_price |
tax_class_id | tax_class_id |
product_tax_code | product_tax_code |
calculated_price | calculated_price |
brand_id | brand_id |
option_set_id | option_set_id |
option_set_display | option_set_display |
inventory_level | inventory_level |
inventory_warning_level | inventory_warning_level |
inventory_tracking | inventory_tracking |
reviews_rating_sum | reviews_rating_sum |
reviews_count | reviews_count |
total_sold | total_sold |
fixed_cost_shipping_price | fixed_cost_shipping_price |
is_free_shipping | is_free_shipping |
is_visible | is_visible |
is_featured | is_featured |
warranty | warranty |
bin_picking_number | bin_picking_number |
layout_file | layout_file |
upc | upc |
mpn | mpn |
gtin | gtin |
search_keywords | search_keywords |
availability | availability |
availability_description | availability_description |
gift_wrapping_options_type | gift_wrapping_options_type |
sort_order | sort_order |
condition | condition |
is_condition_shown | is_condition_shown |
order_quantity_minimum | order_quantity_minimum |
order_quantity_maximum | order_quantity_maximum |
page_title | page_title |
meta_description | meta_description |
date_created | date_created |
date_modified | date_modified |
view_count | view_count |
preorder_release_date | preorder_release_date |
preorder_message | preorder_message |
is_preorder_only | is_preorder_only |
is_price_hidden | is_price_hidden |
price_hidden_label | price_hidden_label |
base_variant_id | base_variant_id |
open_graph_type | open_graph_type |
open_graph_title | open_graph_title |
open_graph_description | open_graph_description |
open_graph_use_meta_description | open_graph_use_meta_description |
open_graph_use_product_name | open_graph_use_product_name |
open_graph_use_image | open_graph_use_image |
custom_url :: url | custom_url |
custom_url :: is_customized | custom_url_is_customized |
Product Complex Rules
Endpoint: Product Complex Rules
Update Method: UPSERT
Table Name: [
big_commerce.product_complex_rules]
| JSON Element | Database Column |
|---|---|
id | id |
product_id | product_id |
sort_order | sort_order |
enabled | enabled |
stop | stop |
price_adjuster | price_adjuster |
price_adjuster_value | price_adjuster_value |
weight_adjuster | weight_adjuster |
weight_adjuster_value | weight_adjuster_value |
purchasing_disabled | purchasing_disabled |
purchasing_disabled_message | purchasing_disabled_message |
purchasing_hidden | purchasing_hidden |
image_url | image_url |
Product Meta Fields
Endpoint: Product Meta Fields
Update Method: UPSERT
Table Name: [
big_commerce.product_meta_fields]
| JSON Element | Database Column |
|---|---|
id | id |
product_id | product_id |
key | key |
value | value |
namespace | namespace |
permission_set | permission_set |
resource_type | resource_type |
resource_id | resource_id |
description | description |
date_created | date_created |
date_modified | date_modified |
Product Reviews
Endpoint: Product Reviews
Update Method: UPSERT
Table Name: [
big_commerce.product_reviews]
| JSON Element | Database Column |
|---|---|
id | id |
product_id | product_id |
rating | rating |
title | title |
text | text |
status | status |
name | name |
date_reviewed | date_reviewed |
date_created | date_created |
date_modified | date_modified |
Product Variants
Endpoint: Products
Update Method: UPSERT
Table Name: [
big_commerce.product_variants]
| JSON Element | Database Column |
|---|---|
id | id |
product_id | product_id |
sku | sku |
sku_id | sku_id |
price | price |
calculated_price | calculated_price |
sale_price | sale_price |
retail_price | retail_price |
map_price | map_price |
weight | weight |
calculated_weight | calculated_weight |
width | width |
height | height |
depth | depth |
is_free_shipping | is_free_shipping |
fixed_cost_shipping_price | fixed_cost_shipping_price |
purchasing_disabled | purchasing_disabled |
purchasing_disabled_message | purchasing_disabled_message |
image_url | image_url |
cost_price | cost_price |
upc | upc |
mpn | mpn |
gtin | gtin |
inventory_level | inventory_level |
inventory_warning_level | inventory_warning_level |
bin_picking_number | bin_picking_number |
Product Variant Option Values
Endpoint: Products
Update Method: UPSERT
Table Name: [
big_commerce.product_variant_option_values]
| JSON Element | Database Column |
|---|---|
id | id |
variant_id | variant_id |
product_id | product_id |
label | label |
option_id | option_id |
option_display_name | option_display_name |
Product Bulk Pricing Rules
Endpoint: Products
Update Method: UPSERT
Table Name: [
big_commerce.product_bulk_pricing_rules]
| JSON Element | Database Column |
|---|---|
id | id |
product_id | product_id |
quantity_min | quantity_min |
quantity_max | quantity_max |
type | type |
amount | amount |
Product Modifiers
Endpoint: Products
Update Method: UPSERT
Table Name: [
big_commerce.product_modifiers]
| JSON Element | Database Column |
|---|---|
id | id |
product_id | product_id |
display_name | display_name |
name | name |
type | type |
required | required |
sort_order | sort_order |
config :: default_value | config_default_value |
config :: checked_by_default | config_checked_by_default |
config :: checkbox_label | config_checkbox_label |
config :: date_limited | config_date_limited |
config :: date_limit_mode | config_date_limit_mode |
config :: date_earliest_value | config_date_earliest_value |
config :: date_latest_value | config_date_latest_value |
config :: file_types_mode | config_file_types_mode |
config :: file_types_supported (from the list of values) | config_file_types_supported |
config :: file_types_other | config_file_types_other |
config :: file_max_size | config_file_max_size |
config :: text_characters_limited | config_text_characters_limited |
config :: text_min_length | config_text_min_length |
config :: text_max_length | config_text_max_length |
config :: text_lines_limited | config_text_lines_limited |
config :: text_max_lines | config_text_max_lines |
config :: number_limited | config_number_limited |
config :: number_limit_mode | config_number_limit_mode |
config :: number_lowest_value | config_number_lowest_value |
config :: number_highest_value | config_number_highest_value |
config :: number_integers_only | config_number_integers_only |
config :: product_list_adjusts_inventory | config_product_list_adjusts_inventory |
config :: product_list_adjusts_pricing | config_product_list_adjusts_pricing |
config :: product_list_shipping_calc | config_product_list_shipping_calc |
Product Modifiers Option Values
Endpoint: Products
Update Method: UPSERT
Table Name: [
big_commerce.product_modifiers_option_values]
| JSON Element | Database Column |
|---|---|
id | id |
modifier_id | modifier_id |
product_id | product_id |
option_id | option_id |
is_default | is_default |
label | label |
sort_order | sort_order |
adjusters :: price :: adjuster | adjusters_price_adjuster |
adjusters :: price :: adjuster_value | adjusters_price_adjuster_value |
adjusters :: weight :: adjuster | adjusters_weight_adjuster |
adjusters :: weight :: adjuster_value | adjusters_weight_adjuster_value |
adjusters :: image_url | adjusters_image_url |
adjusters :: purchasing_disabled :: status | adjusters_purchasing_disabled_status |
adjusters :: purchasing_disabled :: message | adjusters_purchasing_disabled_message |
Sites
Sites
Endpoint: Sites
Update Method: UPSERT
Table Name: [
big_commerce.sites]
| JSON Element | Database Column |
|---|---|
id | id |
url | url |
channel_id | channel_id |
created_at | created_at |
updated_at | updated_at |
is_checkout_url_customized | is_checkout_url_customized |
URLs
Endpoint: Sites
Update Method: UPSERT
Table Name: [
big_commerce.site_urls]
| JSON Element | Database Column |
|---|---|
site_id (from parent record) | site_id |
url | url |
type | type |
created_at | created_at |
updated_at | updated_at |
Store Information
Endpoint: Site Information
Update Method: UPSERT
Table Name: [
big_commerce.store_information]
| JSON Element | Database Column |
|---|---|
id | id |
account_uuid | account_uuid |
domain | domain |
secure_url | secure_url |
control_panel_base_url | control_panel_base_url |
status | status |
name | name |
first_name | first_name |
last_name | last_name |
address | address |
country | country |
country_code | country_code |
phone | phone |
admin_email | admin_email |
order_email | order_email |
favicon_url | favicon_url |
timezone :: name | timezone_name |
timezone :: raw_offset | timezone_raw_offset |
timezone :: dst_offset | timezone_dst_offset |
timezone :: dst_correction | timezone_dst_correction |
timezone :: date_format :: display | timezone_date_format_display |
timezone :: date_format :: export | timezone_date_format_export |
timezone :: date_format :: extended_display | timezone_date_format_extended_display |
language | language |
currency | currency |
currency_symbol | currency_symbol |
decimal_separator | decimal_separator |
thousands_separator | thousands_separator |
decimal_places | decimal_places |
currency_symbol_location | currency_symbol_location |
weight_units | weight_units |
dimension_units | dimension_units |
dimension_decimal_places | dimension_decimal_places |
dimension_decimal_token | dimension_decimal_token |
dimension_thousands_token | dimension_thousands_token |
plan_name | plan_name |
plan_level | plan_level |
plan_is_trial | plan_is_trial |
industry | industry |
logo :: url | logo_url |
is_price_entered_with_tax | is_price_entered_with_tax |
store_id | store_id |
default_site_id | default_site_id |
default_channel_id | default_channel_id |
features :: stencil_enabled | features_stencil_enabled |
features :: sitewidehttps_enabled | features_sitewidehttps_enabled |
features :: facebook_catalog_id | features_facebook_catalog_id |
features :: checkout_type | features_checkout_type |
features :: wishlists_enabled | features_wishlists_enabled |
features :: graphql_storefront_api_enabled | features_graphql_storefront_api_enabled |
features :: shopper_consent_tracking_enabled | features_shopper_consent_tracking_enabled |
features :: multi_storefront_enabled | features_multi_storefront_enabled |
Subscribers
Endpoint: Subscribers
Update Method: UPSERT
Table Name: [
big_commerce.subscribers]
| JSON Element | Database Column |
|---|---|
id | id |
first_name | first_name |
last_name | last_name |
source | source |
order_id | order_id |
created_at | created_at |
updated_at | updated_at |
channel_id | channel_id |
Tax Classes
Endpoint: Tax Classes
Update Method: UPSERT
Table Name: [
big_commerce.tax_classes]
| JSON Element | Database Column |
|---|---|
id | id |
name | name |
date_modified | date_modified |
date_created | date_created |
Tax Properties
Endpoint: Tax Properties
Update Method: UPSERT
Table Name: [
big_commerce.tax_properties]
| JSON Element | Database Column |
|---|---|
id | id |
code | code |
display_name | display_name |
description | description |
created_at | created_at |
updated_at | updated_at |
Last updated