Connecting the Shopify Partner API

Connecting the Shopify Partner API lets Convot pull your merchants’ subscription data and lifecycle events. Once connected, you’ll see a merchant’s plan, MRR, and install/uninstall history right next to every conversation.

The integration is read-only. Convot never writes to your Shopify account.

Before you start

You need:

• A Shopify Partner account with at least one published app.
• The Owner role in your Convot organization (only owners can connect integrations).

Step 1 - Find your Partner Organization ID

1. Open your Shopify Partner Dashboard.
2. Look at the URL in your browser: partners.shopify.com/1234567/...
3. The number in the URL is your Partner Organization ID. Copy it.

Step 2 - Create a Partner API client

1. In the Partner Dashboard, go to Settings → Partner API clients.
2. Click Manage Partner API clients, then Create API client.
3. Give it a name such as “Convot”.
4. Enable both:
   • Manage apps - for install and churn events.
   • Manage financials - for revenue transactions.
5. Save and copy the access token. It starts with prtapi_. Store it somewhere safe; you won’t see it again.

The token is displayed only once. If you lose it, delete the client and create a new one.

Step 3 - Connect in Convot

1. Go to Settings → Integrations → Shopify.
2. Enter your Partner Organization ID and Partner API Access Token.
3. Click Connect.

Convot validates the token immediately. If validation passes, the connection shows as Connected and an initial sync begins in the background.

After connecting: add your apps

Once connected, Convot discovers your apps from the first transaction it syncs. You’ll see them listed under Your Apps on the same settings page, grouped as Auto-discovered.

If an app doesn’t appear automatically, you can add it manually:

1. Find the app’s GID in the Partner Dashboard (it looks like gid://partners/App/4436393).
2. Paste it into the App ID field on the Shopify settings page and click Add app.

How syncing works

Convot syncs your Shopify data on a background schedule (roughly every 4 minutes for healthy connections). You can also trigger an immediate sync at any time with the Sync now button on the settings page.

If the sync encounters an error (an expired token, for example), it retries automatically. After several consecutive failures it marks the connection as error and stops retrying until you reconnect. The settings page shows the last synced time and any error state.

Disconnecting

Click Disconnect on the settings page. Your historical sync data is preserved. You can reconnect at any time.

Troubleshooting

“Token is invalid or expired” - the token was revoked or you copied it incorrectly. Create a new API client in the Partner Dashboard and reconnect.

“Missing scope” - the token was created without the “Manage financials” permission. Regenerate a token with both required permissions.

No apps appear after syncing - if your apps have no transactions yet, auto-discovery won’t find them. Add the app GID manually as described above.