Affilae logo
API docs by Redocly

Affilae API Reference (v4.3.9)

Support: support@affilae.com URL: https://affilae.com

Overview

All public routes are detailed on this page.
Our API is under development and breaking changes may happen on public endpoints. In that case a new API version will be deployed.
Our API returns JSON-encoded response and uses standard HTTP response codes.
Affilae API is available for Advertisers and Publishers.

Authentication

You must send a Token in the Authorization Header when making requests.
Your Token is available from the API Tokens menu. Your Token is a sensitive credentials.
curl --header 'Authorization: Bearer {YOUR_TOKEN}' https://rest.affilae.com/

Notes

  • API endpoint: https://rest.affilae.com
  • API IDs are represented as a 24 character hex string e.g. 5e2f79800000000000000000.
  • API IDs (e.g. program ID / profile ID / user ID) can be retrieved from `*.me` (e.g. https://rest.affilae.com/advertiser/advertisers.me or https://rest.affilae.com/publisher/publishers.me) or `*.list` routes
  • All monetary amounts are sent/returned in cents, i.e. 100 equals to 1.00.
  • Datetime values sent must be in UTC (YYYY-MM-DDTHH:mm:ss.sssZ) and are returned in UTC.
  • No Sandbox is provided yet.
  • Endpoints are subject to rate limit (100 req/s) and may return a 429 status code (Too Many Requests).

Rate Limit Headers

    HeaderDescription
    x-ae-ratelimit-route-second-limitMaximum number of requests per duration (e.g. 100)
    x-ae-ratelimit-route-second-resetDuration in seconds (e.g. 1)
    x-ae-ratelimit-route-second-remainingNumber of requests remaining for the current duration (e.g. 42)
    x-ae-ratelimit-route-second-consumedNumber of requests already used for the current duration (e.g. 58)
    x-ae-ratelimit-route-second-retry-afterNumber of seconds to wait before retrying after a rate-limiter failure (e.g. 0)

advertiser

Ads information

query Parameters
id
required
string

Ad ID

program
required
string

Program ID

affiliateProfile
required
string

Affiliate Profile ID

Responses

Ads list

query Parameters
program
required
string
Default: "EXAMPLE"

Program ID

type
string
Enum: "image" "text" "email" "coupon" "other"
status
string
Enum: "active" "inactive" "planified"
affiliateProfile
string

Affiliate Profile ID

search
string

Responses

Advertiser Information

Get detailed account information:
• Advertiser ID.
• Program IDs.
• Rule IDs.
• Group IDs.
• User IDs.

Responses

Cappings list

query Parameters
program
required
string

Program ID

Responses

Clicks list

query Parameters
orderBy
string
Default: "createdAt"
Value: "createdAt"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 1000
Default: 20
offset
number >= 0
Default: 0
program
required
string

Program ID

from
string <date>
to
string <date>
partnership
string

Partnership ID

affiliateProfile
string

Affiliate Profile ID

capped
boolean

Responses

Conversion info

query Parameters
program
required
string

Program ID

externalId
string
customerId
string

Responses

Conversions list

query Parameters
orderBy
string
Default: "createdAt"
Enum: "externalId" "createdAt" "amount" "commissions"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 10000
Default: 100
offset
number >= 0
Default: 0
from
string <date>
to
string <date>
program
string

Program ID

rule
string

Rule ID

partnership
string

Partnership ID

ad
string

Ad ID

status
string
Enum: "pending" "refused" "accepted"
locked
boolean
externalId
string

Advertiser external ID

customerId
string
payment
string
subId
string

Conversion SubId

contributionSubId
string

Click SubId

capped
boolean
attribution
Array of strings
Default: "all"
Items Enum: "all" "share" "last" "first" "bonus" "api" "manual"
currencies
Array of strings
Items Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XBT" "XCD" "XDR" "XFU" "XOF" "XPD" "XPF" "XPT" "XTS" "XXX" "YER" "ZAR" "ZMW"
hasProductsSearch
boolean

Responses

Feed list

query Parameters
program
required
string

Program ID

Responses

Partnerships KPIs

query Parameters
programs
Array of strings

Program ID(s)

from
required
string <date>

YYYY-MM-DDTHH:mm:ss.sssZ

to
required
string <date>

YYYY-MM-DDTHH:mm:ss.sssZ

metric
required
string
Enum: "impressions" "clicks" "conversionsCPL" "conversionsCPA" "conversionsTotal" "commissionsTotal" "commissionsSubId" "commissionsCPC" "commissionsAvg" "EPC" "revenue"
status
string
Enum: "pending" "refused" "accepted"

Accepted and Pending by default

currency
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XBT" "XCD" "XDR" "XFU" "XOF" "XPD" "XPF" "XPT" "XTS" "XXX" "YER" "ZAR" "ZMW"

Responses

Partnerships list

query Parameters
orderBy
string
Default: "createdAt"
Enum: "createdAt" "name"
sort
string
Default: "desc"
Enum: "asc" "desc"
program
string

Program ID

groups
Array of strings

Group ID(s)

name
string
affiliateProfiles
Array of strings

Partnership ID

status
Array of strings
Items Enum: "interested" "pending" "approved" "cancelled_advertiser" "cancelled_publisher" "blocked" "inactive"
types
Array of strings
Items Enum: "blog" "community" "app" "review" "comparator" "coupon" "cashback" "emailer" "facebook" "tiktok" "twitter" "youtube" "instagram" "media" "other"
active
boolean
hasCustomRules
boolean
hasProductSearchOrigin
boolean
search
string

Responses

Products list

query Parameters
programs
Array of strings

Program ID

status
string
Enum: "enabled" "disabled"
search
string

Responses

Program List

query Parameters
status
Array of strings
Items Enum: "pending" "enabled" "paused" "deleted"
search
string
limit
number [ 0 .. 200 ]
offset
number >= 0

Responses

Vouchers list

query Parameters
orderBy
string
Default: "createdAt"
Enum: "createdAt" "name" "code" "expirationDate"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 1000
Default: 20
offset
number >= 0
Default: 0
program
string

Program ID

partnership
string

Partnership ID

blacklisted
boolean
search
string
status
string
Enum: "active" "inactive"

Responses

Product requests list

query Parameters
programs
Array of strings

Program ID

product
string

Product ID

status
Array of strings
Items Enum: "request_pending" "request_accepted" "request_refused" "review_published" "review_refused"
search
string

Responses

Conversion accept

Request Body schema: application/json
program
required
string

Program ID

id
required
string

Conversion ID

Responses

Request samples

Content type
application/json
{
  • "program": "5e336e000000000000000000",
  • "id": "5e336e000000000000000000"
}

Conversion Add

There are three ways to add a conversion: tracking OR bonus OR manual.
• The tracking mode relies on Client IP provided to retrieve contributors and generate a conversion’s funnel or click IDs.
• The bonus mode gives a commission bonus to the partnership provided.
• The manual mode provides a way to push a conversion for a dedicated Affiliate via affiliateTrackingId key.

Request Body schema: application/json
kind
required
string (kind)
Enum: "tracking" "bonus" "manual"

Conversion mode to apply.

program
required
string

Program ID

rule
required
string

Rule ID

externalId
required
string

Unique identifier of the conversion

amount
integer >= 0

Amount of the conversion in cents excluding tax

paymentMethod
string
customerId
string

Customer ID if rule has revenue share

date
string <date>

Date of the conversion, if not set current time will be used

subId
string
Default: ""
voucher
string
Default: ""

Voucher code if any

currency
string (currency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XBT" "XCD" "XDR" "XFU" "XOF" "XPD" "XPF" "XPT" "XTS" "XXX" "YER" "ZAR" "ZMW"
cids
Array of strings (cids)

Optional, is required ONLY when tracking mode is used, an array of Clicks IDs

ip
required
string

IP v4 or v6 is required ONLY if tracking mode is used.

partnership
required
string

Partnership ID is required ONLY when bonus mode is used.

bonus
required
number

Optional, is Required ONLY when bonus mode is used, amount of the Bonus in cent

affiliateTrackingId
integer

Optional, is Required ONLY when manual mode is used, affiliate tracking ID e.g. if #ae1 then value will be 1

notify
boolean
Default: true

Send notification to publisher

Responses

Request samples

Content type
application/json
{
  • "kind": "tracking",
  • "program": "5e336e000000000000000000",
  • "rule": "5e336e000000000000000000",
  • "externalId": "OrderID#001",
  • "amount": "1000",
  • "paymentMethod": "online",
  • "customerId": "CUS001",
  • "date": "2020-03-01T00:00:00.000Z",
  • "subId": "Conversion SubId",
  • "voucher": "Voucher001",
  • "currency": "EUR",
  • "cids": [
    ],
  • "ip": "127.0.0.1",
  • "partnership": "5e336e000000000000000000",
  • "bonus": 0,
  • "affiliateTrackingId": "12",
  • "notify": true
}

Conversion refuse

Request Body schema: application/json
program
required
string

Program ID

id
required
string

Conversion ID

reason
required
string

Responses

Request samples

Content type
application/json
{
  • "program": "5e336e000000000000000000",
  • "id": "5e336e000000000000000000",
  • "reason": "string"
}

Update conversion amount

Request Body schema: application/json
id
required
string

Conversion ID

amount
required
integer >= 0

Amount of the conversion in cents excluding tax

reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "5e336e000000000000000000",
  • "amount": "1000",
  • "reason": "string"
}

Partnership accept

Request Body schema: application/json
partnership
required
string

Partnership ID

Responses

Request samples

Content type
application/json
{
  • "partnership": "5e336e000000000000000000"
}

Partnership block

Request Body schema: application/json
partnership
required
string

Partnership ID

reason
string [ 1 .. 250 ] characters

Responses

Request samples

Content type
application/json
{
  • "partnership": "5e336e000000000000000000",
  • "reason": "string"
}

Partnership cancel

Request Body schema: application/json
partnership
required
string

Partnership ID

reason
string [ 1 .. 250 ] characters

Responses

Request samples

Content type
application/json
{
  • "partnership": "5e336e000000000000000000",
  • "reason": "string"
}

Payment Requests list

Request Body schema: application/json
program
required
string

Program ID

partnership
string

Partnership ID

from
string
to
string
status
string (status)
Enum: "pending" "refused" "accepted" "paid" "scheduled"
currency
string (Model8)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XBT" "XCD" "XDR" "XFU" "XOF" "XPD" "XPF" "XPT" "XTS" "XXX" "YER" "ZAR" "ZMW"
filter
string

Responses

Request samples

Content type
application/json
{
  • "program": "5e336e000000000000000000",
  • "partnership": "5e336e000000000000000000",
  • "from": "2020-03-01T00:00:00.000Z",
  • "to": "2020-03-01T00:00:00.000Z",
  • "status": "pending",
  • "currency": "AED",
  • "filter": "string"
}

Product delete

Request Body schema: application/json
id
required
string

Product ID

Responses

Request samples

Content type
application/json
{
  • "id": "5e336e000000000000000000"
}

Product disable

Request Body schema: application/json
id
required
string

Product ID

Responses

Request samples

Content type
application/json
{
  • "id": "5e336e000000000000000000"
}

Product enable

Request Body schema: application/json
id
required
string

Product ID

Responses

Request samples

Content type
application/json
{
  • "id": "5e336e000000000000000000"
}

Program delete

Request Body schema: application/json
program
required
string

Responses

Request samples

Content type
application/json
{
  • "program": "5e336e000000000000000000"
}

Program enable

Request Body schema: application/json
program
required
string

Program ID

Responses

Request samples

Content type
application/json
{
  • "program": "5e336e000000000000000000"
}

Program pause

Request Body schema: application/json
program
required
string

Program ID

Responses

Request samples

Content type
application/json
{
  • "program": "5e336e000000000000000000"
}

Voucher add

Request Body schema: application/json
codes
required
Array of strings (codes)
partnerships
Array of strings (partnerships)

Partnership ID

blacklisted
boolean
Default: false
expirationDate
string <date>

Expiration Date

Responses

Request samples

Content type
application/json
{
  • "codes": [
    ],
  • "partnerships": "5e336e000000000000000000",
  • "blacklisted": false,
  • "expirationDate": "2019-08-24"
}

Voucher delete

Request Body schema: application/json
ids
required
Array of strings (ids)

Voucher IDs

Responses

Request samples

Content type
application/json
{
  • "ids": "5e336e000000000000000000"
}

Voucher update

Request Body schema: application/json
id
required
string

Voucher ID

partnership
string

Partnership ID

name
string
code
string
expirationDate
string <date>

Expiration Date

blacklisted
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "id": "5e336e000000000000000000",
  • "partnership": "5e336e000000000000000000",
  • "name": "string",
  • "code": "string",
  • "expirationDate": "2019-08-24",
  • "blacklisted": false
}

