* Updates to API docs * Updates from review * resolve conflits * Update Asana doc * Revert Asana * Add note on multiple projects
2.7 KiB
2.7 KiB
Prerequisites
- An Active Shopify store
- The Admin API access token of your Custom App.
:::note
Our Shopify Source Connector does not support OAuth at this time due to limitations outside of our control. If OAuth for Shopify is critical to your business, please reach out to us to discuss how we may be able to partner on this effort.
:::
Setup guide
- Name your source.
- Enter your Store name. You can find this in your URL when logged in to Shopify or within the Store details section of your Settings.
- Enter your Admin API access token. To set up the access token, you will need to set up a custom application. See instructions below on creating a custom app.
- Click Set up source
Creating a Custom App
Authentication to the Shopify API requies a custom application. Follow these instructions to create a custom app and find your Admin API Access Token.
- Navigate to Settings > App and sales channels > Develop apps > Create an app
- Name your new app
- Select Configure Admin API scopes
- Tick all the scopes prefixed with
read_(e.g.read_locations,read_price_rules, etc ) and save. See below for the full list of scopes to allow. - Click Install app to give this app access to your data.
- Once installed, go to API Credentials to copy the Admin API Access Token.
Scopes Required for Custom App
Add the following scopes to your custom app to ensure Airbyte can sync all available data. To see a list of streams this source supports, see our full Shopify documentation.
read_analyticsread_assigned_fulfillment_ordersread_gdpr_data_requestread_locationsread_price_rulesread_product_listingsread_productsread_reportsread_resource_feedbacksread_script_tagsread_shippingread_localesread_shopify_payments_accountsread_shopify_payments_bank_accountsread_shopify_payments_disputesread_shopify_payments_payoutsread_contentread_themesread_third_party_fulfillment_ordersread_translationsread_customersread_discountsread_draft_ordersread_fulfillmentsread_gift_cardsread_inventoryread_legal_policiesread_marketing_eventsread_merchant_managed_fulfillment_ordersread_online_store_pagesread_order_editsread_orders
For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for Shopify.