Product Services
Use the product services to search for products and push products to ebay.
ProductSearch
Description
The ProductSearch method returns a list of products matching your criteria.
Request Parameters
| Field | Field Type | Data Type | Description |
|---|---|---|---|
| Authorization | Header | String | This is the authorization token you'll get from the site administrator console. You must send this string with every api request. |
| Method | URL | String | To use this method you must use the string: ProductSearch |
| SearchString | URL | String | This is a string that is used to search for products |
| Brand | URL | String | This is the product brand you want results for. |
| LowPrice | URL | Float | This is the lowest price allowed for product results. |
| HighPrice | URL | Float | This is the highest price allowed for product results. |
| Page | URL | Integer | This is the page of records you want. |
| Count | URL | Integer | The is the number of records per page you want returned. The maximum number of results the system will return is 1000 at a time. The default value for this field is 1000. |
| UserID | URL | Integer | This is the ID of the user performing the search. Used for tracking purposes so the purchase will count for this user. |
Example:
If you only wanted to get the first 100 products on you site that are digital cameras then you would use the following url along with the authorization string in your header:
http://yoursite.com/webservices/product?method=ProductSearch&SearchString=digital+camera&Page=1&Count=100
Response
The response is an xml document whose root element is iRebatesResponse. Below are it's child elements.
| Field | Type | Description |
|---|---|---|
| Results | Integer | The number of records returned on this page of results. |
| Page | Integer | The current page of records returned. |
| RecordsPerPage | Integer | The number of records per page requested |
| TotalRecords | Integer | The total number of users that are in your site. This is used to help calculate the number of requests required to get all records. |
| Products | Node Collection | Contains Product nodes containing the information for each product. |
Product Nodes
| Field | Type | Description |
|---|---|---|
| MerchantName | String | The name of the merchant. |
| ProductName | String | The name of the product. |
| Description | String | The description of the product |
| Price | String | The product price as listed on the merchant's website. |
| CashBack | String | The amount of cash back the user receives for purchasing this product. |
| Total | String | The total cost to the user after cash back is calculated. |
| Image | String | The URL for the product image. |
| Link | String | The link to the product on the merchant's website. |
Example
Here is an example of a response.
<iRebatesResponse>
<Results>1</Results>
<Page>1</Page>
<RecordsPerPage>1</RecordsPerPage>
<TotalRecords>148206</TotalRecords>
<Products>
<Product>
<MerchantName>Target</MerchantName>
<ProductName>Apple Ipod Touch 32gb Mp3 Player (4th Generation) With Touch Screen,</ProductName>
<Description>See friends while you talk to them with FaceTime. Shoot, edit, and share stunning HD video. Play games
against friends, or unknown foes, with the new Game Center. And do it all on the Retina display the
highest-resolution screen on any mobile device. It makes graphics and text look even more amazing. The new
iPod touch. It s state-of-the-art fun.</Description>
<Price>294.99</Price>
<CashBack>18.43</CashBack>
<Total>276.56</Total>
<Image>http://img3.targetimg3.com/wcsstore/TargetSAS/img/p/12/99/12990623.jpg</Image>
<Link>http://yourdomain.com/jumpmerchant.cfm?SRMID=899&SRUID=0&RedirectURL=http%3A%2F%2Fwww%2Etarget%2Ecom%2Fp%2F
Apple%2DiPod%2Dtouch%2520%2D32GB%2DMP3%2DPlayer%2D4th%2DGeneration%2Dwith%2DTouch%2DScreen%2C%2DWi%2DFi%2D
Black%2DMC544LL%2FA%2F%2D%2FA%2D12990623%23%3Fref%3Dtgt%5Fadv%5FXSG10001%26AFID%3D
Froogle%5Fdf%26LNM%3D%257C12990623%26CPNG%3Delectronics%26ci%5Fsrc%3D14110944%26ci%5Fsku%3D12990623</Link>
</Product>
</Products>
</iRebatesResponse>
