Skip to main content
Last updated on

Configure authentication to Shopify

Beta

This feature is in Beta. To use it, a workspace admin must turn on Lakeflow Connect for Shopify from the Previews page. See Manage Databricks previews.

This page shows how to configure Shopify to enable authentication from Databricks for the Shopify connector. Use the credentials retrieved from the steps on this page to create a Unity Catalog connection in Databricks.

Prerequisites​

  • A Shopify store. The Shopify Admin API is available on all Shopify plans. See the Shopify Admin API overview.
  • A Shopify app that is authorized for the read scopes that the connector requires. For the full list of scopes per table, see Required access scopes.
  • To ingest orders and order-derived tables older than 60 days, the app also needs the read_all_orders scope, which Shopify grants by approval. Without it, the connector ingests only orders from the last 60 days.
  • To ingest the balance_transactions and disputes tables, set up Shopify Payments on the store. See Shopify Payments.
  • Some customer and order fields are protected customer data. Shopify returns these fields from non-development stores only after the app meets the protected customer data requirements. See the Shopify access scopes reference.

Configure Shopify​

The Shopify connector authenticates with the Shopify OAuth client credentials grant. In this step, create an app in the Shopify Dev Dashboard, authorize it for the required scopes, install it on the store, and note the Client ID and Client secret for the connection page. For more information, see the Shopify client credentials grant reference.

  1. Sign in to the Shopify Dev Dashboard.
  2. Create an app.
  3. On the app's version, select the access scopes that the tables you ingest require. See Required access scopes.
  4. Install the app on the store you want to ingest from. The app and the store must belong to the same Shopify organization.
  5. Open the app, go to Settings, then copy the Client ID and Client secret.
  6. Note the store subdomain, which is the <shop> in <shop>.myshopify.com.

Use the store subdomain, Client ID, and Client secret to create a Unity Catalog connection in Databricks.

Next steps​

Create a Shopify connection in Databricks. See Create a Shopify connection.

On this page