Building a Custom eBay Watch List Using the SOAP API
- Posted: Oct 31, 2006 at 6:43 AM
- 3,338 Views
- 25 Comments
Loading User Information from Channel 9
Something went wrong getting user information from Channel 9
Loading User Information from MSDN
Something went wrong getting user information from MSDN
Loading Visual Studio Achievements
Something went wrong getting the Visual Studio Achievements
|Keeping a track on changes on eBay using its web service.|
Time Required: 1-3 hours
If you're like me, you're always keeping an eye on what's happening on eBay. Whenever I find something that I'm interested in tracking, I use eBay's Watch List feature to remember it for me. However, I find when I'm watching lots of items it's not so easy to sort, filter, and display them as I want. That's where eBay Web Services comes in. What I did was write a program to retrieve all my watch list items using SOAP. Now I have complete control to customize the display and add the feature I want to the interface.
In this article I'll walk you how I did this using ASP.NET 2.0. You'll learn the basics of eBay Web Services and see how easy it is to customize eBay.
To get started, register with the eBay Developers Program. Signing up for the program gives you access to the Sandbox, eBay's test environment that allows you to test your applications before taking them live. For this example, we want to pull down the real eBay Watch List data, so you need to get access to eBay's production environment. Register for access to the production eBay environment by submitting the Self-Certification Form. Once you complete this form you'll receive an email with instructions on how to retrieve your production developer keys. Follow those instructions, and once you've retrieved your keys save them in a text file for later use.
Once you have access to the production environment, create an authentication token for your eBay username by going to http://cgi1.ebay.com/aw-cgi/eBayISAPI.dll?RegisterShow&ru=http%3A//www.ebay.com. (Sign up for eBay first if you haven't done so.) eBay Web Services uses authentication tokens for user authentication to keep your user data secure. This system allows authorized third party applications to make Web Services calls on your behalf without those third parties having access to your eBay username and password. Use the Single User Authentication Token tool to create an authentication token for your test user. In the tool, select the Production environment and enter the production developer keys you retrieved earlier. Go through the flow, and when you're done save the authentication token in the same place as you saved your developer keys.
Now that you have all of that stuff out of the way, we're ready to go. eBay offers access to its web services through SOAP, XML, SDKs for .NET and Java, and even a REST API. For this example we'll be using the SOAP API. eBay exposes a WSDL file that you use to generate wrapper code for the SOAP API. In Visual Studio 2005 or Visual Web Developer 2005 Express Edition, first create a new Web Site, and then import the eBay WSDL file by right-clicking the web site root in the Solution Explorer, then selecting Add Web Reference...:
In the Add Web Reference dialog, load the WSDL URL:
(Click image to zoom)
It takes a few minutes to load the WSDL and generate the stubs from it. Once the WSDL is loaded, click Add Reference. If you get impatient with this process, just think: all this generated code is saving me time!
The example we are creating displays the contents of your eBay watch list in a simple table. Create a new Web Form, and in the <div> element insert the following table:
<asp:Table BorderWidth="1" BorderStyle="Solid" ID="Table1"
<asp:TableCell Text="Time Left" Width="90" Font-Bold="true"
<asp:TableCell Text="Title" Width="120" Font-Bold="true">
<asp:TableCell Text="Price" Width="65" Font-Bold="true"
<asp:TableCell Text="Item ID" Width="80" Font-Bold="true"
The table headers are declared in the markup. The rest of the table rows with the watch list data will be added dynamically once the web service call is made.
The generated code allows you to make calls to any of the 100+ methods exposed by the eBay SOAP API. Once you have figured out how to make one eBay Web Service call, the rest is easy. The Page_Load method in the code behind file contains the following code that sets up the call (you'll find the complete code in the download that accompanies this article):
string endpoint = "https://api.ebay.com/wsapi";
string callName = "GetMyeBayBuying";
string siteId = "0";
string appId = "YOUR_APPID"; // use your app ID
string devId = "YOUR_DEVID"; // use your dev ID
string certId = "YOUR_CERTIFICATE"; // use your cert ID
string version = "437";
// Build the request URL
string requestURL = endpoint
+ "?callname=" + callName
+ "&siteid=" + siteId
+ "&appid=" + appId
+ "&version=" + version
// Create the service
eBayAPIInterfaceService service = new eBayAPIInterfaceService();
// Assign the request URL to the service locator.
service.Url = requestURL;
// Set credentials
service.RequesterCredentials = new CustomSecurityHeaderType();
service.RequesterCredentials.eBayAuthToken = "YOUR_TOKEN"; // use your token
service.RequesterCredentials.Credentials = new UserIdPasswordType();
service.RequesterCredentials.Credentials.AppId = appId;
service.RequesterCredentials.Credentials.DevId = devId;
service.RequesterCredentials.Credentials.AuthCert = certId;
Dim endpoint As String = "https://api.ebay.com/wsapi"
Dim callName As String = "GetMyeBayBuying"
Dim siteId As String = "0"
Dim appId As String = "YOUR_APPID" 'TODO: Enter your AppID
Dim devId As String = "YOUR_DEVID" 'TODO: Enter your DevID
Dim certId As String = "YOUR_CERTIFICATE" 'TODO: Enter your CertID
Dim version As String = "437"
' Build the request URL
Dim requestURL As String = endpoint _
& "?callname=" & callName _
& "&siteid=" & siteId _
& "&appid=" & appId _
& "&version=" & version _
' Create the service
Dim service As New eBayAPIInterfaceService()
' Assign the request URL to the service locator.
.Url = requestURL
' Set credentials
.RequesterCredentials = New CustomSecurityHeaderType()
.RequesterCredentials.eBayAuthToken = "YOUR_TOKEN" 'TODO: Enter your production token
.RequesterCredentials.Credentials = New UserIdPasswordType()
.AppId = appId
.DevId = devId
.AuthCert = certId
Replace the "YOUR" strings with the developer keys and authentication token that you retrieved earlier. This code sets the SOAP header with the authentication information and creates the URL parameters that are passed in.
The one line in this code that will change from call to call is this:
string callName = "GetMyeBayBuying";
Dim callName As String = "GetMyeBayBuying"
For whatever call you are making, set the callName accordingly.
The GetMyeBayBuying call retrieves all sorts of information about items you have purchased, items in your watch list, items you are bidding on, and more. The call to GetMyeBayBuying is very simple:
// Make the call to GetMyeBayBuying
GetMyeBayBuyingRequestType buyingRequest = new GetMyeBayBuyingRequestType();
ItemListCustomizationType watchListOptions = new ItemListCustomizationType();
watchListOptions.Sort = ItemSortTypeCodeType.TimeLeft;
buyingRequest.WatchList = watchListOptions;
buyingRequest.Version = version;
GetMyeBayBuyingResponseType buyingResponse = service.GetMyeBayBuying(buyingRequest);
ItemType items = buyingResponse.WatchList.ItemArray;
' Make the call to GetMyeBayBuying
Dim buyingRequest As New GetMyeBayBuyingRequestType()
Dim watchListOptions As New ItemListCustomizationType()
watchListOptions.Sort = ItemSortTypeCodeType.TimeLeft
buyingRequest.WatchList = watchListOptions
buyingRequest.Version = version
Dim buyingResponse As GetMyeBayBuyingResponseType = _
Dim items() As ItemType = buyingResponse.WatchList.ItemArray
The instance of GetMyeBayBuyingRequestType contains the call input options. To specify that we want to retrieve the contents of the watch list, we set the WatchList property with the ItemListCustomizationType options that we have created. We also set the Version property to the same version string as we are passing in the URL. The eBayAPIInterfaceService object contains a method for each call exposed by the SOAP API, and each method takes a "request type" object as a parameter. We pass in the request object that we've created and set the result to an instance of GetMyeBayBuyingResponseType. Finally, we extract the watch list items from the WatchList.ItemArray property of the response object, and set it to an array of ItemType.
Once we have retrieved the items, it is up to us to display the information we want or make further calculations:
// Add table rows
for (int i = 0; i < items.Length; i++)
TableCell timeLeftCell = new TableCell();
DateTime endTime = items[i].ListingDetails.EndTime;
DateTime now = DateTime.Now;
// Display that the item has ended, or how much time is left
if (endTime < now)
timeLeftCell.Text = "Ended";
TimeSpan timeLeft = endTime - now;
string timeLeftDisplay = "";
int days = timeLeft.Days;
if (days > 0)
timeLeftDisplay += days.ToString() + " days, ";
int hours = timeLeft.Hours;
if (hours > 0)
timeLeftDisplay += hours.ToString() + " hours";
int minutes = timeLeft.Minutes;
if (minutes > 0 && days == 0)
timeLeftDisplay += ", " + minutes.ToString() + " min";
int seconds = timeLeft.Seconds;
if (days == 0 && hours == 0)
timeLeftDisplay += ", " + seconds.ToString() + " sec";
timeLeftCell.Text = timeLeftDisplay;
// Display the item title
TableCell titleCell = new TableCell();
titleCell.Text = items[i].Title;
// Display the current price
TableCell currentPriceCell = new TableCell();
currentPriceCell.Text = items[i].SellingStatus.CurrentPrice.Value.ToString();
// Display the Item ID
TableCell itemIDCell = new TableCell();
itemIDCell.Text = "<a href=\"http://cgi.ebay.com/ws/eBayISAPI.dll?ViewItem&item="
+ items[i].ItemID + "\">" + items[i].ItemID + "</a>";
TableRow row = new TableRow();
if ((i % 2) == 1)
row.BackColor = System.Drawing.Color.LightGray;
' Add table rows
For i As Integer = 0 To items.Length - 1 Step i + 1
Dim timeLeftCell As New TableCell()
Dim endTime As DateTime = items(i).ListingDetails.EndTime
Dim now As DateTime = DateTime.Now
' Display that the item has ended, or how much time is left
If endTime < now Then
timeLeftCell.Text = "Ended"
Dim timeLeft As TimeSpan = endTime - now
Dim timeLeftDisplay As String = String.Empty
Dim days As Integer = timeLeft.Days
If days > 0 Then
timeLeftDisplay &= days.ToString() & " days, "
Dim hours As Integer = timeLeft.Hours
If hours > 0 Then
timeLeftDisplay &= hours.ToString() & " hours"
Dim minutes As Integer = timeLeft.Minutes
If minutes > 0 And days = 0 Then
timeLeftDisplay &= ", " & minutes.ToString() & " min"
Dim seconds As Integer = timeLeft.Seconds
If days = 0 And hours = 0 Then
timeLeftDisplay &= ", " & seconds.ToString() & " sec"
timeLeftCell.Text = timeLeftDisplay
' Display the item title
Dim titleCell As New TableCell()
titleCell.Text = items(i).Title
' Display the current price
Dim currentPriceCell As New TableCell()
currentPriceCell.Text = items(i).SellingStatus.CurrentPrice.Value.ToString()
' Display the Item ID
Dim itemIDCell As New TableCell()
itemIDCell.Text = "<a href=""http://cgi.ebay.com/ws/eBayISAPI.dll?ViewItem&item=" _
& items(i).ItemID & """>" & items(i).ItemID & "</a>"
Dim row As New TableRow()
If (i Mod 2) = 1 Then
row.BackColor = System.Drawing.Color.LightGray
The most complex code in this example actually has nothing to do with the web service call: the end time is passed back as a DateTime, but we want to show how much time is left for each item. First, for items that have not already ended, we calculate a TimeSpan between now and the end time. Then, we apply some simple heuristics on that TimeSpan to create a more friendly string representation. Modern platforms like .NET make it easy to get data from web services, so you'll often find yourself spending much more time manipulating the data that you've retrieved.
Each cell in the table row is represented by a TableCell object. For each field in each item that we retrieve, a TableCell is created and its Text property is populated with what we want to display. We then create a TableRow object and call the Add method on its Cells property. And last, we add the row to the Rows property on the Table1 object that is declared on the form.
That's it! With one simple form and little more than 100 lines of code, you have a working application that integrates with eBay Web Services to do something useful. In a future article I'll show you how to integrate other calls and use more sophisticated XML processing to add unique features not available in the standard eBay watch list.