Product request accept

Request Body schema: application/json
productRequest
required
string

Product Request ID

Responses

Request samples

Content type
application/json
{
  • "productRequest": "string"
}

Product request refuse

Request Body schema: application/json
productRequest
required
string

Product Request ID

reason
required
string

Responses

Request samples

Content type
application/json
{
  • "productRequest": "string",
  • "reason": "string"
}

publisher

Ads information

query Parameters
id
required
string

Ad ID

program
required
string

Program ID

affiliateProfile
required
string

Affiliate Profile ID

Responses

Ads list

query Parameters
affiliateProfile
required
string

Affiliate Profile ID

type
string
Enum: "image" "text" "email" "coupon" "other"
status
string
Enum: "active" "inactive" "planified"
program
string

Program ID

search
string

Responses

Affiliate Profile information

query Parameters
affiliateProfile
required
string

Affiliate Profile ID

Responses

Affiliate Profiles list

query Parameters
search
string
limit
number [ 0 .. 200 ]
offset
number >= 0

Responses

Clicks list

query Parameters
orderBy
string
Default: "createdAt"
Value: "createdAt"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 1000
Default: 20
offset
number >= 0
Default: 0
partnership
string
affiliateProfile
string
from
string <date>
to
string <date>
capped
boolean

Responses

