This plugin connects a WooCommerce store to an affiliate programme you run at\nAffiliatant. It records which referral brought a shopper to the store, and it\ntells Affiliatant when that shopper buys, when the order is refunded and when\na subscription renews. Affiliatant works out what is owed. Nothing in this\nplugin moves money.<\/p>\n\n
An Affiliatant account is required. The plugin does nothing until you enter an\nAPI key and a programme id, and it requires WooCommerce: without WooCommerce\nactive it records nothing and says so on the Plugins screen.<\/p>\n\n
Everything described below is in this plugin. There is no trial, no licence\ncheck, and no feature here that waits for a payment.<\/p>\n\n
?aftid=<\/code> is\nrecorded by PHP on the landing request. The click id is kept in a\nfirst-party cookie, for thirty days by default, and on the WooCommerce\nsession.<\/li>\n- A beacon for cached pages.<\/strong> A cached page never runs PHP, and some edge\ncaches strip the query string before the request reaches the origin. A small\nscript reads the address bar and posts the click id to your own site's\n admin-ajax.php. It posts to your site, not to ours, and it sends nothing\nwhen there is no click id in the URL.<\/li>\n
- Classic checkout and Blocks.<\/strong> The referral is bound to the order on both\nthe classic checkout hooks and the Store API hooks the Blocks checkout uses.<\/li>\n
- Sales.<\/strong> An order reaching a status you count as paid is reported once.\nThe default is whatever WooCommerce itself calls paid.<\/li>\n
- Refunds and cancellations.<\/strong> A refund or a cancellation is reported as a\nreversal, so a commission can be withdrawn.<\/li>\n
- Subscription renewals.<\/strong> Renewal payments taken by WooCommerce\nSubscriptions are reported, carrying the id of the order that started the\nsubscription.<\/li>\n
- Coupon codes.<\/strong> Codes used on the order are sent, so a sale can be\nattributed to a code when there was no click to follow.<\/li>\n
- sub1 to sub5.<\/strong> Five pass-through parameters are carried from the landing\nURL to the conversion.<\/li>\n
- A local queue.<\/strong> Every event is written to a table in your own database\nfirst and sent afterwards by a background job, through Action Scheduler\nwhere it is available and WP-Cron where it is not. A checkout is never held\nup by a network call, and an event that cannot be sent is retried rather\nthan lost.<\/li>\n
- Reconciliation.<\/strong> The server report and the receipt pixel carry the same\ndeterministic event id, so one sale is counted once.<\/li>\n
- A receipt pixel<\/strong>, which can be switched off.<\/li>\n
- A connection test<\/strong> that sends a real conversion marked as test data, so\npressing it proves the key, the programme id, the signature and the network\nat once without creating a commission.<\/li>\n
- A status panel<\/strong> showing the queue, the last event sent and the last\nerror, with retry and clear.<\/li>\n
- An order meta box<\/strong> showing the click id bound to that order, and letting\nyou set one by hand.<\/li>\n
- Test mode<\/strong>, which marks everything sent as test data.<\/li>\n
- HPOS and Blocks compatibility<\/strong>, declared. Order data is read and written\nthrough the WooCommerce CRUD API only.<\/li>\n<\/ul>\n\n
What it does not do<\/h4>\n\n
It does not run the affiliate programme. Affiliates, links, commission rates,\napprovals and payouts live in Affiliatant, not in WordPress. It does not add\nan affiliate dashboard or a registration form to your site. It does not cloak\nlinks. It does not pay anybody.<\/p>\n\n
Money<\/h4>\n\n
Every amount is sent as a whole number in the currency's minor unit, together\nwith the currency of the order, calculated with string arithmetic rather than\nfloating point.<\/p>\n\n
External services<\/h3>\n\n
This plugin relies on one external service, Affiliatant, and contacts nothing\nelse. It contacts nothing on activation, and nothing on a schedule, until you\nhave entered an API key and a programme id on its settings screen.\nAffiliatant is a service run by Havenswift Hosting, and it is what makes the\nplugin useful: it holds the affiliate programme, matches each sale to the\nreferral that produced it and calculates the commission.<\/p>\n\n
Affiliatant, from your server.<\/strong> When an order reaches a paid status, is\nrefunded, is cancelled, or a subscription renews, your server sends that event\nto Affiliatant. It is sent by a background job, not during the shopper's\ncheckout request. The settings screen's connection test sends one event the\nsame way, marked as test data.<\/p>\n\nWhat is sent: your programme id and store reference; the order id and order\nnumber; an event id; the kind of event; the order total, tax, shipping and\ndiscount as whole numbers in the minor unit; the currency; the date of the\norder; a test flag; the line items, each with its name, SKU, product and\nvariation ids, quantity, unit and line amounts and tax; any coupon codes used;\nthe payment method identifier; for a renewal, the id of the original order;\nthe numeric WordPress customer id where the shopper has an account; the click\nid; sub1 to sub5; and the landing URL the shopper arrived on. The request\ncarries your API key and a user agent naming the versions of this plugin,\nWooCommerce and WordPress.<\/p>\n\n
What is not sent: no customer name, no email address, no postal address, no\ntelephone number and no IP address.<\/p>\n\n
Service: https:\/\/affiliatant.com\nTerms: https:\/\/affiliatant.com\/legal\/terms\nPrivacy: https:\/\/affiliatant.com\/legal\/privacy<\/p>\n\n
Affiliatant, from the shopper's browser.<\/strong> When the receipt pixel is on, the\norder-received page includes a one-pixel image served by Affiliatant. The\nrequest is made by the shopper's browser and therefore carries their IP\naddress and the address of the page. It is sent only on the order-received\npage, and only when the plugin is configured and the pixel setting is on. Turn\nthe pixel off in the settings and no request is made from any visitor's\nbrowser.<\/p>\n\nWhat is sent: your programme id and store id; the order id; the event id; the\nkind of event; the order total, tax and shipping as whole numbers in the minor\nunit; the currency; the date of the order; the click id; the coupon code; the\nnumeric WordPress customer id where the shopper has an account; and a test\nflag. The whole query is signed.<\/p>\n\n
Service: https:\/\/affiliatant.com\nTerms: https:\/\/affiliatant.com\/legal\/terms\nPrivacy: https:\/\/affiliatant.com\/legal\/privacy<\/p>\n\n
The click beacon described above posts to your own site's admin-ajax.php<\/code>. It\nis not a request to Affiliatant and no third party receives it.<\/p>\n\nThere is no usage tracking, no telemetry and no analytics of any kind.<\/p>\n\n
The plugin is published by Havenswift Hosting,\nhttps:\/\/www.havenswift-hosting.co.uk\/<\/p>\n\n
Third-party libraries<\/h3>\n\n
The Affiliatant PHP SDK is included at lib\/AffiliatantClient.php<\/code>. It is one\nfile, written by us, and it is published under the MIT licence while the rest\nof the plugin is GPLv2 or later. MIT is GPL-compatible. No other library ships\nwith this plugin and nothing is minified.<\/p>\n\n\n\n- Install and activate WooCommerce first. This plugin records nothing\nwithout it.<\/li>\n
- Upload the folder to
\/wp-content\/plugins\/<\/code> and activate it, or install it\nfrom the Plugins screen.<\/li>\n- Create a programme at https:\/\/affiliatant.com and generate an API key for\nit.<\/li>\n
- Go to WooCommerce > Affiliatant and enter the API key, the key prefix, the\nsigning secret and the programme id.<\/li>\n
- Press \"Send a test conversion\". It sends one conversion marked as test\ndata and tells you what came back.<\/li>\n
- Place a test order on your store with
?aftid=<\/code> on the landing URL and\ncheck that it appears in the status panel.<\/li>\n<\/ol>\n\n\n\nDoes it need an Affiliatant account?<\/h3><\/dt>\nYes. The plugin reports to Affiliatant and has no function without an account\nthere. See \"External services\" above for exactly what is sent and when.<\/p><\/dd>\n
Does it work without WooCommerce?<\/h3><\/dt>\nNo. It reads WooCommerce orders and hooks WooCommerce events. With WooCommerce\ninactive it records nothing and shows a notice saying so.<\/p><\/dd>\n
Does it expire, or stop working?<\/h3><\/dt>\nNo. There is no trial, no licence check and no feature in this plugin that\nwaits for a payment. What is in the description is what it does, permanently.<\/p><\/dd>\n
Can it slow down or break my checkout?<\/h3><\/dt>\nThe event is written to a table in your database during the request and sent\nafterwards by a background job, so a normal checkout makes no outbound call at\nall. Nothing in the sending code is allowed to throw out of a WooCommerce hook:\nif Affiliatant is unreachable the checkout completes and the event waits in the\nqueue.<\/p><\/dd>\n
What customer data leaves my site?<\/h3><\/dt>\nThe numeric WordPress customer id, where the shopper has an account, and\nnothing else about the person. No name, email, address, telephone number or IP\naddress is sent from your server. The receipt pixel is a request from the\nshopper's own browser, so it carries their IP address the way any third-party\nimage does; turn the pixel off if you do not want that.<\/p><\/dd>\n