Shopify Partner

The Shopify Partner API gives Shopify app developers and agencies the data behind their Partner Dashboard: who installs and uninstalls their apps, the charges merchants accept, and the earnings Shopify pays out. With Weld you can sync it into your data warehouse to report on installs, churn, MRR and payouts per app and per merchant.

This is a different connector from Shopify, which syncs a single store's orders, products and customers.

Features

Feature nameSupported
Column HashingTrueColumn level
BlockingTrueColumn level
IncrementalTrue
Custom dataFalse
HistoryTrue
ReSyncTrueTable level
TemplatesFalse

Data Schema


Setup Guide - ELT

Step 1 - Create a Partner API client

  1. In the Shopify Dev Dashboard, open your organization's settings and go to Users → Security → Partner API clients.
  2. Click Add Partner API client and give it a name, such as Weld.
  3. Grant the View financials permission (for the transactions table) and the Manage apps permission (for the apps and app_events tables).
  4. Save the client and copy its access token. Shopify only shows it once.

Step 2 - Find your Partner ID and app IDs

  • Your Partner ID is the number in your Partner Dashboard URL: partners.shopify.com/<Partner ID>. The organization ID shown in the Dev Dashboard is a different number and will not work.
  • Each app ID is the number in that app's Partner Dashboard URL. You only need these if you want to sync your apps' installs, uninstalls and charges.

Step 3 - Create the connection

  1. In the Weld app, click Data Sources in the sidebar, then Add Data Source.
  2. Search for Shopify Partner, select it and choose Create new connection.
  3. Give the connection a Name.
  4. Enter your Partner ID and paste the Partner API client access token.
  5. Optionally, enter the App IDs of the apps you want to sync, separated by commas.
  6. Click Connect to validate the token and establish the connection.

Step 4 - Data To Sync

Select the tables you wish to include in the sync. You can view the schema, remove columns or hash sensitive information.

  • Earnings — transactions: every Partner transaction, covering app subscription, one-time and usage sales, sale adjustments and credits, service and theme sales, referral commissions, and tax. Each row has its transaction type, the gross and net amounts, the Shopify fee, and the app and shop it relates to where there is one.
  • Apps — apps: the name and API key of each app you entered.
  • App activity — app_events: installs, uninstalls, subscription, one-time and usage charge events, and credits for each app you entered, with the shop they happened on.

Step 5 - Configure sync

  1. Select how often you would like the data to sync.
  2. Optionally choose a start date to limit how far back the initial sync of transactions and app_events goes. Without one, Weld syncs all available history.
  3. Check the Destination schema name, which is where the tables land in your warehouse, and click Start Initial Sync.

Weld will take over from here and commence syncing data from your Shopify Partner account.

Was this page helpful?