Docs/Shopify Partner API

Shopify Partner API Setup

Connecting the Partner API lets PartnerDock pull live subscription revenue from Shopify and show you affiliate-driven MRR, new MRR, average LTV per store, and total gross revenue — broken down by affiliate.

5 min · One-time setup

What you need

  • A Shopify Partners account at partners.shopify.com
  • Owner or admin access to that Partners account
  • Your app already listed in Shopify Partners
One token, all your apps. The Partner API token is set at the organization level in PartnerDock — you enter it once and it covers all apps in your account.

Step 1 — Create a custom app in Shopify Partners

PartnerDock accesses your revenue data via a custom app you create in your own Shopify Partners account. This gives you full control — you can revoke access at any time.

1
Go to partners.shopify.com and sign in.
2
In the left sidebar click Apps, then click Create app in the top-right corner.
3
Select Create app manually (not using the CLI).
4
Give it any name — e.g. PartnerDock Integration — and click Create app.
You don't need to fill in a URL or configure webhooks. This app is only used to generate an API access token.

Step 2 — Find your Partner Organization ID

Your Partner Organization ID is in the URL when you are logged in to Shopify Partners.

1
Look at the URL in your browser. It will look like:
https://partners.shopify.com/1234567/apps
2
The number after partners.shopify.com/ is your Organization ID. Copy it — you'll paste it into PartnerDock in Step 4.

Example

1234567

Step 3 — Generate an access token

1
Open the custom app you just created (Apps → your app name).
2
Click the API access tab.
3
Under Partner API client, click Generate access token.
4
Shopify will show you the token once. Copy it immediately — it will not be shown again.
The token looks like prtapi_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx. If you lose it, you can rotate it from the same screen and paste the new one into PartnerDock.

Step 4 — Enter credentials in PartnerDock

1
In PartnerDock, go to Settings → Partner API (left sidebar).
2
In the Partner Organization ID field, paste your Organization ID from Step 2.

What to enter

1234567 (just the number, or the full URL)

3
In the Partner API Access Token field, paste the token from Step 3.

What to enter

prtapi_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

4
Click Save credentials.
5
Once saved, enter your Shopify App ID for each app. This is the numeric ID of your app in Shopify Partners — found in the URL when you open your app:
https://partners.shopify.com/1234567/apps/9876543

App ID example

9876543

Step 5 — Run your first sync

1
After saving, click Sync now on the Partner API settings page, or from the Attribution Coverage section on your dashboard.
2
The first sync pulls up to 18 months of subscription history. This may take 30–60 seconds.
3
Once complete, your dashboard will show Affiliate-driven MRR, New MRR this month, Affiliate revenue, and Avg LTV / store.
Subsequent syncs are incremental (only the last few days) and run much faster. PartnerDock syncs automatically via a scheduled cron; you can also trigger a manual sync from your dashboard at any time.