Migrating from Mantle
The developer API is shaped to match Mantle’s app API on purpose: for most integrations the migration is a base URL and API key swap, not a rewrite.
What maps directly
Section titled “What maps directly”| You used | You now call | Changes |
|---|---|---|
| Mantle identify | POST /api/v1/identify |
Same concept; auth via X-Api-Key |
| Mantle usage events | POST /api/v1/usage_events |
Same field names (eventId, eventName, timestamp, customerId, properties) |
| Usage event reads | GET /api/v1/usage_events and /report |
Same query parameters (calculation, overProperty, period) |
| Mantle webhooks | Your existing handler | Header names and HMAC scheme match; update the signing secret |
Checklist
Section titled “Checklist”- Swap the base URL to
https://partnerconsole.co/api/v1and setX-Api-Keyto your app’s key from the console. - Replace the customer identifier with the shop’s myshopify domain (
customerIdaccepts it directly). - Re-point your webhook endpoints in the console and update the signing secret in your handler.
- Send one test identify and one test usage event, then confirm both appear on the customer’s page and in Behavior.
What works differently
Section titled “What works differently”- Custom fields can also be database-linked: instead of pushing computed fields, connect your app’s Postgres read-only and the console queries them on a schedule.
- Affiliate referral capture has three carriers (tracking script, GA4/BigQuery listing events, in-app codes); see the attribution guide.
- Revenue, subscriptions and lifecycle events never come through this API; the console derives them from the Shopify Partner API on its own.