BigCommerce

BigCommerce is an eCommerce platform to help retailers and brands create and manage their online businesses.

BigCommerce integration replicates data using the BigCommerce REST API.

See the Schema section for a list of objects available for replication.

En översiktlig beskrivning av denna koppling, inklusive användbara länkar och funktioner som stöds.

Funktion/förmåga	Supportinformation
Stöd till Qlik Talend Data Integration-projekt	Endast replikeringsprojekt. Datapipelineprojekt stöds inte.
Metoder för uppdatering av mål	Replikeringsuppgifter: Tillämpa ändringar Lagra ändringar Mellanlagra data i datareservoar-uppgifter: Sammanställning av ändringsdata (CDC)
Hantera metadata	Manuell generering av metadata är inte nödvändig.
Utveckling av schema	Endast åtgärden Ändra kolumndatatyp stöds.
Replikering av LOB-kolumner (NCLOB, CLOB och BLOB)	Stöds inte.
Schemalagd CDC	Krävs. Det är på detta sätt som målet hålls uppdaterat med ändringar i källan. För uppgifter om replikering, se Schemalägga datauppgifter För mellanlagringsuppgifter i datasjöar, se Schemaläggning av CDC för mellanlagringsuppgift i datasjö
Meddelanden	Stöds delvis Konfigurera aviseringar vid ändringar under drift
Övervakning	Endast CDC, eftersom fullständig laddning inte är relevant för denna koppling. Övervaka en enskild datauppgift
Automatisk denestning av JSON-kolumners nyttolast	Stöds inte. Nyttolaster för JSON-kolumner i källdatauppsättningen avnästlas inte automatiskt på målet.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Kontrollera att kontot du använder har läsåtkomst till de tabeller som du vill hämta.

To retrieve your API credentials:

Log into your BigCommerce account as the store owner.
Click Advanced Settings > API Accounts. The Store API Accounts page is displayed.
Click Create API Account.
In the Name field, enter a name for your app.
In the OAuth Scopes section, set the following permission fields to read-only:
- Customers.
- Marketing.
- Orders.
- Products.
Click Save. The account is created.
From the pop-up window, download the .txt file containing your API credentials.
If you are not prompted to download the .txt file or encounter other issues, contact BigCommerce support.
Open the file and copy the credentials.

Creating the connection

Mer information finns i Koppla till SaaS-program.

Ange de kopplingsegenskaper som krävs.
Ange ett namn på kopplingen i Kopplingsnamn.
Välj Öppna kopplingsmetadata för att definiera metadata för kopplingen när den har skapats.
Klicka på Skapa.

Connection settings
Setting	Description
Data gateway	Välj en Gateway för dataflytt om det krävs för ditt användningsfall. Anteckning om information Detta fält är inte tillgängligt med Qlik Talend Cloud Starter-prenumerationen eftersom den inte stöder Gateway för dataflytt. Om du har en annan prenumerationsnivå och inte vill använda Gateway för dataflytt väljer du Inget. Information om fördelarna med Gateway för dataflytt och användningsfall som kräver det finns i Qlik Data Gateway – dataflytt.
Start Date	Ange det datum, i formatet `MM/DD/YYYY`, från vilket data måste replikeras från din källa till ditt mål.
Client ID	Client ID.
Access Token	Access token.
Store Hash	Store hash. 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.

Replication Method

Full Table

Primary Key

Useful links

BigCommerce API method

Join coupons with	on
orders	coupons.id = orders.coupons.coupon_id coupons.id = orders.products.applied_discounts.id

Join coupons with

orders

coupons.id = orders.coupons.coupon_id

coupons.id = orders.products.applied_discounts.id

amount

NUMBER

applies_to

OBJECT

This is a nested data structure:

entity: STRING
ids: ARRAY, which is also a nested data structure.

code

STRING

date_created

DATE-TIME

enabled

BOOLEAN

expires

DATE-TIME

INTEGER

max_uses

INTEGER

max_uses_per_customer

INTEGER

min_purchase

NUMBER

name

STRING

num_uses

INTEGER

restricted_to

ARRAY

This is a nested data structure:

countries: ARRAY, which is also a nested data structure.

shipping_methods

ARRAY

This is a nested data structure.

type

STRING

customers

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

Replication Method	CDC
Primary Key	id
Replication Key	date_modified
Useful links	BigCommerce API method

Join customers with	on
orders	customers.id = orders.customer_id

accepts_marketing

BOOLEAN

company

STRING

customer_group_id

INTEGER

date_created

DATE-TIME

date_modified

DATE-TIME

email

STRING

first_name

STRING

form_fields

ARRAY

This is a nested data structure:

name: STRING
value: STRING

INTEGER

last_name

STRING

notes

STRING

phone

STRING

registration_ip_address

STRING

reset_pass_on_login

BOOLEAN

store_credit

NUMBER

tax_exempt_category

STRING

orders

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

Replication Method	CDC
Primary Key	id
Replication Key	date_modified
Useful links	BigCommerce API method

Join orders with	on
coupons	orders.coupons.coupon_id = coupons.id orders.products.applied_discounts.id = coupons.id
customers	orders.customer_id = customers.id
products	orders.products.product_id = products.id orders.products.parent_order_product_id = products.id orders.products.product_id = products.images.product_id orders.products.parent_order_product_id = products.images.product_id orders.products.product_id = products.related_products.items orders.products.parent_order_product_id = products.related_products.items orders.products.product_id = products.variants.product_id orders.products.parent_order_product_id = products.variants.product_id

Join orders with

coupons

orders.coupons.coupon_id = coupons.id

