Project Specifications for Zen Cart Affiliate Data Feed with Client Side Integration
I. Server Settings:
Operating System: Linux [url removed, login to view]
PHP Version: 4.4.7 (Zend: 1.3.0)
Database: MySQL 4.1.22-standard
Shopping Cart: Zen Cart 188.8.131.52
Website to be completed for: [url removed, login to view]
We are looking for a data feed of our products to be sent from our store to another site and displayed on one page in a type of “mini-store” setting. On the clients end, the display section should be easily customizable (ie. 4 rows X 3 columns or 2 rows X 1 column of products). When a customer goes to a site that is using our feed and clicks on one of our products, they should be taken to the product page on our site. The products included in the feed should be customizable on our end in the Zen Cart admin to include a control panel to select which type of commission is paid, what product categories should be fed, a section to select individual items to be fed, and to what site the feed should go to. Also in our admin should be the ability to check reports about individual affiliates.
1. Zen Cart Admin
A. Data Feed Control Panel (Main Page)
i. List all sites that are currently set up to receive the feed. These should be clickable to select, and then another click to edit the feeds they are recieving. *See Data Feed (Edit Page)*
ii. Be able to click on a “Create New Feed” button to set up with a new site.
iii. There should be a refresh button on each feed that can be clicked after selecting the individual feed to refresh the data that is sent to the site it is set up to send to.
iv. Have a “Test Connection” button for each feed and generate a page to diagnose problems on the other sites' end.
B. Data Feed (Edit Page)
i. This page should have editable fields with the following values:
a. Custom Data Feed Name – This is a name that should be inputted when creating a new Data Feed. This is for internal purposes only.
b. Site Link – This is the where the feed will be pointed to. **Note: There may be more fields that are needed depending on the backend code to connect both of the sites.**
c. Custom Referral Code – This should be an optional value. If a string of alphanumeric characters are not entered, a referral code is generated automatically.
d. Commission Type – This should be an input box for each of the following items:
· Fee per Sale $ (ex: $[url removed, login to view] per sale)
· Fee per Referral $ (ex: $[url removed, login to view] per person referred)
· Fee per Sale % (ex: 5% of sale)
If any of these fields have an input value, they should be included in the commission calculation. If the fields are blank, they do not apply towards commission.
ii. Below the fields, there should be a section that lists checkbox options for “All Products” and each separate category should be listed with a checkbox next to it.
iii. Below the checkboxes, there should be a dropdown list of all products, so that a products can be added individually. If one product is selected, another dropdown box should appear so that another item can be added.
C. Data Feed Reports List (Main Page)
i. The main page will list all data feeds with a quick view of number of referrals and number of sales by that referrer within the last 7 days.
ii. Each data feed, once selected and clicked on, should take you to the Data Feed Report Page (Report Details).
D. Data Feed Report Page (Report Details)
i. Each data feed should provide the following reports, and should be set to generate any given range of time.
a. Number of Referrals
b. Amount of Sales
c. Amount of Commision Earned
d. Search Keywords Used
e. Top Exit Pages
f. Average Clicks on Site by Referrals
g. Average Time Spent on Site by Referrals
2. Client Side (Affiliate Partner)
A. Display Options
i. There should be an easily customizable display to be set up for the client. (ex: An affiliate owns a shop where our products will be displayed in one column, with 5 rows of products.)
B. Navigation & Search
i. There needs to be a simple navigation interface for customers to browse through the items (only seeing picture, product, and price) while still on the affiliate site. This can be set up by having buttons for “<< Previous 1 2 3 ... Next >>”.
ii. There should be a search box at the top to search through the products in the feed. The search results will be displayed on the affiliate website.
iii. Below the search box, there should be a list of the categories that were exported in the original data feed from our admin. Clicking on a category will bring up a list of products in that category on the affiliate site.
C. Feed Refresh Options
i. The feed needs to be set up to sync on a regular schedule, and the owners of the site must have a way to manually refresh the content of the data feed.
IV. Multiple Site Integration:
This project also needs to be expandable to other Zen Cart Stores that we have, so any changes that are made to files or settings in the Zen Cart admin must be able to be duplicated into another Zen Cart 1.3.7 installation.
[url removed, login to view] References
A. MMAMania - [url removed, login to view]
i. This page is set up with GoldenCan Affiliate Data Feed, and GoldenCan Store Integration. It is very similar externally to what we are looking for.
B. Supertrackers Mod for Zen Cart - [url removed, login to view];products_id=683
i. This mod is under GPL license, and has features such as referring page and others that might be useful to modify.
Please send a PM if you have any questions about this project. You can also download the Project Specifications Sheet.