eBay WS API Framework QuickStart
profitCode Software  -  Scripting the future of e-commerce!

profitCode Software
Leading PayPal IPN
enabled shopping cart
solution provider

 
 
 
: Home | Documentation | eBay | ebay Web Services API | Quick Start
 

 

Getting Started:

Displaying results:
Most of the results are displayed using our category structure.
This basic category structure goes down to 3 levels deep.
You can incorporate your own category structure, but as of yet no direct category retreval (GetCategoryListings call) is made to eBay for category structure.
When adding a category, you have 3 options (add-category link in admin area):
Since most of your listing calls are made with the GetSearchResults call (dynptplates/getDynCatResults.php), this scripts categoryID is for internal purposes and has nothing to do with eBay categoryID's.
Sample categroies are included with this software and are uploaded to your mysql table dynprod_categories.
When adding a category, you must select whether it will be a main category, a parent category or a sub category. You should decide this before adding your categories. In adding a category you can decide how you want to handle the results for that category when a user clicks the category link.
Your Options:
- It will use the CategoryTitle as a search query in the GetSearchResults call.
- It will use the eBay CategoryID you enter as the search query on eBay items in that eBay categoryID.
- It will use the search terms you enter for that category. Note that the search terms were included because in some cases the actual category title will not do.
If you have an eBay CategoryID and your own search terms entered, it will search for listings in that category with the search terms.
The default setting is using the category title.
eBay allows you to use various keywords for a search query.
Ex: (tv, vcr, plasma lot)  
Note that each search term  is seperated by a comma and all search terms are included in parenthesis. The parenthesis are also used in the search query.
 
 
Deleting the included categories:
Go the the category summary link in your admina area.
In the advanced search form select:
where -> CategoryID -> is less than -> [enter number 100]
select the delete results option and click the submit button.
 
  
Linking Types:
In your admin settings you will find the Linking Type Sellect list.
It will give you 3 options for linking to listings, pagination, etc.
-  [value: 0] Normal link <a href="index.php?.........">
-  [value: 1] The rel tag. (used to prevent spider indexing).
-  [value: 2] Javascript link
 
 
About Layout and Design
Main templates are found in the /templates folder.
topmenu, bottommenu, leftmenu, middlemenu etc, php. 
 
 
Internationilization and Language
All language string files are found in userlang/ folder, note that for this API, the only ones used are the ENGdynprods.php and ENGdynprodsUtf8.php.
Consider that all information sent to and received from eBay is UTF-8 encoded.
You must decide what meta-tag headers your web page display will be. See this topic at the eBay Developers Forum.
In your admin main settings, it gives you the option of either setting either:
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
OR:
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
As your web-pages meta tag.
If you are using UTF-8, then it will use the ENGdynprodsUtf8.php. The language strings in this file are already UFT-8 encoded.
UTF-8 encoding is probably better to use for International sites with accents in the letters alphabet, or  like Chinese, Japanase, letters.
Example, if your using iso-8859-1 encoding on a Spanish site, the results from eBay will not display properly when the Title of the listing has accents like these: á ó ã, etc.
These letter accents come back UTF-8 encoded from eBay.
If you look at userlang/SPAdynprods.php and compare with SPAdynprodsUtf8.php, you will notice that the Spanish utf-8 encoded strings are not similar to the normal accent characters.
Examples of sites using the UTF-8 encoding:

English | Spanish | French | Italian | Geman

Since the language settings code for this API was copied from our cart software, it is not serialized. In other words, you have only 6 language settings in this APIs admin section for grabbing the necessay language file. They are English, Portuguese, Spanish, French, Italian, German.
Note that only language string files are only complete for the english language.
If you would like to use another language, it can be easily integrated. Just follow these steps. In this example, we will use Chinese. Note that Chinese is not listed as a language option in your admin Settings.
1. Translate the language strings in ENGdynprods.php to Chinese.
2. In your templates/leftmenu.php, you will see a commented script that starts with.. 
/*
* utf encode the lang strings
Uncomment it, and open up the API home page in your browser. You will notice that you now have a load of language strings in your web-pages left menu. Right click and select view html page source code in your browser, it will open up the html source code in your text editor. Just copy the UTF-8 encoded strings to ENGdynprodsUtf8.php and save.
Dont forget to comment again this snippet in leftmenu, or your site visitors will see the language strings blob in the left menu.
The snippet is in leftmenu for convinience, and yes, its untidy, but when constantly UTF-8 encoding new strings, it comes in handy.
Remember that any static content or string that you put in your web-page, must also be UTF-8 encoded if you are going to be using this option.
Dont forget to select China as your eBay SiteID in your admin Settings.
  

Also See:

DEMO (eBay Web Services API Framework Demo)
Download eBay Developer Tools (Download)
eBay Developer Tools Docs (Documentation)
eBay Developer Tools Forum