Skip to main content

Setup Guide

This guide walks you through creating a Shopify development store and obtaining the Admin API access token required to use the Shopify Admin connector.

Prerequisites​

Step 1: Sign up for a Shopify developer account​

  1. Create a Shopify account via the Shopify signup portal.

    Shopify signup page

  2. Join the Shopify Partner Program to access development tools.

    Shopify partner program

Step 2: Create a new organization​

  1. In the Shopify Partner Dashboard, connect to an existing organization or create a new one.

    New organization

  2. Select your main focus as a Shopify partner and follow the on-screen instructions.

    Main focus as Shopify partner

  3. Provide business contact details and finalize the setup.

    Business contact information

Step 3: Create a development store​

  1. In the Shopify Partner Dashboard, select Stores in the left navigation.

    Stores section

  2. Select Create store to proceed.

    Create store

  3. Complete the store setup by following the on-screen instructions.

    Store configuration

note

A development store is free and intended for testing and development purposes.

Step 4: Create a new app​

  1. In your store admin, select Settings.

    Settings

  2. Go to the Apps section and select Develop apps.

    Apps section

  3. Select Allow custom app development.

    Develop apps

  4. Select Create an app, enter an app name, and confirm.

    Create app

Step 5: Generate an access token​

  1. Once the app is created, select Configure Admin API scopes and apply the scopes required for your use case (for example, read_products, write_orders).

    Configure Admin API scopes

  2. Select Install app to generate an Admin API access token.

    Install app

  3. Select Reveal token once to copy and save the token securely.

    Reveal access token

warning

The access token is shown only once. Copy it immediately and store it securely. Do not commit it to source control. Use Ballerina's configurable feature and a Config.toml file to supply it at runtime.

Step 6: Get your store URL​

Your store URL follows this pattern:

https://<your-store-name>.myshopify.com

You can find it in the browser address bar when viewing your Shopify admin dashboard.

What's next​