Skip to article
steward.Guides

Connect Shopify

Connect your Shopify store with a customer-owned app, detect its access, and enable it for your team.

Shopify connection form showing the canonical store address and protected Client ID and Client secret fields.
Choose Shopify, use the myshopify.com store address, and enter credentials from your installed app. Example workspace · Select image to enlarge.

Before you start

You need workspace owner or administrator access in Steward and permission to create and install apps in Shopify. Use a customer-owned app in the Shopify Dev Dashboard. The app and store must belong to the same Shopify organization for Client ID and secret authentication.

Have the store’s canonical address ready, such as your-store.myshopify.com. A custom storefront domain does not identify the Admin API destination.

Create and install the Shopify app

See Prepare your Shopify app for the real dashboard controls.

  1. Open the Shopify Dev Dashboard, select the organization that owns the store, and open Apps.
  2. Select Create app and choose the dashboard option. Give the app a recognizable name, such as “Steward connection”.
  3. Configure its API access scopes for the tasks you want Steward to perform. Start with the access you need. Use the task-to-scope table.
  4. Select Create app, review the Release version confirmation, and select Release. For an existing app, save and release the changed version. Changes to scopes must be released before they can be granted.
  5. Open Install app, choose the intended store, and confirm the access in Shopify. Scope changes can require updating the installation.
  6. Open App settings → Credentials and find Client ID and Client secret. They also appear on the app’s Overview. Keep these credentials private. Enter them directly in the protected connection fields in Steward.

See Shopify’s client credentials requirements if Shopify reports shop_not_permitted.

Connect and test in Steward

  1. Open Settings → Connections → Connect a tool.
  2. Choose Shopify.
  3. Enter a recognizable Connection name and the Shopify store address.
  4. Keep Client ID and secret (recommended) selected. Enter the Client ID and Client secret from the installed app.
  5. Select Connect Shopify. Steward checks the store identity and installed app scopes. It stores credentials privately and renews access tokens automatically.
  6. On the connection card, select Test when you want to check access again. Expand Granted Shopify access to see detected scopes.

If you already have a suitable Admin API token for this store, choose Existing Admin API token instead. Tokens in this mode are replaced manually when necessary. Saved credentials are never displayed back to you.

Enable project and team access

Enable the connection for a project, then invite colleagues to that project with the appropriate project role. They can use the configured connection without a separate connection grant.

The chat mode controls execution, while your project role controls what you can do. Read only prevents business-tool changes. Ask for approval requires a Manager’s decision. Automatic permits supported changes for Contributors and Managers unless an approval rule requires review. Choosing a mode never changes project access.

Change credentials or scopes

Someone with Configure access can select the pencil button at the top right of the connection card. Leave credential fields blank to keep saved credentials, or enter a complete replacement. Save and test again.

To add Shopify access, configure and release the app’s scopes in Shopify, update its installation, then select Test in Steward. See access and limitations and connection troubleshooting.

Real Shopify Dev Dashboard Release version confirmation showing the verification app name, version name, optional description and Release button.
Review the configured app version before selecting Release. This capture contains only the actual confirmation controls for a development app. Shopify Dev Dashboard · Select image to enlarge.
Real Shopify Dev Dashboard Installs panel with the Install app button and development-store testing instructions.
Open Install app from the app’s Overview, then choose the intended development store and review its requested access. Shopify Dev Dashboard · Select image to enlarge.
Real Shopify App settings Credentials panel showing Client ID, a masked Client secret, copy controls and the secret reveal control. Credential values are hidden.
Find credentials in App settings → Credentials. The Client ID has been redacted and Shopify keeps the Client secret masked. Keep both values private. Shopify Dev Dashboard · Select image to enlarge.