NWS API (SOAP) help for parameters in requests and returns. [Last modified: 11/18/2005]

General settings -- request values
Parameter Default Value Description
clientid
[2004.10.03]
"" You're always required to submit your "clientid" with your password to NWS server to fully access NWS features. Missing a clientid, or the clientid and password not matching, or not been approved for NWS, a development database will be used in stead of our main database. The development database is for developers with restricted data. A clientid of 'invalid privateid' or 'testid' will be returned respectively.

"clientid" is either your login name on Netoon.com, or your unique numerical ID associated with the name. You may look up your clientid and privateid in your NWS profiles.

Your clientid will also be used as your affiliate tracking ID, if you joined Netoon as revenue share partner.

privateid
[2004.10.03]
 "" Client ID is a public ID that everyone may see, while private ID should be kept privately. This ID is used to track and to prevent improper use of NWS.

If a clientid doesn't match a privateid, a default 'testid' will be used and you will not be credit for revenue share.

linktype
[2004.10.03]
"2" Currently, Netoon has 4 types of links:

linktype = "1". Direct link. Direct link links your customers to vender's website directly. This type of link doesn't earn you commissions upon referral. Direct links are only provided under specific agreement. Please email support@netoon.com for details.

linktype = "2". Netoon link. Netoon links look like: http://netoon.com/redirect2.php?siteid=xxx&urlid=yyy&s1=clientid
This is the default and suggested link type. When any users click the link and make a purchase of participated products, you share revenue with Netoon.

linktype = "3". Your link with your Netoon ID. If you don't want visitors see links of netoon.com, or if you'd like to do further actions such as tracking user browsing behaviors, you can set linktype=3, and Netoon will return siteid=xxx&urlid=yyy rather than a full URL. You'd develop your code for proper redirection. A sample code is included in the demo package as nbounce.php.

linktype = "4". Your link without your Netoon ID.

Note: We understand that many customers would like to use NWS as personal deal discovery tool, however NWS is designed for websites that would like to reuse Netoon's data to enrich their web content. Personal users please refer to our upcoming Premium Shopping Service.

Note: Please note that Netoon prohibits change, remove and edit, but not restrict to, the URL's, affiliate IDs and sub-affiliate IDs that comes from Netoon. You agreed with this before you registered NWS.

returnblankimg
[2004.10.03]
"true" Some products have no appropriate images. Set this parameter to "true" if you would like to use Netoon provided "No image available" images.
returnbriefdesc
[2004.10.03]
"false" Whether or not return brief description of a product when available. Set this value to "false" when you don't show users brief description to save bandwidth.
returndetails
[2004.10.03]
"false" Whether or not return brief description of a product when available. Set this value to "false" when you don't show users brief description to save bandwidth.
siteid
[2004.10.03]
"" "siteid" could be a ID list of interested merchants, separated by comma. For example, "1, 3,11, 2". In-line white spaces will be ignored. Netoon provides this parameter for you to selectively display the most trustable and profitable results.

Please use "0" to specifically search in all sites, and use "-1" to search in your pre-set websites through NWS settings.

Please note that not all sites have affiliate program. It's your choice to filter content from any websites.

node
[2004.10.03]
"0" Each "node" maps to a category.
keywords
[2004.10.03]
"" keywords to search.
wordmatch
[2004.10.03]
"false" Search "cd" in "17-inch LCD" would return "true" if "wordmatch" set to "false", while "false" if "wordmatch" is "true".
pagenumber
[2004.10.03]
"0" Number of page you are requesting.

If page number less than 0, i.e. -1, the server will return a radom page.

Note: this value could be changed by server if you sent a number either less than 0 or greater than total result pages.

pagecount
[2004.10.03]
"15" Number of items per request. You can ask for a maximum of 100 items in every request.

* All parameter types are 'string', but you can always submit an number without a quote mark. For exapmle, in most cases, using $proxy->searchItemData(array('clientid'=>'5001')) is equal to $proxy->searchItemData(array('clientid'=>5001))

* Please use 'true' instead true.

* All parameters are case sensitive.

View return values

Back to top





Main search or browse (Browse.php) -- request values

Parameter Default Value Description
instantdiscount
[2004.10.03]
"false" Return products that have instant discount.
rebate
[2004.10.03]
"false" Return products that have rebate.
clearance
[2004.10.03]
"false" Return clearance products.
optionalsavings
[2004.10.03]
"false" Return products that have optional savings.
pricedrop
[2004.10.03]
"false" Return products that recently price dropped.
orderby
[2004.10.03]
"1" NWS supports 9 order options:
  1. order by rebate, instant discount, clearance items first, then after rebate price low to high
  2. order by rebate, instant discount, clearance items first, then after rebate price high to low
  3. order by after rebate price low to high
  4. order by after rebate price hight to low
  5. order by descending time that last price drop or rebate occurred
  6. order by percent jump
  7. order by percent drop
  8. order by before rebate price low to high
  9. order by before rebate price high to low
pricelow
[2004.10.03]
"" Low price boundary.

Please note that "" is different with "0" because one may earn money after rebate for some products such as cell phones.

pricehigh
[2004.10.03]
"" High price boundary.

Please note that to set higher price boundary to a very small number could be used as "filler finder". Filler finder could be used as padding for coupon or free shipping.

lowrateshipping
[2004.10.03]
"false" Return low rate shipping items if set to "true"
View return values

Back to top





Get products by a list of item ID (Item.php) -- request values

Parameter Default Value Description
itemlist
[2004.10.03]
"" A list of item id that specifies what items to return. Separated by comma. For example, "19684, 8975631,458924, 875213". In-line white spaces will be ignored.
View return values

Back to top





