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.
Schema
信息注释
Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.
The schema and info displayed below is for version 1.
Depending on your destination, table and column names may not appear as they are outlined below.
coupons
The coupons table contains info about the coupons in your BigCommerce store.
信息注释Tip:
This table uses Full Table Replication, which means all records will be replicated during every replication job.
To avoid re-replicating unnecessary data, create a second BigCommerce integration in your Stitch account (you can even use the same BigCommerce API credentials) and set the integration to replicate every 12 or 24 hours.
form_fields: ARRAY, which is also a nested data structure.
name: STRING
value: STRING
last_name: STRING
phone: STRING
state: STRING
street_1: STRING
street_2: STRING
zip: STRING
cart_id
STRING
channel_id
INTEGER
coupon_discount
NUMBER
coupons
ARRAY
This is a nested data structure:
amount: NUMBER
code: STRING
coupon_id: INTEGER
discount: NUMBER
id: INTEGER
order_id: INTEGER
type: STRING
currency_code
STRING
currency_exchange_rate
NUMBER
currency_id
INTEGER
custom_status
STRING
customer_id
INTEGER
customer_message
STRING
date_created
DATE-TIME
date_modified
DATE-TIME
date_shipped
DATE-TIME
default_currency_code
STRING
default_currency_id
INTEGER
discount_amount
STRING
ebay_order_id
STRING
external_id
STRING
external_merchant_id
STRING
external_source
STRING
form_fields
ARRAY
This is a nested data structure:
name: STRING
value: STRING
geoip_country
STRING
geoip_country_iso2
STRING
gift_certificate_amount
NUMBER
handling_cost_ex_tax
NUMBER
handling_cost_inc_tax
NUMBER
handling_cost_tax
NUMBER
handling_cost_tax_class_id
INTEGER
id
INTEGER
ip_address
STRING
is_deleted
BOOLEAN
is_email_opt_in
BOOLEAN
items_shipped
INTEGER
items_total
INTEGER
order_is_digital
BOOLEAN
order_source
STRING
payment_method
STRING
payment_provider_id
STRING
payment_status
STRING
products
ARRAY
This is a nested data structure:
applied_discounts: ARRAY, which is also a nested data structure.
amount: NUMBER
code: STRING
id: STRING
name: STRING
type: STRING
base_cost_price: NUMBER
base_price: NUMBER
base_total: NUMBER
base_wrapping_cost: NUMBER
bin_picking_number: STRING
cost_price_ex_tax: NUMBER
cost_price_inc_tax: NUMBER
cost_price_tax: NUMBER
depth: STRING
ebay_item_id: STRING
ebay_transaction_id: STRING
event_date: DATE-TIME
event_name: STRING
external_id: INTEGER, STRING
fixed_shipping_cost: NUMBER
height: STRING
id: INTEGER
is_bundled_product: BOOLEAN
is_refunded: BOOLEAN
name: STRING
option_set_id: INTEGER
order_address_id: INTEGER
order_id: INTEGER
parent_order_product_id: INTEGER
price_ex_tax: NUMBER
price_inc_tax: NUMBER
price_tax: NUMBER
product_id: INTEGER
product_options: ARRAY, which is also a nested data structure.
display_name: STRING
display_style: STRING
display_value: STRING
id: INTEGER
name: STRING
option_id: INTEGER
order_product_id: INTEGER
product_option_id: INTEGER
type: STRING
value: NUMBER
quantity: INTEGER
quantity_refunded: INTEGER
quantity_shipped: INTEGER
refund_amount: NUMBER
return_id: INTEGER
sku: STRING
total_ex_tax: NUMBER
total_inc_tax: NUMBER
total_tax: NUMBER
type: STRING
weight: NUMBER
width: STRING
wrapping_cost_ex_tax: NUMBER
wrapping_cost_inc_tax: NUMBER
wrapping_cost_tax: NUMBER
wrapping_message: STRING
wrapping_name: STRING
refunded_amount
NUMBER
shipping_address_count
INTEGER
shipping_addresses
ARRAY
base_cost: NUMBER
base_handling_cost: NUMBER
city: STRING
company: STRING
cost_ex_tax: NUMBER
cost_inc_tax: NUMBER
cost_tax: NUMBER
cost_tax_class_id: INTEGER
country: STRING
country_iso2: STRING
email: STRING
first_name: STRING
form_fields: ARRAY, which is also a nested data structure.
name: STRING
value: STRING
handling_cost_ex_tax: NUMBER
handling_cost_inc_tax: NUMBER
handling_cost_tax: NUMBER
handling_cost_tax_class_id: INTEGER
id: INTEGER
items_shipped: INTEGER
items_total: INTEGER
last_name: STRING
order_id: INTEGER
phone: STRING
shipping_method: STRING
shipping_zone_id: INTEGER
shipping_zone_name: STRING
state: STRING
street_1: STRING
street_2: STRING
zip: STRING
shipping_cost_ex_tax
NUMBER
shipping_cost_inc_tax
NUMBER
shipping_cost_tax
NUMBER
shipping_cost_tax_class_id
INTEGER
staff_notes
STRING
status
STRING
status_id
INTEGER
store_credit_amount
NUMBER
subtotal_ex_tax
NUMBER
subtotal_inc_tax
NUMBER
subtotal_tax
NUMBER
tax_provider_id
STRING
total_ex_tax
NUMBER
total_inc_tax
NUMBER
total_tax
NUMBER
wrapping_cost_ex_tax
NUMBER
wrapping_cost_inc_tax
NUMBER
wrapping_cost_tax
NUMBER
wrapping_cost_tax_class_id
INTEGER
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.
