Shopify Query Authentication Guide
    • Dark
      Light

    Shopify Query Authentication Guide

    • Dark
      Light

    Article Summary

    Overview

    This is a step-by-step guide to acquiring credentials and authorizing the Shopify Query connector for use in Matillion ETL. Please note, this process partly involves creating a Custom App for your store. Previously, you were required to create Private Apps, which are now replaced by Custom Apps. Your existing Private Apps are still available for use. Refer to your Shopify administrator for more information.

    Note
    • The Shopify Query connector uses an API token for third-party authentication.
    • Please ensure an active MyShopify shop is already available to source data from.
    • While connector properties may differ between cloud data warehouses, the authentication process remains the same.

    Acquiring Third-Party Credentials

    1. Navigate to the Shopify website. Click Log in on the right of the header menu.

    2. Log in with your email address, also referred to as your Shop URL, and password. The browser will then redirect to a sequence of login screens beginning with choosing the Store you want to use. If you don't have a suitable store, you can create one now.

    Note

    This shop address URL used to login here will also be required in Authorizing for use in Matillion ETL.

    Provide Store address

    1. Once logged in, click Apps on the sidebar on the left, then select App and sales channel settings from the expanded menu at the top of the page.

    App settings

    1. On the Apps and sales channels page, click Develop apps at the top of the page.

    2. On the App development page, click Create an app.

    3. Provide details for the following fields and click Create app:

      • App name: provide a unique and descriptive name for the app.
        • App developer: choose the appropriate developer from the drop-down menu.

    Create an app

    1. You will be taken to the App development page for your app. Click Configure Admin API scopes to begin.

    App development

    1. Select the appropriate scopes for the app, then click Save.

    2. Click Install app at the top-right of the page, then click Install when prompted to confirm.

    3. On the API credentials page, make a note of the API key, as this will be required to configure authentication in Matillion ETL.

    API credentials

    1. Select the Configuration tab and click Configure in the Admin API integration section.

    2. Select the appropriate Admin API access scopes for the app then click Save.

    13. Switch back to the API credentials tab and make a note of the Admin API access token. Please note, you can only reveal the token once, so ensure you record it safely for future reference.

    API access token


    Authorizing for Use in Matillion ETL

    1. If a Shopify Query connector isn't already on the job canvas, search "Shopify" using the Components search field, or find the Shopify Query connector under OrchestrationLoad/UnloadInternet.
    Note

    An orchestration job must be open on the job canvas within Matillion ETL to ensure the Shopify Query connector is searchable within the Components panel.

    1. Then, click and drag the Shopify Query connector onto the job canvas.

    2. Click the connector icon on the job canvas to open the Properties panel at the bottom of the screen, then click ... next to the Shop URL property.

    Configure App Id in Properties

    1. In the Shop URL dialog, paste the Shop URL (used to log into the Shopify website) and click OK.

    2. Next, click ... next to the App Id property. Then, in the App Id dialog, paste the API key (copied from the Shopify website earlier) into the field provided and click OK.

    3. Finally, click ... next to Password property. Then, in the Password dialog, paste the Admin API access token (copied from the Shopify website earlier) into the Store in component field and click OK. Alternatively, click Manage and create a password entry in Manage Passwords and then click the Use Password Manager radio button and select your new entry from the dropdown.

    Paste password

    1. If the App Id is entered correctly, the connector should be authenticated and the status of all properties will be displayed as OK.