orders.products.applied_discounts.id = coupons.id

customers

orders.customer_id = customers.id

products

orders.products.product_id = products.id

orders.products.parent_order_product_id = products.id

orders.products.product_id = products.images.product_id

orders.products.parent_order_product_id = products.images.product_id

orders.products.product_id = products.related_products.items

orders.products.parent_order_product_id = products.related_products.items

orders.products.product_id = products.variants.product_id

orders.products.parent_order_product_id = products.variants.product_id

base_handling_cost

NUMBER

base_shipping_cost

NUMBER

base_wrapping_cost

NUMBER

billing_address

OBJECT

This is a nested data structure:

city: STRING
company: STRING
country: STRING
country_iso2: STRING
email: STRING
first_name: STRING
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

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.

Replication Method	CDC
Primary Key	id
Replication Key	date_modified
Useful links	BigCommerce API method

Join products with	on
orders	products.id = orders.products.product_id products.images.product_id = orders.products.product_id products.related_products.items = orders.products.product_id products.variants.product_id = orders.products.product_id products.id = orders.products.parent_order_product_id products.images.product_id = orders.products.parent_order_product_id products.related_products.items = orders.products.parent_order_product_id products.variants.product_id = orders.products.parent_order_product_id

Join products with

orders

products.id = orders.products.product_id

products.images.product_id = orders.products.product_id

products.related_products.items = orders.products.product_id

products.variants.product_id = orders.products.product_id

products.id = orders.products.parent_order_product_id

products.images.product_id = orders.products.parent_order_product_id

products.related_products.items = orders.products.parent_order_product_id

products.variants.product_id = orders.products.parent_order_product_id

availability

STRING

availability_description

STRING

base_variant_id

INTEGER

bin_picking_number

STRING

brand_id

INTEGER

brand_name

STRING

bulk_pricing_rules

ARRAY

This is a nested data structure:

amount: NUMBER
id: INTEGER
quantity_max: INTEGER
quantity_min: INTEGER
type: STRING

calculated_price

NUMBER

categories

ARRAY

This is a nested data structure.

condition

STRING

cost_price

NUMBER

custom_fields

OBJECT

This is a nested data structure:

id: INTEGER
name: STRING
value: STRING

custom_url

OBJECT

This is a nested data structure:

is_customized: BOOLEAN
url: STRING

date_created

DATE-TIME

date_modified

DATE-TIME

depth

NUMBER

description

STRING

fixed_cost_shipping_price

NUMBER

gift_wrapping_options_list

ARRAY

This is a nested data structure.

gift_wrapping_options_type

STRING

gtin

STRING

height

NUMBER

INTEGER

images

ARRAY

This is a nested data structure:

date_modified: DATE-TIME
description: STRING
id: INTEGER
image_file: STRING
is_thumbnail: BOOLEAN
product_id: INTEGER
sort_order: INTEGER
url_standard: STRING
url_thumbnail: STRING
url_tiny: STRING
url_zoom: STRING

inventory_level

INTEGER

inventory_tracking

STRING

inventory_warning_level

INTEGER

is_condition_shown

BOOLEAN

is_featured

BOOLEAN

is_free_shipping

BOOLEAN

is_preorder_only

BOOLEAN

is_price_hidden

BOOLEAN

is_visible

BOOLEAN

layout_file

STRING

map_price

NUMBER

meta_description

STRING

meta_keywords

STRING

mpn

STRING

name

STRING

open_graph_description

STRING

open_graph_title

STRING

open_graph_type

STRING

open_graph_use_image

BOOLEAN

open_graph_use_meta_description

BOOLEAN

open_graph_use_product_name

BOOLEAN

option_set_display

STRING

option_set_id

INTEGER

order_quantity_maximum

INTEGER

order_quantity_minimum

INTEGER

page_title

STRING

preorder_message

STRING

preorder_release_date

STRING

price

NUMBER

price_hidden_label

STRING

product_tax_code

STRING

related_products

ARRAY

This is a nested data structure.

retail_price

NUMBER

reviews_count

INTEGER

reviews_rating_sum

INTEGER

sale_price

NUMBER

search_keywords

STRING

sku

STRING

sort_order

INTEGER

tax_class_id

INTEGER

total_sold

INTEGER

type

STRING

upc

STRING

variants

ARRAY

This is a nested data structure:

bin_picking_number: STRING
calculated_price: NUMBER
cost_price: NUMBER
depth: NUMBER
fixed_cost_shipping_price: NUMBER
height: NUMBER
id: INTEGER
image_url: STRING
inventory_level: INTEGER
inventory_warning_level: INTEGER
is_free_shipping: BOOLEAN
map_price: NUMBER
option_values: ARRAY, which is also a nested data structure.
- id: INTEGER
- label: STRING
- option_display_name: STRING
- option_id: INTEGER
price: NUMBER
product_id: INTEGER
purchasing_disabled: BOOLEAN
purchasing_disabled_message: STRING
sale_price: NUMBER
sku: STRING
sku_id: INTEGER
upc: STRING
weight: NUMBER
width: NUMBER

videos

ARRAY

description: STRING
id: INTEGER
length: STRING
product_id: INTEGER
sort_order: INTEGER
title: STRING
type: STRING
video_id: STRING

view_count

INTEGER

warranty

STRING

weight

NUMBER

width

NUMBER

Var den här sidan till hjälp för dig?

Om du stöter på några problem med den här sidan eller innehållet på den, t.ex. ett stavfel, ett saknat steg eller ett tekniskt fel – meddela oss!

Lämna din feedback här