Shopify Partner
Overview
Pre-built tooling
✅ Authorization
| Tools | Status |
|---|---|
| Pre-built authorization (API Key) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | ✅ |
| Expired credentials detection | ✅ |
✅ Read & write data
| Tools | Status |
|---|---|
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Tenklo on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) |
| Proxy requests | ✅ |
✅ Observability & data quality
| Tools | Status |
|---|---|
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
✅ Customization
| Tools | Status |
|---|---|
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: <48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) |
| Per-customer configurations | ✅ |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
get-active-subscription | Retrieve the active recurring/usage subscription for an app on a shop. | Action | 🔗 Github |
get-public-api-versions | List the Partner API versions supported by this account. | Action | 🔗 Github |
list-app-events | List historical events for a single known Partner app. | Action | 🔗 Github |
list-events | List Partner account events across apps and shops with filters. | Action | 🔗 Github |
list-transactions | List Partner transactions with cursor pagination and filters. | Action | 🔗 Github |
query-partner-data | Run a constrained Partner API GraphQL query for cases the typed actions do not cover. | Action | 🔗 Github |
events | Sync Partner account events (installs, charges, credits, earnings, subscription status changes). | Sync | 🔗 Github |
transactions | Sync Partner transactions. | Sync | 🔗 Github |
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| Shopify Partner Account | ✅ | Required to access the Partner API |
| Partner API Client Access Token | ✅ | Required for authentication |
| Partner ID | ✅ | Required for API access |
Setup guide
Step 1: Get Your Partner ID
- Log in to your Shopify Partner account
- Your Partner ID is the number in the URL when you're on your partner home page:
https://partners.shopify.com/1234567- For example, if your URL is
https://partners.shopify.com/1234567, your Partner ID is1234567
- For example, if your URL is
Step 2: Create a Partner API Client
- Go to your Partner API Clients page:
https://partners.shopify.com/{your-partner-id}/settings/partner_api_clients - Click "Create API client"
- Give your API client a name (e.g., "Tenklo Integration")
- Select the necessary permissions for your integration
- Click "Create API client"
- Copy the generated API client access token - you'll need this for the next step
Step 3: Create the Integration in Tenklo
- Go to the Tenklo dashboard
- Navigate to the Integrations tab
- Click "Add Integration"
- Select "Shopify Partner" from the list
- Enter your:
- Partner ID (from Step 1)
- Partner API Client Access Token (from Step 2)
Step 4: Create a Connection
- Go to the Connections tab
- Click "Add Connection"
- Select your Shopify Partner integration
- Complete the connection setup
Connection configuration in Tenklo
Shopify Partner requires two pieces of information for authentication:
- Partner ID
- Partner API Client Access Token
API gotchas
- The Partner ID must be included in the API URL path
- All requests require the X-Shopify-Access-Token header
- The API version in the URL must match the version you're targeting (e.g. 2025-04)
Useful links
Going further
Connect to Shopify Partner
Guide to connect to Shopify Partner using Connect UI