Posting transactions from a shopping cart to Plexum is very simple and can be done in various of methods (e.g. image call, JavaScript, calls within scripting language PHP, Perl, etc..).
Where to Post transactions to:
http://www.yourdomain.com/plexum/phpapi/integration.php
Note:
1. Replace the "yourdomain.com" with your actual website domain name.
2. The location of the integration.php script would be correct if you installed Plexum in it's default location, but if it was installed in a sub-folder under your document root directory, then you will need to include the folders as well.
Post & Transaction Variables:
| Variable Name |
Value |
Required |
Description |
| type |
cart |
Yes |
Indicate to record sales transaction. |
| return_userid |
UserId |
Yes |
UserId of the user that referred the sale. |
| return_pass |
yes/no |
No |
Indicate to not credit the user that referred the sale but pass the sale to the user upline sponsor, if no value is provided, it will default to "no". |
| return_orderid |
|
Yes |
Sales order number, supplied by your shopping cart software. |
| return_amt |
|
Yes |
Total amount of the sale, which commission calculation will be based on, if commission-able amount is not supplied in return_commissionable variable. |
| return_commissionable |
|
No |
Total amount to based commission calculation on, if an amount is supplied (e.g. 20.00). |
| return_approved |
yes/no |
No |
To automatically approved orders despite the financial & Plan manager preferences. |
| return_custname |
|
No |
Customer name supplied from the shopping cart. |
| return_source |
|
No |
Name to use in identifying the sales (e.g. Xyz Store). |
| return_item_info |
|
No |
List of item purchased (e.g. Quantity, Price Each, Item Name|2,29.00, Mouse Pad). |
| return_api |
yes/no |
No |
To indicate if the sales information is passed silently (e.g. using PHP, Perl), if no value is provided, it will default to "no". |
| return_recurring |
yes/no |
No |
To indicate if the sales is a recurring transaction, if no value is provided, it will default to "no". |
| return_st |
|
No |
Secret code to verify the transaction is coming from the actual site, this code is what is set on Financial & Plan Manager Preferences. |
| return_location |
|
No |
If "return_api" value is empty or set to no, you can provide url where to redirect customer after sales is recorded. |
| return_img |
yes/no |
Yes |
Indicate to return an image if the sales information is being passed through image tag
|
Posting a userId to your shopping cart, you can place a link to your shopping cart on users replicated WebPages with a tag "!ID!" to callout the userid into your shopping cart url string (e.g. http://www.yourdomain.com/store.php?referral=!ID!), note that the !ID! will automatically be replaced with the actual userId and your shopping cart software must be able to hold the userId passed to it and supply it when the transaction information is being passed back to Plexum for commissions.
Simple Connection Integration Method
Posting via Image call:
The returned image from Plexum is a blank 1pixel image.
Posting via JavaScript:
How to use the JavaScript onLoad call:
| <body onLoad="plxCpage();"> |
Note: only the minimum sales transaction information is present on the example string, and depending on which of the simple method you are using, the code must be placed on the final transaction page commonly referred to as checkout confirmation page.
Advanced Connection Integration Method
PHP Sample Code:
A sample of PHP code to add to a PHP shopping cart.
Perl Sample Code:
A sample of Perl code to add to a Perl shopping cart script using (LWP::Simple) Perl module:
With the advanced method, one of three types of value will be return back to your script, see bellow:
| Return Value |
Description |
| ok,Tracking ID |
ok indicate that the transaction is registered successfully and Tracking ID is replaced with the actual number of the record on Plexum Sales Transaction Manager. |
| duplicate_order |
Indicate a duplicate transaction and the transaction is rejected. |
| authentication_filed |
secret code passed or domain name of the shopping cart do not match the secret code or allowed domain name on Plexum referral security setup and the transaction is rejected. |
Find & Replace Tool (27.39%)
This useful tool eliminates the time consuming task of modifying like text or...