Get hotdeals (Deals.php) -- request values

Parameter Default Value Description
norebate
[2004.10.03]
"false" Different with search or browse in main database, you can set not return deals with a rebate. Please note that lots of deals have rebate.
active
[2004.10.03]
"true" If you would like to look into dead deals, set this value to "false".

Please note that some deals may be "active" for one day only. It's your choice to let users find the "dead" ones or not.

dealsince
[2004.10.03]
"3" Return deals in N days. NWS supports search/browse deals within:
 "0" - All in history
 "1" - 24 hours
 "3" - 3 days
 "7" - 7 days
hot
[2004.10.03]
"1" "1" - return all hot deals
"3" - return hotter deals
"5" - return hottest deals
hid
[2005.10.14]
"" Corresponding deal item would be shown as the first result in returned deal list, when request with the valid hid (hot deal item ID)
View return values

Back to top


กก

General settings -- return values
Parameter Description

* All return results have a array named "SearchFor". All submitted values are changed to appropriate format/values if not meet the requirements.

totalresults
[2004.10.03]
Number of results for requested search or browse. For example, "find 50200 results for your search". This is part of the "SearchFor" array.
totalpages
[2004.10.03]
Number of pages. For example, the "find 50200 results in 502 pages"
NodePaths
[2004.10.03]
This array contains a node path from the root node to requested node. For example "All Categories -> Computers & Software -> MP3 Players"

Deprecated

SubNodes
[2004.10.03]
This array contains a direct sub node list for the requested node.

Deprecated

NNodePaths
[2005.10.14]
This array contains rich node paths for the requested node.
View request values

Back to top





Main search or browse (Browse.php) -- return values

Parameter Description
ItemId
[2004.10.03]
A product ID. Could be used for retrieving single or multiple items.

For more information, refer to Item.php

SiteId
[2004.10.03]
Every shopping site on Netoon has a unique ID. Normally you don't need it in return values.
SiteName
[2004.10.03]
Shopping site's name.
Url
[2004.10.03]
Product URL. In direct link, Netoon link or your-style link.
ProductName
[2004.10.03]
Name of a product.
ImageUrl
[2004.10.03]
Image URL of the product.
ImageWidth
[2004.10.03]
Image width, if available.
ImageHeight
[2004.10.03]
Image height, if available.
PriceAfterRebate
[2004.10.03]
Product price after rebate.
PriceBeforeRebate
[2004.10.03]
Product price before rebate.
RebateAmount
[2004.10.03]
Rebate amount, if available.

Note: Netoon may fail to retrieve rebate amount for certain product.

Rebate
[2004.10.03]
The product has rebate or not.

Note: this is NOT a true/false value. It's string of "true" or "false".

RebateHours
[2004.10.03]
How long has the rebate last, in hours.
InstantDiscount
[2004.10.03]
The product has instant discount or not.

Note: this is NOT a true/false value. It's string of "true" or "false".

OptionalSavings
[2004.10.03]
The product has optional savings or not.

Note: this is NOT a true/false value. It's string of "true" or "false".

Clearance
[2004.10.03]
The product is in clearance or not.

Note: this is NOT a true/false value. It's string of "true" or "false".

PriceDrop
[2004.10.03]
The product recently price dropped over 10% or not.

Note: this is NOT a true/false value. It's string of "true" or "false".

DropPercent
[2004.10.03]
Drop/jump percentage a product price changed. "50" means price dropped 50%, while "-40" means price jumped 40%.
PriceDropHours
[2004.10.03]
How long from the last price change, in hours.
HiddenPrice
[2004.10.03]
For certain reasons, price may be hidden at the vender's website.

Note: this is NOT a true/false value. It's string of "true" or "false".

FreeShipping
[2005.10.14]
Values could be: "na", "free" or a positive integer indicate "free shipping on orders over dollars".
ShippingRate
[2005.10.14]
Values could be: "na" or actual shipping rate.
BriefDesc
[2004.10.03]
Brief description of a product, if available.
Details
[2004.10.03]
Detailed description of a product, if available.
LastUpdatedTime
[2004.10.03]
Time stamp Netoon last update the record, PST or PDT.
View request values

Back to top





Get products by a list of item ID (Item.php) -- return values

Parameter Description
All parameters Same as return values from Browse.php
View request values

Back to top





Get hotdeals (Deals.php) -- return values

Parameter Description
HotId
[2004.10.03]
Hot item ID. Every hot deal has a unique HotId
SiteId
[2004.10.03]
Every shopping site on Netoon has a unique ID. Normally you don't need it in return values.
SiteName
[2004.10.03]
Shopping site's name.
Url
[2004.10.03]
Product URL. In direct link, Netoon link or your-style link.
ProductName
[2004.10.03]
Name of a product.
ImageUrl
[2004.10.03]
Image URL of the product.
ImageWidth
[2004.10.03]
Image width, if available.
ImageHeight
[2004.10.03]
Image height, if available.
PriceAfterRebate
[2004.10.03]
Product price after rebate.
PriceBeforeRebate
[2004.10.03]
Product price before rebate.
RebateAmount
[2004.10.03]
Rebate amount, if available.

Note: Netoon may fail to retrieve rebate amount for certain product.

Rebate
[2004.10.03]
The product has rebate or not.

Note: this is NOT a true/false value. It's string of "true" or "false".

Active
[2004.10.03]
Indicates the deals is still alive or not.

Note: this is NOT a true/false value. It's string of "true" or "false".

BriefDesc
[2004.10.03]
Brief description of a product, if available.
Details
[2004.10.03]
Detailed description of a product, if available.
LastUpdatedTime
[2004.10.03]
Time stamp Netoon last update the record, PST or PDT.
View request values

Back to top