Release Status | Released | Availability | Free |
Status Page | Shopify Status Page | Default Historical Sync | 1 year |
Whitelist Tables/Columns | Unsupported/Unsupported | Default Replication Frequency | 30 minutes |
Full Table Endpoints | 1 | Incremental Endpoints | 8 |
Destination Incompatibilities | Possible incompatibilities. Learn more. |
Connecting Shopify
Connecting your Shopify data to Stitch is a four-step process:
- Add Shopify as a Stitch data source
- Define the Historical Sync
- Define the Replication Frequency
- Authorizing Stitch to access Shopify
Add Shopify as a Stitch Data Source
- On the Stitch Dashboard page, click the Add an Integration button.
-
Click the Shopify icon.
-
Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.
For example, the name “Stitch Shopify” would create a schema called
stitch_shopify
in the data warehouse. This schema is where all the tables for this integration will be stored. - In the Shop Name field, enter the name of your shop. For example, if your store was
stitch.shopify.com
,stitch
would be entered in this field.
Defining the Historical Sync
The Sync Historical Data setting will define the starting date for your Shopify integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to sync data beyond Shopify’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.
Define the Replication Frequency
The Replication Frequency controls how often Stitch will attempt to replicate data from your Shopify integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.
Before setting the Replication Frequency, note that:
- The more often Shopify is set to replicate, the higher the number of replicated rows.
-
The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.
- If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.
To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.
After selecting a Replication Frequency, click Save Integration.
Authorizing Stitch to Access Shopify
Lastly, you’ll be directed to Shopify’s website to complete the setup.
- Enter your Shopify credentials and click Login.
- A screen asking for authorization to Shopify will display. Note that Stitch will only ever read your data.
- Click Install App.
- After the authorization process successfully completes, you’ll be redirected back to Stitch.
- Click All Done.
Shopify’s Intial Sync
After you finish setting up Shopify, you might see its Sync Status show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial sync for the integration. This may take some time to complete.
Shopify Schema
Stitch's Shopify integration includes these tables:
- checkouts
- collects
- custom_collections
- customers
- metafields
- order_refunds
- orders
- products
- transactions
checkouts
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
checkouts
table contains info about abandoned checkouts. Abandoned checkouts are defined as checkouts where the customer has entered their billing and shipping information, but not completed the ordering process.checkouts & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
checkouts Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Checkout ID (
id
)abandoned_checkout_url
billing_address__address1
billing_address__address2
billing_address__city
billing_address__company
billing_address__country
billing_address__firstname
billing_address__id
billing_address__lastname
billing_address__phone
billing_address__province
billing_address__zip
billing_address__name
billing_address__province_code
billing_address__country_code
billing_address__default
buyer_accepts_marketing
cancel_reason
cart_token
closed_at
completed_at
created_at
currency
customer__accepts_marketing
customer__created_at
customer__email
customer__first_name
customer__id
customer__last_name
customer__note
customer__orders_count
customer__state
customer__total_spent
customer__updated_at
customer__tags
discount_codes
*
email
gateway
landing_site
line_items__fulfillment_service
line_items__grams
line_items__price
line_items__product_id
line_items__quantity
line_items__requires_shipping
line_items__sku
line_items__title
line_items__variant_id
line_items__variant_title
line_items__vendor
note
referring_site
shipping_address__address1
shipping_address__address2
shipping_address__city
shipping_address__company
shipping_address__country
shipping_address__firstname
shipping_address__latitude
shipping_address__longitude
shipping_address__lastname
shipping_address__phone
shipping_address__province
shipping_address__zip
shipping_address__name
shipping_address__province_code
shipping_address__country_code
shipping_lines
*
source_name
subtotal_price
tax_lines
*
taxes_included
token
total_discounts
total_line_items_price
total_price
total_tax
total_weight
updated_at
collects
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
collects
table contains info about collects, which is the link between products and custom collections.collects Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Collect ID (
id
)collection_id
created_at
featured
position
product_id
sort_value
updated_at
custom_collections
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
custom_collections
table contains info about your custom collections.custom_collections Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Custom Collection ID (
id
)body_html
handle
image
published
published_at
published_scope
sort_order
template_suffix
title
updated_at
customers
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
customers
table contains info about your shop's customers.customers & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
customers Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Customer ID (
id
)accepts_marketing
addresses
*
created_at
default_address
*
email
first_name
multipass_identifier
last_name
last_order_id
last_order_name
note
orders_count
state
tags
tax_exempt
total_spent
updated_at
verified_email
metafields
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
metafields
table contains metadata for shop and order resources.metafields Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Metafield ID (
id
)created_at
description
key
namespace
owner_id
owner_resource
value
value_type
updated_at
order_refunds
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
order_refunds
table contains info about refunds applied to transactions.order_refunds & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
order_refunds Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Order Refund ID (
id
)created_at
note
restock
refund_line_items
*
transactions
*
user_id
orders
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
orders
table contains information about your shop's completed orders.orders & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
orders Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Order ID (
id
)billing_address
*
browser_ip
buyer_accepts_marketing
cancel_reason
cancelled_at
cart_token
client_details__accept_language
client_details__browser_height
client_details__browser_ip
client_details__browser_width
client_details__session_hash
client_details__user_agent
closed_at
created_at
currency
customer__accepts_marketing
customer__created_at
customer__email
customer__first_name
customer__id
customer__last_name
customer__note
customer__orders_count
customer__state
customer__total_spent
customer__updated_at
customer__tags
discount_codes
*
email
financial_status
fulfillments
*
fulfillment_status
tags
*
gateway
landing_site
line_items
*
location_id
name
note
note_attributes
*
number
order_number
payment_gateway_names
processed_at
processing_method
referring_site
refunds
shipping_address
*
shipping_lines
*
source_name
subtotal_price
tax_lines
*
taxes_included
token
total_discounts
total_line_items_price
total_price
total_tax
total_weight
updated_at
user_id
order_status_url
products
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
products
table contains info about the products for sale in your shop.products & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
products Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Product ID (
id
)body_html
created_at
handle
images
*
options
*
product_type
published_at
published_scope
tags
*
template_suffix
title
metafields_global_title_tag
metafields_global_description_tag
updated_at
variants
*
vendor
transactions
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
transactions
table contains info about transactions, which are created for every order that results in money exchange. This includes authorizations, sales, captures, voids, and refunds.transactions Attributes
While we try to include everything Shopify has here, this may not be a full list of attributes. Refer to Shopify's documentation for a full list and description of each attribute.
Transaction ID (
id
)amount
authorization
created_at
device_id
gateway
source_name
payment_details
kind
order_id
receipt
error_code
status
test
user_id
currency
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, please reach out to us.