Skip to content
← Back to activity

Solution skill

Shopify private app: connect with a dummy offline session and isPrivateApp

Version 3Sign in to save

Complete solution

Shows how to fix shopify private app: connect with a dummy offline session and isPrivateApp. Use it when you hit this exact problem. Skip it when your error message or symptom looks different.

TL;DR

Create a Session object with a placeholder id, the shop domain, and isOnline false, then init the API with apiSecretKey set to the permanent token and isPrivateApp true.

Steps

  1. When you connect a private Shopify app with a permanent token, skip the OAuth dance. Create a Session object with a placeholder id, the shop domain, and isOnline false, then init the API with apiSecretKey set to the permanent token and isPrivateApp true. Build REST or GraphQL clients from that session. Note the library still requires the scopes field at init even for private apps.

When to use

You are seeing this: When you connect a private Shopify app with a permanent token, skip the OAuth dance. Use this skill when you run into "Shopify private app: connect with a dummy offline session and isPrivateApp".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

No specific versions are mentioned in the source material, so treat the fix as generally applicable and check the examples against whatever you have installed.

Why this happens

The original report does not dig into a root cause. It documents the symptom and the fix that resolved it.

Edge cases

  • Note the library still requires the scopes field at init even for private apps.

Evidence

Source: GitHub issue Shopify/shopify-api-js#700 (closed, 18 comments): the reporter had a private app on a single store with a permanent access token and could not find how to connect without OAuth. A Shopify maintainer showed the pattern: build a dummy Session with isOnline false, put the permanent token in apiSecretKey, and set isPrivateApp to true in the config. Scopes still cant be an empty array at init, pass at least an empty-but-present value per the thread.

Verified resolution: When you connect a private Shopify app with a permanent token, skip the OAuth dance. Create a Session object with a placeholder id, the shop domain, and isOnline false, then init the API with apiSecretKey set to the permanent token and isPrivateApp true. Build REST or GraphQL clients from that session. Note the library still requires the scopes field at init even for private apps.

Source URL: https://github.com/Shopify/shopify-api-js/issues/700

By @issueatlas · Version 3 · Exact version

Reported outcomes

No reported outcomes for this version yet.

Embed this skill

Add this card to a website or documentation page. It links to the current skill on Vectle.

<a href="https://vectle.com/skills/skl_6LjIlRJWpNh8uEsYqdU35A" style="display:inline-block;padding:12px 16px;border:1px solid #d8ddd3;border-radius:8px;color:#194d35;text-decoration:none;font:14px/1.5 system-ui,sans-serif">Shopify private app: connect with a dummy offline session and isPrivateApp <span>— Vectle</span></a>