Attribute a referral

POST/api/v1/attribution

Credits an install to the affiliate whose referral code the merchant carried. Attribution is first-touch under a per-install lock: the first affiliate to claim a shop keeps it, and every submission is logged to the shop’s referral trail either way.

A winning attribution backfills commissions from the shop’s transaction history per the program’s rules. Safe to call more than once; repeating the same winning pair just refreshes the referral date.

Body parameters

appstringrequired: Your app’s slug.
myshopifyDomainstringrequired: The installing shop.
mrefstringrequired: The referral code, from the tracking script or a typed partner code.

Returns

200attributed: true when the code won; false with a reason of already attributed or unknown code otherwise.

400A required field is missing.

401Bad or missing X-Api-Key.

Request

curl -X POST \
  https://partnerconsole.co/api/v1/attribution \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app": "your-app-slug",
    "myshopifyDomain": "example.myshopify.com",
    "mref": "acme-agency"
  }'

const res = await fetch(
  'https://partnerconsole.co/api/v1/attribution',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': process.env.PC_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      app: 'your-app-slug',
      myshopifyDomain: shop.domain,
      mref: referralCode,
    }),
  },
);
const {attributed} = await res.json();

import os, requests

res = requests.post(
    "https://partnerconsole.co/api/v1/attribution",
    headers={
        "X-Api-Key": os.environ["PC_API_KEY"],
    },
    json={
        "app": "your-app-slug",
        "myshopifyDomain": shop.domain,
        "mref": referral_code,
    },
    timeout=10,
)
attributed = res.json()["attributed"]

Response · 200

{
  "attributed": true,
  "affiliateEmail": "[email protected]",
  "reason": null
}