sdk
Returns the affiliate public information
get/sdk/affiliate
Query parameters
Returns affiliate by referral code
Returns affiliate by coupon code
fieldsstring[] required
Comma separated list of fields to return. See Affiliate Schema to get list of available fields
Response
Example response
{
"affiliate": {
"id": 1,
"name": "John Doe",
"avatar": {},
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com",
"ref_code": "hs692n62d",
"ref_codes": [
"referralcode"
],
"coupon": {
"code": "JOHN10OFF",
"discount_value": 10,
"discount_type": "percentage"
},
"coupons": [
{
"code": "JOHN10OFF",
"discount_value": 10,
"discount_type": "percentage"
}
],
"phone": "1 888 (999) 1234",
"address_1": "Address line 1",
"city": "City",
"state": "State",
"country": "US",
"zip_code": "121323232",
"tax_identification_number": "788-21-1122",
"comments": "Private comment",
"personal_message": "Message to the affiliate",
"payment_method": "paypal",
"payment_details": {
"paypal_email": "jdoe@paypal.com"
},
"commission": {
"type": "percentage",
"amount": 10,
"on": "product"
},
"group_id": 10
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.