Schema Information
This subtopic provides a structured reference to assist you in working with Daton's Bigcommerce connector and the associated fields and tables.
Schema Information
This subtopic provides a structured reference to assist you in working with Daton's Bigcommerce connector and the associated fields and tables.
Tables/APIs
The following is the list of tables or APIs associated with the Bigcommerce connector:
- Catalog
- Categories
- StoreCurrencies
- Customers
- PriceLists
- Coupons
- Brands
- Products
- Orders
- Subscribers
Catalog
Purpose: This API is used to get the list of all variants in the catalog.
Source API Documentation https://developer.bigcommerce.com/api-reference/catalog/catalog-api/catalog/getvariants
Replication: Full Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
product_id |
INTEGER |
sku |
STRING |
sku_id |
INTEGER |
price |
INTEGER |
calculated_price |
INTEGER |
sale_price |
STRING |
retail_price |
STRING |
map_price |
STRING |
weight |
INTEGER |
calculated_weight |
INTEGER |
width |
INTEGER |
height |
STRING |
depth |
STRING |
is_free_shipping |
BOOLEAN |
fixed_cost_shipping_price |
STRING |
purchasing_disabled |
BOOLEAN |
purchasing_disabled_message |
STRING |
image_url |
STRING |
cost_price |
INTEGER |
upc |
STRING |
mpn |
STRING |
gtin |
STRING |
inventory_level |
INTEGER |
inventory_warning_level |
INTEGER |
bin_picking_number |
STRING |
option_values |
record |
Brands
Purpose: This API is used to get the list of all brands.
Source API Documentation https://developer.bigcommerce.com/api-reference/catalog/catalog-api/brands/getbrands
Replication: Full Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
name |
STRING |
page_title |
STRING |
meta_keywords |
STRING |
meta_description |
STRING |
image_url |
STRING |
search_keywords |
STRING |
custom_url |
RECORD |
Categories
Purpose: This API is used to get the list of all Categories
Source API Documentation https://developer.bigcommerce.com/api-reference/catalog/catalog-api/category/getcategories
Replication: Full Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
parent_id |
INTEGER |
name |
STRING |
description |
STRING |
views |
INTEGER |
sort_order |
INTEGER |
page_title |
STRING |
meta_keywords |
STRING |
meta_description |
STRING |
layout_file |
STRING |
image_url |
STRING |
is_visible |
BOOLEAN |
search_keywords |
STRING |
default_product_sort |
STRING |
custom_url |
record |
Products
Purpose: This API returns the list of all products.
Source API Documentation https://developer.bigcommerce.com/api-reference/catalog/catalog-api/products/getproducts
Replication: Full Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
parent_id |
INTEGER |
name |
STRING |
description |
STRING |
views |
INTEGER |
sort_order |
INTEGER |
page_title |
STRING |
meta_keywords |
STRING |
meta_description |
STRING |
layout_file |
STRING |
image_url |
STRING |
is_visible |
BOOLEAN |
search_keywords |
STRING |
default_product_sort |
STRING |
custom_url |
record |
StoreCurrencies
Purpose: This API returns the list of all store currencies.
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
is_default |
BOOLEAN |
last_updated |
TIMESTAMP |
country_iso2 |
STRING |
currency_code |
STRING |
currency_exchange_rate |
STRING |
name |
STRING |
token |
STRING |
auto_update |
BOOLEAN |
token_location |
STRING |
decimal_token |
STRING |
thousands_token |
STRING |
decimal_places |
INTEGER |
enabled |
BOOLEAN |
Orders
Purpose: This API is used to get the list of orders with parametered filters.
Source API Documentation https://developer.bigcommerce.com/api-reference/orders/orders-api/orders/getorders
Replication: Key-Based Incremental
Replication Key: max_date_modified
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
customer_id |
INTEGER |
date_created |
TIMESTAMP |
date_modified |
TIMESTAMP |
date_shipped |
STRING |
status_id |
INTEGER |
status |
STRING |
subtotal_ex_tax |
STRING |
subtotal_inc_tax |
STRING |
subtotal_tax |
STRING |
base_shipping_cost |
STRING |
shipping_cost_ex_tax |
STRING |
shipping_cost_inc_tax |
STRING |
shipping_cost_tax |
STRING |
shipping_cost_tax_class_id |
INTEGER |
base_handling_cost |
STRING |
handling_cost_ex_tax |
STRING |
handling_cost_inc_tax |
STRING |
handling_cost_tax |
STRING |
handling_cost_tax_class_id |
INTEGER |
base_wrapping_cost |
STRING |
wrapping_cost_ex_tax |
STRING |
wrapping_cost_inc_tax |
STRING |
wrapping_cost_tax |
STRING |
wrapping_cost_tax_class_id |
INTEGER |
total_ex_tax |
STRING |
total_inc_tax |
STRING |
total_tax |
STRING |
items_total |
INTEGER |
items_shipped |
INTEGER |
payment_method |
STRING |
payment_provider_id |
STRING |
payment_status |
STRING |
refunded_amount |
STRING |
order_is_digital |
BOOLEAN |
store_credit_amount |
STRING |
gift_certificate_amount |
STRING |
ip_address |
STRING |
geoip_country |
STRING |
geoip_country_iso2 |
STRING |
currency_id |
INTEGER |
currency_code |
STRING |
currency_exchange_rate |
STRING |
default_currency_id |
INTEGER |
default_currency_code |
STRING |
staff_notes |
STRING |
customer_message |
STRING |
discount_amount |
STRING |
coupon_discount |
STRING |
shipping_address_count |
INTEGER |
is_deleted |
BOOLEAN |
ebay_order_id |
STRING |
cart_id |
STRING |
billing_address |
record |
is_email_opt_in |
BOOLEAN |
credit_card_type |
STRING |
order_source |
STRING |
channel_id |
INTEGER |
external_source |
STRING |
products |
record |
shipping_addresses |
record |
coupons |
record |
external_id |
STRING |
external_merchant_id |
STRING |
tax_provider_id |
STRING |
custom_status |
STRING |
Customers
Purpose: This API is used to get the list of all Customers.
Source API Documentation https://developer.bigcommerce.com/api-reference/customer-subscribers/v3-customers-api/customers/customersget
Replication: Key-Based Incremental
Replication Key: max_date_modified
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
company |
STRING |
first_name |
STRING |
last_name |
STRING |
email |
STRING |
phone |
STRING |
form_fields |
record |
date_created |
TIMESTAMP |
date_modified |
TIMESTAMP |
store_credit |
STRING |
registration_ip_address |
STRING |
customer_group_id |
INTEGER |
notes |
STRING |
tax_exempt_category |
STRING |
reset_pass_on_login |
BOOLEAN |
accepts_marketing |
BOOLEAN |
addresses |
record |
Subscribers
Purpose: This API returns list of all Subscribers
Source API Documentation https://developer.bigcommerce.com/api-reference/customer-subscribers/subscribers-api/subscribers/getsubscribers
Replication: Full Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
company |
STRING |
first_name |
STRING |
last_name |
STRING |
email |
STRING |
phone |
STRING |
form_fields |
record |
date_created |
TIMESTAMP |
date_modified |
TIMESTAMP |
store_credit |
STRING |
registration_ip_address |
STRING |
customer_group_id |
INTEGER |
notes |
STRING |
tax_exempt_category |
STRING |
reset_pass_on_login |
BOOLEAN |
accepts_marketing |
BOOLEAN |
addresses |
record |
PriceLists
Purpose: This API returns all Price Lists.
Source API Documentation https://developer.bigcommerce.com/api-reference/catalog/pricelists-api/price-lists/getpricelistcollection
Replication: Full Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
name |
STRING |
date_created |
TIMESTAMP |
date_modified |
TIMESTAMP |
active |
BOOLEAN |
Banners
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
name |
STRING |
content |
STRING |
page |
STRING |
item_id |
STRING |
location |
STRING |
date_created |
STRING |
date_type |
STRING |
date_from |
STRING |
date_to |
STRING |
visible |
STRING |
Coupons
Purpose: This API returns all the coupons.
Source API Documentation https://developer.bigcommerce.com/api-reference/marketing/marketing-api/coupons/getallcoupons
Replication: Full Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
INTEGER |
name |
STRING |
type |
STRING |
amount |
STRING |
min_purchase |
STRING |
expires |
STRING |
enabled |
BOOLEAN |
code |
STRING |
applies_to |
record |
num_uses |
INTEGER |
max_uses |
INTEGER |
max_uses_per_customer |
INTEGER |
shipping_methods |
STRING |
date_created |
TIMESTAMP |