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 [e-mail] 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:

• Banners

• Brands

  • Brands

  • Brand Meta Fields

• Categories

  • Categories

  • Category Meta Fields

• Channels

  • Channels

  • Channel Meta Fields

  • Customer Settings Per Channel

• Coupons

• Currencies

• Customers

  • Customers

  • Customer Attributes

  • Customer Settings

• Gift Certificates

• Orders

  • Orders

  • Order Coupons

  • Order Messages

  • Order Products

  • Order Refunds

  • Order Shipments

  • Order Shipping Addresses

  • Order Statuses

  • Order Taxes

  • Order Transactions

• Payment Methods

• Price Lists

• Products

  • Products

  • Product Complex Rules

  • Product Meta Fields

  • Product Reviews

• Sites

• Store Information

• Subscribers

• Tax Classes

• Tax Properties

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.

• Banners

• Brands

  • Brands

  • Brand Meta Fields

  • Brand Meta Keywords

• Categories

  • Categories

  • Category Meta Keywords

  • Category Meta Fields

• Channels

  • Channels

  • Channel Meta Fields

  • Customer Settings Per Channel

• Coupons

  • Coupons

  • Coupon Shipping Methods

• Currencies

• Customers

  • Customers

  • Customer Attributes

  • Customer Settings

  • Customer Addresses

  • Customer Store Credits

  • Customer Attribute Values

  • Customer Form Fields

  • Customer Channel Ids

  • Customer Segment Ids

• Gift Certificates

• Orders

  • 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

• Payment Methods

• Price Lists

• Products

  • 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

  • Sites

  • URLs

• Store Information

• Subscribers

• Tax Classes

• Tax Properties

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
email	email
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