Conversions list

query Parameters
affiliateProfile
required
string

Affiliate Profile ID

orderBy
string
Default: "createdAt"
Enum: "externalId" "createdAt" "amount" "commissions"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 10000
Default: 100
offset
number >= 0
Default: 0
program
string

Program ID

rule
string

Rule ID

partnership
string

Partnership ID

from
string <date>
to
string <date>
status
string
Enum: "pending" "refused" "accepted"
locked
boolean
externalId
string

Advertiser external ID

customerId
string
subId
string

Conversion SubId

contributionSubId
string

Click SubId

attribution
Array of strings
Default: "all"
Items Enum: "all" "share" "last" "first" "bonus" "api" "manual"

Responses

Feed list

query Parameters
affiliateProfile
required
string

Affiliate Profile ID

Responses

Partnerships KPIs

query Parameters
affiliateProfiles
Array of strings

AffiliateProfile ID(s)

programs
Array of strings

Program ID(s)

from
required
string <date>

YYYY-MM-DDTHH:mm:ss.sssZ

to
required
string <date>

YYYY-MM-DDTHH:mm:ss.sssZ

metric
required
string
Enum: "impressions" "clicks" "conversionsCPL" "conversionsCPA" "conversionsTotal" "commissionsTotal" "commissionsSubId" "commissionsCPC" "commissionsAvg" "EPC" "revenue"
status
string
Enum: "pending" "refused" "accepted"

Accepted and Pending by default

currency
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XBT" "XCD" "XDR" "XFU" "XOF" "XPD" "XPF" "XPT" "XTS" "XXX" "YER" "ZAR" "ZMW"

Responses

Partnerships list

query Parameters
orderBy
string
Default: "createdAt"
Value: "createdAt"
sort
string
Default: "desc"
Enum: "asc" "desc"
affiliateProfile
string

AffiliateProfile ID

programs
Array of strings

Program IDs

name
string
withProgramsDetails
boolean
Default: false
status
Array of strings
Items Enum: "interested" "pending" "approved" "cancelled_advertiser" "cancelled_publisher" "blocked" "inactive"
rates
Array of strings
Items Enum: "cpc" "cpa" "cpl"
search
string

Responses

Products list

query Parameters
search
string
Default: ""
programs
Array of strings

Program ID

categories
Array of strings
Items Enum: "animals-pet-supplies" "apparel-accessories" "arts-entertainment" "baby-toddler" "business-industrial" "cameras-optics" "electronics" "food-beverages-tobacco" "furniture" "hardware" "health-beauty" "home-garden" "luggage-bags" "mature" "media" "office-supplies" "religious-ceremonial" "software" "sporting-goods" "toys-games" "vehicles-parts" "gifts"
orderBy
string
Default: "new"
Enum: "new" "featured"
offset
number >= 0
Default: 0
limit
number <= 100
Default: 20
sort
string
Default: "desc"
Enum: "asc" "desc"
hideReviewedProducts
boolean
Default: false
countries
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

Responses

Publisher Information

Get detailed account information:
• Publisher ID.
• AffiliateProfile IDs.
• User IDs.

Responses

Vouchers list

query Parameters
orderBy
string
Default: "createdAt"
Enum: "createdAt" "name" "code" "expirationDate"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 1000
Default: 20
offset
number >= 0
Default: 0
affiliateProfile
string

Affiliate Profile ID

partnership
string

Partnership ID

blacklisted
boolean
search
string
status
string
Enum: "active" "inactive"

Responses

Product requests list

query Parameters
affiliateProfiles
Array of strings

Affiliate Profile ID

product
string

Product ID

status
Array of strings
Items Enum: "request_pending" "request_accepted" "request_refused" "review_published" "review_refused"
search
string

Responses

Payment requests list

Request Body schema: application/json
affiliateProfile
required
string

Affiliate Profile ID

partnership
string

Partnership ID

from
string
to
string
status
string (status)
Enum: "pending" "refused" "accepted" "paid" "scheduled"
currency
string (Model19)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XBT" "XCD" "XDR" "XFU" "XOF" "XPD" "XPF" "XPT" "XTS" "XXX" "YER" "ZAR" "ZMW"
filter
string

Responses

Request samples

Content type
application/json
{
  • "affiliateProfile": "5e336e000000000000000000",
  • "partnership": "5e336e000000000000000000",
  • "from": "2020-03-01T00:00:00.000Z",
  • "to": "2020-03-01T00:00:00.000Z",
  • "status": "pending",
  • "currency": "AED",
  • "filter": "string"
}

common

Generate Tracking Links

You can use this endpoint to generate Affilae Tracking Links.
Tracking links format (i.e. C2S/S2S) will be automatically generated depending of program setttings

Request Body schema: application/json
Array of objects (urls)

Responses

Request samples

Content type
application/json
{
  • "urls": [
    ]
}