Authentication OAuth Authorization Code Grant (3-legged) - RECOMMENDED

Description

Authenticate using OAuth 2.0 Authorization Code Flow (3-legged). Use this for apps built in the Dev Dashboard (https://dev.shopify.com). This is the primary OAuth flow supported for public apps and apps created in the Dev Dashboard.

Instructions

Method: OAuth Authorization Code Grant (3-Legged)

This method is for apps built in the Shopify Dev Dashboard. Use this if you are a Partner or developer building a multi-store integration.

Note: If you are connecting to your own single store, the Admin Access Token method is significantly simpler. Use this OAuth method only if your integration specifically requires a Client ID and Secret.

Part 1: Create and Configure App in Dev Dashboard

1. Log in to the Shopify Dev Dashboard using your Partner account.
2. Click Apps in the left menu, then click Create app.
3. Select Start from Dev Dashboard (manual setup) and give your app a name.
4. Step 1: Configure Scopes and URLs via "Versions"
   • Click the Versions tab at the top of the app screen.
   • Click Create version (or edit the Draft).
   • In the URLs section, enter https://zappysys.com/oauth into Allowed redirection URL(s).
   • Select your Admin API scopes based on which features you plan to use:
     • For Customers: read_customers, write_customers
     • For Orders: read_orders, write_orders
     • For Products: read_products, write_products
     • For Inventory: read_inventory, write_inventory
     • For Locations: read_locations
     • For Payouts/Analytics: read_all_orders or read_analytics

     Important: If you select fewer scopes than required, some connector features will not work. To ensure full functionality, select both read and write permissions for the resources you need to access.

   • Click Release (top right). Note: Settings only become active once a version is Released.
5. Step 2: Set Distribution Method
   • Click Distribution in the left-side menu.
   • Select Custom Distribution.
   • Enter your Shopify store URL (e.g., your-store.myshopify.com) and click Generate link.
   • Action Required: Copy the generated install link, open it in your browser, and follow the prompts to install/unlock the app for your store. You must complete this step before testing the connection in ZappySys.

Part 2: Get Client Credentials

6. Click on Settings in the left-side navigation of your app.
7. In the Client credentials section, copy the Client ID and Client Secret (click the eye icon to reveal).

Part 3: Configure the ZappySys Connector

8. Open the ZappySys connector and select OAuth Authorization Code Grant (3-legged).
9. Subdomain: Enter your store handle (the part before .myshopify.com).
10. Client ID / Secret: Paste the credentials from Steps 6 and 7.
11. Redirect URI: Enter https://zappysys.com/oauth.
12. Click Test Connection. You will be prompted to authorize the app in your browser.

Note on Tokens: Successful authorization generates an "Offline" Access Token (starting with shpca_). This token does not expire and does not require a refresh token.

Troubleshooting: If you see "App no longer available," ensure you have completed the Distribution step and followed the Install Link in Step 5 to unlock the app for your store.

Parameters