| description |
|---|
Shopify is a proprietary e-commerce platform for online stores and retail point-of-sale systems. |
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.
| Integration Type | Airbyte Type |
|---|---|
string |
string |
number |
number |
array |
array |
object |
object |
boolean |
boolean |
| Feature | Supported?(Yes/No) |
|---|---|
| Full Refresh Sync | Yes |
| Incremental - Append Sync | Yes |
| Namespaces | No |
This connector support both: OAuth 2.0 and API PASSWORD (for private applications) athentication methods.
- Go to
https://YOURSTORE.myshopify.com/admin/apps/private - Enable private development if it isn't enabled.
- Create a private application.
- 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.
- The password under the
Admin APIsection is what you'll use as theapi_passwordfor the integration. - You're ready to set up Shopify in Airbyte!
- Select
OAuth 2.0inShopify Authorization Method - Click on
authenticate - Proceed the authentication using your credentials for your Shopify account.
This Source is capable of syncing the following core Streams:
- Abandoned Checkouts
- Collects
- Custom Collections
- Customers
- Draft Orders
- Discount Codes
- Metafields
- Orders
- Orders Refunds
- Orders Risks
- Products
- Transactions
- Tender Transactions
- Pages
- Price Rules
- Locations
- InventoryItems
- InventoryLevels
- Fulfillment Orders
- Fulfillments
- Shop
For better experience with Incremental Refresh the following is recommended:
Order Refunds,Order Risks,Transactionsshould be synced along withOrdersstream.Discount Codesshould be synced along withPrice Rulesstream.
If child streams are synced alone from the parent stream - the full sync will take place, and the records are filtered out afterwards.
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.
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.34 | 2022-03-02 | 10794 | Minor specification re-order, fixed links in documentation |
| 0.1.33 | 2022-02-17 | 10419 | Fixed wrong field type for tax_exemptions for Abandoned_checkouts stream |
| 0.1.32 | 2022-02-18 | 10449 | Added tender_transactions stream |
| 0.1.31 | 2022-02-08 | 10175 | Fixed compatibility issues for legacy user config |
| 0.1.30 | 2022-01-24 | 9648 | Added permission validation before sync |
| 0.1.29 | 2022-01-20 | 9049 | Added shop_url to the record for all streams |
| 0.1.28 | 2022-01-19 | 9591 | Implemented OAuth2.0 authentication method for Airbyte Cloud |
| 0.1.27 | 2021-12-22 | 9049 | Update connector fields title/description |
| 0.1.26 | 2021-12-14 | 8597 | Fix mismatched number of tables for base-normalization, increased performance of order_refunds stream |
| 0.1.25 | 2021-12-02 | 8297 | Added Shop stream |
| 0.1.24 | 2021-11-30 | 7783 | Reviewed and corrected schemas for all streams |
| 0.1.23 | 2021-11-15 | 7973 | Added InventoryItems |
| 0.1.22 | 2021-10-18 | 7101 | Added FulfillmentOrders, Fulfillments streams |
| 0.1.21 | 2021-10-14 | 7382 | Fixed InventoryLevels primary key |
| 0.1.20 | 2021-10-14 | 7063 | Added Location and InventoryLevels as streams |
| 0.1.19 | 2021-10-11 | 6951 | Added support of OAuth 2.0 authorisation option |
| 0.1.18 | 2021-09-21 | 6056 | Added pre_tax_price to the orders/line_items schema |
| 0.1.17 | 2021-09-17 | 5244 | Created data type enforcer for converting prices into numbers |
| 0.1.16 | 2021-09-09 | 5965 | Fixed the connector's performance for Incremental refresh |
| 0.1.15 | 2021-09-02 | 5853 | Fixed amount type in order_refund schema |
| 0.1.14 | 2021-09-02 | 5801 | Fixed line_items/discount allocations & duties parts of orders schema |
| 0.1.13 | 2021-08-17 | 5470 | Fixed rate limits throttling |
| 0.1.12 | 2021-08-09 | 5276 | Add status property to product schema |
| 0.1.11 | 2021-07-23 | 4943 | Fix products schema up to API 2021-07 |
| 0.1.10 | 2021-07-19 | 4830 | Fix for streams json schemas, upgrade to API version 2021-07 |
| 0.1.9 | 2021-07-04 | 4472 | Incremental sync is now using updated_at instead of since_id by default |
| 0.1.8 | 2021-06-29 | 4121 | Add draft orders stream |
| 0.1.7 | 2021-06-26 | 4290 | Fixed the bug when limiting output records to 1 caused infinity loop |
| 0.1.6 | 2021-06-24 | 4009 | Add pages, price rules and discount codes streams |
| 0.1.5 | 2021-06-10 | 3973 | Add AIRBYTE_ENTRYPOINT for Kubernetes support |
| 0.1.4 | 2021-06-09 | 3926 | New attributes to Orders schema |
| 0.1.3 | 2021-06-08 | 3787 | Add Native Shopify Source Connector |