Steps to Connect

Notes about the integration

Follow these steps to connect:

Simply follow the instructions at https://shopify.dev/docs/partner-api/getting-started to create your Access Token & organization ID:

We need all permissions ticked for the following reasons:

  • View financials - Everything in Shopify comes through as a “Transaction” - these resources are everything from subscription sales, to one-time charges, to fees, to tax charges.

  • Manage apps - Since there are no real “plans” in Shopify, we have to guesstimate at a plan name by combining the App name, the interval and the price. Without Manage apps we won’t be able to obtain the App name on each transaction (yes, the API is that restrictive)

  • Manage themes / Manage jobs -Similarly, in order to extract theme or job-specific fields from the transactions for one-time charges we need the Manage themes and Manage jobs permissions ticked too. The Shopify GraphQL API is very granular in terms of what it provides, so if we request all details of a transaction including the App name, but don’t have permissions to “Manage” apps, the API call fails and we can’t work out what to call the plan. Since Shopify’s GraphQL API is still in beta it’s entirely possible they might release read/view-only specific permissions in the future but as of now “Manage” is what they’re calling it. In addition, the GraphQL API currently only allows for read-only operations, so there’s no chance of us accidentally affecting any live data on Shopify’s platform.

When you are finished, you'll be able to connect here.

Please note: The API is stable but Shopify still considers it “in development”. As such it may well break at any time, but we will be monitoring it closely to ensure we can keep it skating along. 👍

Some helpful notes about the integration:

  • Some customers (usually from earlier years) are marked by Shopify as "REDACTED". Such customers are excluded from metrics.

  • Cancellation will happen once we get the Relationship uninstalled event.

  • We’re able to track installs "trials" within Trial Insights. This will be based on the RelationshipInstalled event and conversion is recognized at the AppSubscriptionSale event.

  • We populate the plan name from the item within Subscription Charge events.

  • We support Reactivations. This comes from the Relationship Reactivated event.

  • We support Refunds. This comes from the App Sale Adjustment event.

  • UsageCharge charges are not included in MRR. They are included in Other Revenue and Net Revenue.

  • Other Revenue also includes App One-time Sales.

  • In line with our other direct integrations, we do not remove Shopify's fees from MRR, Net Revenue, etc. You can view your fees (if any!) on the Fees Metric.

Did this answer your question?