WhiteLabel API
Affiliate Network
Public Program Object
attributes id string a unique identifier for the program object string the value is always affiliate program label string the label of the affiliate program created at timestamp the date the ticket was created currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 the currency of the affiliate program commission amount integer the fixed commission amount in cents commission percent decimal the percentage commission cookie expiry integer the lifetime of the affiliate cookie in days the default value is 30 days description string the short description of the affiliate program auto approve boolean this attribute determines whether affiliates that join the program are automatically approved allow bonuses boolean this attribute determines whether affiliates are allowed to offer bonuses (such as ebooks) to customers they refer affiliate notifications boolean this attribute determines whether email notifications are sent to affiliates on every new sale and on every refund that was deducted due to refunds is listed boolean this attribute shows if the affiliate program is listed in the affiliate marketplace is public boolean this attribute shows whether the affiliate program is publicly visible and whether affiliates are allowed to join payments array of strings the payment methods that are available for commission payouts destinations array of strings ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the country whitelist of the affiliate program subscription commission type string this attribute shows how the commission will be applied to recurring sales the possible values are forever , repeating and once payment count integer the total number of payments to offer commission for recurring subscriptions and instalment plans available subscription commission type is set to repeating payout delay integer the number of days before a commission is made available to the affiliate banners array of strings the id of the assets that are used as banners for the affiliate program signup url string the url where affiliates can signup for the affiliate program approved boolean this attribute shows if the program has been approved by the whitelabel administrator for being listed in the public marketplace domain object an object containing the details of the domain associated with the affiliate program affiliates integer the number of affiliates that joined this program sales integer the total number of sales referred by affiliates signup url string the url where affiliates can signup for the affiliate program javascript url string the link to the javascript file that you have to install on your domain \<head> in order for the affiliate program to track referrals required for affiliate programs that are hosted outside of tamio seller object an object containing information about the owner of the affiliate program exampe "seller" { "name" "awesome merchant", "email" "awesomemerchant\@example com", "country" "de" } { "object" "affiliate program", "products" \[ "b44286e6 6e61 4dc9 b7ee 5f75436e6d23" ], "domain" null, "label" "test2", "created at" 1708087952, "id" "6e8376d3 19e4 4ec0 a576 ec495be4d5c0", "currency" "eur", "commission amount" 2200, "commission percent" 0, "description" null, "payout delay" 0, "subscription commission type" "once", "destinations" \[ "worldwide" ], "payments" \[ "ideal", "przelewy24" ], "payment count" null, "approved" false, "auto approve" true, "languages" { "en" { "label" "test2", "description" null } }, "signup url" "https //app tamio xyz/auth/register?affiliate program id=6e8376d3 19e4 4ec0 a576 ec495be4d5c0", "is listed" true, "banners" null, "affiliates" 0, "sales" 0, "javascript url" null, "is public" true, "cookie expiry" 30, "first takes all" "enabled", "affiliate notifications" true, "seller" { "name" "antonis+aff1", "country" "cy", "id" "5521d577 c885 4ebe 84a3 1665872a854f" } }