Sales and tracking

Record a conversion for a campaign creator (website by default, or ios / android); idempotent on order_id and platform

POST/api/public/v1/affiliate_sales
LiveAnswers from your brand's records now.

Operation id createAffiliateSale

Request

curl

curl -X POST "https://creator.growthdept.ai/api/public/v1/affiliate_sales" \
  -H "Authorization: Bearer gdc_..." \
  -H "Content-Type: application/json" \
  -d '{"campaign_affiliate_id":"string","commission":3,"currency":"usd","customer_email":"creator@example.com","customer_name":"Example name","due_at":"2026-11-01T15:04:05Z","growi_campaign_id":1024,"growi_user_id":1024,"occurred_at":"2026-11-01T15:04:05Z","order_id":"string","platform":"website","sale_type":"one_time","sub_id":"string","subtotal":3,"total":3,"visitor_uid":"string"}'

Request body

FieldTypeNotes
campaign_affiliate_idstring
commissioninteger
currencystringrequiredOne of usdeurgbp
customer_emailstring (email)
customer_namestring
due_atstring (date-time)
growi_campaign_idinteger
growi_user_idinteger
occurred_atstring (date-time)
order_idstringrequired
platformstringOne of websiteiosandroid
sale_typestringOne of one_timesubscription
sub_idstring
subtotalinteger
totalinteger
visitor_uidstring

Example

{
  "campaign_affiliate_id": "string",
  "commission": 3,
  "currency": "usd",
  "customer_email": "creator@example.com",
  "customer_name": "Example name",
  "due_at": "2026-11-01T15:04:05Z",
  "growi_campaign_id": 1024,
  "growi_user_id": 1024,
  "occurred_at": "2026-11-01T15:04:05Z",
  "order_id": "string",
  "platform": "website",
  "sale_type": "one_time",
  "sub_id": "string",
  "subtotal": 3,
  "total": 3,
  "visitor_uid": "string"
}

Responses

201Success

FieldTypeNotes
dataobject
data.commissioninteger
data.currencystring
data.external_idstring
data.idinteger
data.occurred_atstring (date-time)
data.platformstringOne of websiteiosandroidshopify
data.statusstringOne of paiddueunpaidcanceledrefunded
data.sub_idstring
data.totalinteger

Example

{
  "data": {
    "commission": 3,
    "currency": "usd",
    "external_id": "string",
    "id": 1024,
    "occurred_at": "2026-11-01T15:04:05Z",
    "platform": "website",
    "status": "paid",
    "sub_id": "string",
    "total": 3
  }
}

Errors: 401422with an error and usually a message. See errors.

Example values are made up from each field's type and name.