Skip to main content

Install and Configure the Phoenix App in Shopify

To connect your Shopify store with Phoenix, you must create and configure a custom app inside your Shopify Admin.

All steps in this guide are completed inside your Shopify Admin.

This app allows Shopify and Phoenix to communicate securely and ensures the correct permissions are granted for the integration. Once configured and installed, the app generates the credentials required to complete the connection inside Phoenix.

This guide walks you through the full setup process, from creating the app to retrieving your store credentials.

Prerequisites​

Before you begin, ensure that you have:

  • Shopify Admin access.

  • The Phoenix configuration document, including the App URL and required API scopes.

Create the Phoenix App​

The first step is to create the custom Phoenix app inside Shopify. This app will later generate the credentials used to connect your store in Phoenix.

To create the app:

  1. Log in to your Shopify Admin.

  2. In the top search bar, type App development.

  3. From the dropdown results, select App development.

  4. Click Build apps in Dev Dashboard.

  5. Click Create app.

  6. Enter the app name exactly as provided by Phoenix (for example, PHX 3.0).

  7. Click Create.

After clicking Create, Shopify opens the Create a version screen. This is where you configure the app’s URL and permissions.

Configure Permissions and Secret Key​

Before the app can be activated, you must define how it connects to Phoenix and what permissions it will have inside your store.

In this step, you will enter the App URL and the API scopes provided in your Phoenix configuration document.

To configure the app:

  1. In the App URL field, paste the App URL provided in the Phoenix configuration document.

    App URL Accuracy

    Make sure the URL matches the document exactly. Even small differences can prevent Shopify and Phoenix from communicating correctly.

  2. In the Scopes field under the Access section, paste the complete list of API scopes provided in the Phoenix document.

    API Scope Validation

    Paste the scopes exactly as provided. They must appear as a properly formatted comma-separated list. If Shopify displays a validation message, review the list to confirm it is complete and correctly formatted.

  3. Click Release.

  4. Click Release again to confirm the configuration.

The first version of the Phoenix app is now active.

Add the Secret Key to a New Version​

After activating the initial version, you must generate and apply the secret key. This key allows Phoenix to authenticate securely with your Shopify store.

To add the secret key:

  1. Go to Settings inside the app.

  2. Locate the Secret key and click the copy icon.

  3. Go to Versions.

  4. Click Create version.

  5. In the App URL field that contains ?secret=, paste your copied secret immediately after the equal sign.

    Example format: https://your-phoenix-url.com?secret=YOUR_SECRET_KEY

    Secret Key Placement

    Keep the original URL unchanged and add the secret value directly after ?secret=.

  6. Click Release.

  7. Click Release again to activate the updated version.

Your Phoenix app configuration is now complete.

Install the App and Retrieve Credentials​

Installing the app activates it inside your Shopify store and generates the credentials required to complete the connection in Phoenix.

To install the app:

  1. Go to Home inside the app.

  2. Click Install app.

  3. Select your store.

  4. Click Install.

    After installation, the App Configuration screen displays your store connection details. When installation is successful, the status appears as Connected.

  5. Click the Load credentials icon.

  6. Verify that the following credentials are visible:

    • Admin Access Token

    • Storefront Access Token

    • App Secret (Client Secret)

These credentials will be entered during the Shopify APIs step when adding your store inside Phoenix.

Credential Security​

The credentials generated in Shopify provide authenticated access to your store.

  • Share credentials only through secure channels.

  • Store API keys and tokens in protected environments.

  • Limit access to authorized team members.

If you want to continue configuring your store and completing your Phoenix setup, review these guides: