Skip to main content

Shopify

Sync overview

The Shopify source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

This source can sync data for the Shopify API.

This Source Connector is based on a Airbyte CDK.

Troubleshooting

Check out common troubleshooting issues for the BigQuery destination connector on our Discourse here.

Output schema

This Source is capable of syncing the following core Streams:

NOTE

For better experience with Incremental Refresh the following is recommended:

  • Order Refunds, Order Risks, Transactions should be synced along with Orders stream.
  • Discount Codes should be synced along with Price Rules stream.

If child streams are synced alone from the parent stream - the full sync will take place, and the records are filtered out afterwards.

Data type mapping

Integration TypeAirbyte Type
stringstring
numbernumber
arrayarray
objectobject
booleanboolean

Features

FeatureSupported?(Yes/No)
Full Refresh SyncYes
Incremental - Append SyncYes
NamespacesNo

Getting started

This connector support both: OAuth 2.0 and API PASSWORD (for private applications) athentication methods.

Connect using API PASSWORD option

  1. Go to https://YOURSTORE.myshopify.com/admin/apps/private
  2. Enable private development if it isn't enabled.
  3. Create a private application.
  4. Select the resources you want to allow access to. Airbyte only needs read-level access.
    • Note: The UI will show all possible data sources and will show errors when syncing if it doesn't have permissions to access a resource.
  5. The password under the Admin API section is what you'll use as the api_password for the integration.
  6. You're ready to set up Shopify in Airbyte!

Connect using OAuth 2.0 option

  1. Select OAuth 2.0 in Shopify Authorization Method
  2. Click on authenticate
  3. Proceed the authentication using your credentials for your Shopify account.

Output Streams Schemas

This Source is capable of syncing the following core Streams:

Notes

For better experience with Incremental Refresh the following is recommended:

  • Order Refunds, Order Risks, Transactions should be synced along with Orders stream.
  • Discount Codes should be synced along with Price Rules stream.

If child streams are synced alone from the parent stream - the full sync will take place, and the records are filtered out afterwards.

Performance considerations

Shopify has some rate limit restrictions. Typically, there should not be issues with throttling or exceeding the rate limits but in some edge cases, user can receive the warning message as follows:

"Caught retryable error '<some_error> or null' after <some_number> tries. Waiting <some_number> seconds then retrying..."

This is expected when the connector hits the 429 - Rate Limit Exceeded HTTP Error. With given error message the sync operation is still goes on, but will require more time to finish.

Changelog

VersionDatePull RequestSubject
0.1.372022-04-3012500Improve input configuration copy
0.1.362022-03-229850Added BalanceTransactions stream
0.1.352022-03-0710915Fix a bug which caused full-refresh syncs of child REST entities configured for incremental
0.1.342022-03-0210794Minor specification re-order, fixed links in documentation
0.1.332022-02-1710419Fixed wrong field type for tax_exemptions for Abandoned_checkouts stream
0.1.322022-02-1810449Added tender_transactions stream
0.1.312022-02-0810175Fixed compatibility issues for legacy user config
0.1.302022-01-249648Added permission validation before sync
0.1.292022-01-209049Added shop_url to the record for all streams
0.1.282022-01-199591Implemented OAuth2.0 authentication method for Airbyte Cloud
0.1.272021-12-229049Update connector fields title/description
0.1.262021-12-148597Fix mismatched number of tables for base-normalization, increased performance of order_refunds stream
0.1.252021-12-028297Added Shop stream
0.1.242021-11-307783Reviewed and corrected schemas for all streams
0.1.232021-11-157973Added InventoryItems
0.1.222021-10-187101Added FulfillmentOrders, Fulfillments streams
0.1.212021-10-147382Fixed InventoryLevels primary key
0.1.202021-10-147063Added Location and InventoryLevels as streams
0.1.192021-10-116951Added support of OAuth 2.0 authorisation option
0.1.182021-09-216056Added pre_tax_price to the orders/line_items schema
0.1.172021-09-175244Created data type enforcer for converting prices into numbers
0.1.162021-09-095965Fixed the connector's performance for Incremental refresh
0.1.152021-09-025853Fixed amount type in order_refund schema
0.1.142021-09-025801Fixed line_items/discount allocations & duties parts of orders schema
0.1.132021-08-175470Fixed rate limits throttling
0.1.122021-08-095276Add status property to product schema
0.1.112021-07-234943Fix products schema up to API 2021-07
0.1.102021-07-194830Fix for streams json schemas, upgrade to API version 2021-07
0.1.92021-07-044472Incremental sync is now using updated_at instead of since_id by default
0.1.82021-06-294121Add draft orders stream
0.1.72021-06-264290Fixed the bug when limiting output records to 1 caused infinity loop
0.1.62021-06-244009Add pages, price rules and discount codes streams
0.1.52021-06-103973Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.42021-06-093926New attributes to Orders schema
0.1.32021-06-083787Add Native Shopify Source Connector