Introduction

Notes: The most recent full SDK release is this eBay SDK for .NET Release.

Point releases, unlike full releases, do not go through the typical, full rounds of quality assurance. Point releases include bug fixes and updates to the wrapper classes. You can download this release and subsequent point releases from the eBay SDK for .NET download page.

Please see the most recent version of this Readme file, available at the Windows Developer Center.

Please note that upgrades to an SDK should always be done in a test environment. Additionally, before using a version of the SDK, please read this Readme file. Please also read the Trading API Release Notes (which contain tables showing schema changes that occur every two weeks) for all Trading API versions released after your current version. The Trading API Release Notes are located at the Windows Developer Center.

Contents
Release Information for the eBay SDK for .NET
General Information for the eBay SDK for .NET

Release Information for the eBay SDK for .NET

Important: Changes to the Trading API affect the SDK. For example, in schema version 499, deprecated objects in the schema were deleted, creating backward incompatibility. Please see the Trading API Release Notes for ongoing updates to the schema (including occasional removals of schema elements). Please also see Versioning Strategy and Deprecated Objects.

SDK Version 1113 .NET Release
SDK Version 1111 .NET Release
SDK Version 1109 .NET Release
SDK Version 107 .NET Release
SDK Version 1105 .NET Release
SDK Version 1103 .NET Release
SDK Version 1101 .NET Release
SDK Version 1099 .NET Release
SDK Version 1097 .NET Release
SDK Version 1111 .NET Release
SDK Version 1093 .NET Release
SDK Version 1091 .NET Release
SDK Version 1089 .NET Release
SDK Version 1087 .NET Release
SDK Version 1085 .NET Release
SDK Version 981 .NET Release
SDK Version 967 .NET Release
SDK Version 955 .NET Release
SDK Version 939 .NET Release
SDK Version 921 .NET Release
SDK Version 917 .NET Release
SDK Version 897 .NET Release
SDK Version 883 .NET Release
SDK Version 871 .NET Release
SDK Version 825 .NET Release
SDK Version 817 .NET Release
SDK Version 805 .NET Release
SDK Version 791 for .NET Point Release
SDK Version 787 for .NET Point Release
SDK Version 779 for .NET Point Release
SDK Version 775 for .NET Point Release
SDK Version 771 for .NET Full Release
SDK Version 747 for .NET Full Release
SDK Version 735 for .NET Point Release
SDK Version 715 for .NET Point Release
SDK Version 705 for .NET Point Release
SDK Version 687 for .NET Full Release
SDK Version 673 for .NET Full Release
SDK Version 661 for .NET Full Release
SDK Version 639 for .NET Beta Full Release
SDK Version 631 for .NET Beta Full Release
SDK Version 623 for .NET Beta Point Release
SDK Version 615 for .NET Beta Release
SDK Version 603 for .NET Point Release
SDK Version 595 for .NET Full Release
SDK Version 581 for .NET Point Release
SDK Version 575 for .NET Point Release
SDK Version 561 and Subsequent Point Releases
SDK Version 549 and Subsequent Point Releases
SDK Version 523 and Subsequent Point Releases
SDK Version 511 and Subsequent Point Releases
SDK Version 503 for .NET Point Release
SDK Version 495 for .NET Full Release
SDK Version 485 and Subsequent Point Releases
SDK Version 479 and Subsequent Point Releases
SDK Version 471 and Subsequent Point Releases
SDK Version 465 and Subsequent Point Releases
SDK Version 459 and Subsequent Point Releases
Pre-Version-459 of the SDK

SDK Version 1113 Release

This release is compatible with eBay's 1113 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1111 Release

This release is compatible with eBay's 1111 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1109 Release

This release is compatible with eBay's 1109 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1107 Release

This release is compatible with eBay's 1107 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1105 Release

This release is compatible with eBay's 1105 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1103 Release

This release is compatible with eBay's 1103 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1101 Release

This release is compatible with eBay's 1101 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1099 Release

This release is compatible with eBay's 1099 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1097 Release

This release is compatible with eBay's 1097 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1095 Release

This release is compatible with eBay's 1095 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1093 Release

This release is compatible with eBay's 1093 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1091 Release

This release is compatible with eBay's 1091 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1089 Release

This release is compatible with eBay's 1089 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1087 Release

This release is compatible with eBay's 1087 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 1085 Release

This release is compatible with eBay's 1085 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 981 Release

This release is compatible with eBay's 981 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 967 Release

This release is compatible with eBay's 967 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 955 Release

This release is compatible with eBay's 955 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 939 Release

This release is compatible with eBay's 939 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 921 Release

This release is compatible with eBay's 921 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 917 Release

This release is compatible with eBay's 917 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 897 Release

This release is compatible with eBay's 897 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 883 Release

This release is compatible with eBay's 883 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 871 Release

This release is compatible with eBay's 871 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 825 Release

This release is compatible with eBay's 825 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 817 Release

This release is compatible with eBay's 817 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 805 Release

This release is compatible with eBay's 805 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 791 for Point Release

This release is compatible with eBay's 791 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 787 for Point Release

This release is compatible with eBay's 787 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 779 for Point Release

This release is compatible with eBay's 779 Trading WSDL. New features available in the API since the last SDK release are support for the new Global Exchange Program that simplifies International Shipping (Release 777) and the introduction of additional eBay Motors Vehicle Features in GetCategoryFeatures (Release 779). Please refer to the Trading API Release Notes for a detailed list of the new features and elements.

SDK Version 775 for Point Release

This release is compatible with eBay's 775 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new features and elements.

SDK Version 771 for Full Release

This release is compatible with eBay's 771 Trading WSDL. Please refer to the Trading API Release Notes for a detailed list of the new calls and elements.

AddItem sample series illustrating usage of Seller Profile

The consoleAddItem, consoleAddFixedPriceItem samples have been modified to use Seller Profile to specify Payment, Shipping, and Return Policy Values. Seller profiles are created using the Business Policies Management API. Using this API sellers can create and manage multiple shipping, return, and payment policies and apply these policies to listings just by referencing the policy ID at listing time. Business Policies are currently available for testing in the Sandbox environment.

AttributesDemo sample modified to use only ItemSpecifics

eBay has been moving from the ID-based Attributes model to the Item Specifics model. All remaining categories that supported attributes will drop support for Id based attributes by May, 2012. The sample project has been accordingly modified to use only item specifics.

SDK Version 747 for Full Release

This release is compatible with eBay's 747 Trading WSDL, and supports the following new features.

New LocalPickup Flag for GetMyEbayBuying and GetMyEbaySelling Calls

The LocalPickup flag indicates whether the buyer has selected local pickup as the shipping option or the seller has made local pickup available as a shipping option.

New SoldAsBin Flag in GetItem

New SoldAsBin flag in GetItem call indicates when an auction listing has ended before the stated auction end time due to a buyer using the Buy It Now option to purchase the item.

New Charity Refund Request Preference

New AutoOptDonationRefund flag in SetUserPreferences call allows a seller to request that eBay automatically request eBay Giving Works donation refunds after Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. This preference is only applicable to charity listings.

Coming Soon: Motors Subtitle and Deposit Fields Replacing Attributes

eBay has added three new fields (SellerProvidedTitle, DepositAmount, and DepositType) to AddItem and related calls. These fields will soon replace the US and Canada eBay Motors Subtitle attribute (10246), and the US eBay Motors deposit amount and type attributes (10733 and 10734). The attributes will continue to work for a period of time to give developers time to migrate to the new fields. Keep an eye on these release notes for information about when the new fields will be functional.

Two New Member Message Types Added for Classified Ad Listings

ClassifiedsContactSeller and ClassifiedsBestOffer added as new message types. ClassifiedsContactSeller indicates that an inquiry has been sent to the seller regarding the corresponding classified ad listing. ClassifiedsBestOffer indicates that a best offer has been made on the seller's corresponding classified ad listing.

New Payment Status Value Added

A new value of "Paid" can now be returned in GetOrders (and other order retrieval calls) when checkout is complete and order has been paid for by the buyer. This value is returned in the CheckoutStatus.eBayPaymentStatus field. This value may also be returned in the MyeBaySelling and MyeBayBuying calls.

New Dispute Explanation Added

A new dispute explanation was added and available to use through the AddDispute call. The value is "SellerRanOutOfStock", and this value can be used by the seller when cancelling an order due to an item being out of stock.

GetOrders Now Retrieves Seller's Item and Shipping Discounts

Information on one or more item or shipping discounts can now be retrieved using GetOrders and other order retrieval calls.

Product Identifier Features Now Returned in GetCategoryFeautures

Call GetCategoryFeatures to see if a site or category supports the ability to pass in Brand/MPN, EAN, ISBN, or UPC values in an Add/Revise/Relist call.

Other New Features and Changed Functionality

Please refer to the Trading API Release Notes for a detailed list of the new calls and elements since the previous SDK release


Back to top

SDK Version 735 for .NET Point Release

This release is compatible with eBay's 735 Trading WSDL. There are no new features.

New Calls and Fields

This SDK now supports the Strike Through Price(STP)/ Minimum Advertised Price(MAP) setting on AddItem and related calls. See the Trading Call Reference to learn about Item.DiscountPriceInfoType.

GeteBayDetails returns MoneyBackOrExchange in RefundOption, and you can pass it in to AddItem family and related calls.


Back to top

SDK Version 715 for .NET Point Release

This release is compatible with eBay's 715 Trading WSDL, and has the following features.

Replacement of Deprecated Search Functionality

The search calls GetSearchResults and GetCategoryListings are now deprecated in the Trading API (see Trading API Release Notes for details).

This point release replaces the deprecated functionality by supplying a Finding Kit that shows how to use equivalent calls in the Finding API. The Finding Kit includes a Finding API proxy, samples, and tutorials. You can download the Finding Kit here: http://developer.ebay.com/DevZone/codebase/dotnetsdk/FindingKitDotNet_1.0.zip .

SDK Version 705 for .NET Point Release

This release is compatible with eBay's 705 Trading WSDL. There are no new features.


Back to top

SDK Version 687 for .NET Full Release

This release is compatible with eBay's 687 Trading WSDL, and contains the following new features.

New and Improved Samples and Tutorials

The consoleAddItem sample has been expanded to show how to set item specifics.

A consoleAddFixedPriceItem sample has been added. It shows how to set item variations.

New Multi-threading Instructions

A Notes About Multi-Thread section is added in the readme. It explains how to tune the .NET framework's HTTP connection limitations for better performance for multi-thread applications.


Back to top

SDK Version 673 for .NET Full Release

This release is compatible with eBay's 673 Trading WSDL, and contains support for the following new features.

New Calls and Fields

This SDK now supports the ConditionID setting on AddItem and related calls. See the Trading Call Reference to learn about Item.ConditionID.

New Samples and Tutorials

New C# and VB.Net console samples, suitable for getting started using the SDK, are added to the SDK with this release. They are called helloWorld and consoleAddItem, and they are accompanied by tutorials.

A new VB.Net upload picture sample is also added to the VB.Net SoapApiDemo sample.


Back to top

SDK Version 661 for .NET Full Release

This release is compatible with eBay's 661 Trading WSDL, and contains support for the following new features.

New Calls and Fields

The VerifyRelistItem and ExtendSiteHostedPictures calls, as well as a new VerifyOnly field for the ReviseItem call have been introduced in this release. Please refer to the Trading API Release Notes for a detailed list of the new calls and elements.

Updated apiCallDemo Sample

A new UploadPictures sample has been added in the apiCallsDemo. This sample shows how to use the eBay Picture Service (EPS) to upload pictures.

Assemblies Have Updated Trust Levels

Per your request, we updated the trust level of the .NetSDK assemblies ([assembly: AllowPartiallyTrustedCallers] has been added in all .NetSDK assemblies). This may be helpful for those who want to host their applications on a shared hosting environment.


Back to top

SDK Version 639 for .NET Beta Full Release

This release is compatible with eBay's 639 Trading WSDL, and contains support for the following new features.

Compatability with Microsoft Visual Studio 2008

Native Support for Microsoft's Visual Studio 2008 and DotNET 3.5

This release no longer supports Microsoft Visual Studio 2003 and .NET 1.1, but is backward compatible with Visual Studio 2005 and DotNET 2.0.

Now the complete code source, all samples, and utilities have been re-built using Microsoft's Visual Studio 2008 and .NET 3.5. Note that with Visual Studio 2008, you can use any of the following .NET Frameworks: 2.0, 3.0, 3.5, Silverlight CoreCLR, or .NET Compact Framework.

This release includes:

New C# Winforms Attribute Sample

A new C#/Winform attributesDemo sample has been added in the SDK. This sample simulates a simple Sell Your Item(SYI) flow, it shows how to use eBay API/SDK to:

For detailed architecture and call flow of the sample, please refer to the readme in the sample folder.


Back to top

SDK Version 631 for .NET Beta Full Release

This release is compatible with eBay's 631 Trading WSDL, and contains support for the following new features.

New Helper Class for HTTP Proxy Settings

ApiContext class has been enhanced to support HTTP Proxy Setting for those who access the eBay API using a proxy server and want to configure the proxy settings programmatically. For examples of usage, please refer to the apiCallsDemo sample.

New DetailsDownloader Helper Class

The new DetailsDownloader.cs, helper class shows you how to cache eBay details locally.

Most Calls Can Be Made with Tokens Only

With the exception of, GetTokenStatus, RevokeToken, GetSessionID, and FetchToken, all SDK API calls can now be made with an eBay API developer token (instead of full eBay API developer credentials.)

Additional NANT Script Now Supports .NET 2.0

A NAnt build script (that supports .NET 2.0/VS2005 build) has been included for advanced users (users who prefer building from the command line instead of building with Microsoft Visual Studio).


Back to top

SDK Version 623 for .NET Beta Point Release

This release is compatible with eBay's 623 Trading WSDL, and does not contain new features.


Back to top

SDK Version 615 for .NET Beta Release

This release is compatible with eBay's 615 Trading WSDL, and contains support for the following new features.

Native Support for Microsoft's Visual Studio 2005 and DotNET 2.0

This release no longer supports Microsoft Visual Studio 2003 and .NET 1.1. Now the complete code source, all samples, and utilities have been re-built using Microsoft's Visual Studio 2005 and .NET 2.0.

This release was also tested with Microsoft's Visual Studio 2008, so it is unofficially supported as follows:

Complete Testing with Microsoft's Vista Operating System

The complete code source, all samples, and utilities have been tested with the Microsoft Vista 32-bit Operating System.

Vista Install Script

This release features a new installer script that runs on both XP and Vista operating systems. The installer will determine whether you have Microsoft's .NET Framework 2.0 installed, and will ask you to install the framework if it is not detected.

Before you can use SDK with Microsoft's Visual Studio 2005 in the Vista Operating System, you need to:

Support for the AddFixedPriceItem Family of Calls

Four new wrapper classes, AddFixedPriceItem, ReviseFixedPriceItem, RelistFixedPriceItem and AddFixedPriceItem, have been added in this release. These classes can be used as single calls within a method, or they can be used within data files in the Large Merchant Services solution .



Back to top

SDK Version 603 for .NET Point Release

This release is compatible with eBay's 603 Trading WSDL, and contains support for the following new features.

New Helper Classes

Two new helper classes, CategoriesDownloader.cs and FeaturesDownloader.cs , have been added in this release. The CategoriesDownloader.cs class caches eBay Category information to a local disk. The FeaturesDownloader.cs class caches the eBay Category Feature information to a local disk. Using these classes, you can access category information without repeatedly making GetCategory and GetCategoryFeatures requests.

Updated AttributesDemo Samples to Cache Meta-data

The AttributesDemo sample has been updated to take advantage of the new helper classes, so that you can see how to cache the eBay categories and features in a local repository.

The SampleShippingApplication sample has also been updated to use the new helper classes, so that you can see how to cache the eBay categories and features specifically for a shipping application.

eBayAccount Class Returned

The eBayAccount class was removed as part of a code clean-up in Release 595. It has been added back into the code for this release. It is also available as a downloadable patch for Release 595.


Back to top

SDK Version 595 for .NET Full Release

This release is compatible with eBay's 595 Trading WSDL, and contains support for the following new features.

Key Features of This Release

With this release, we provide full support for Microsoft's .NET 2.0 platform (.NET SDK). This version of eBay's SDK for .NET also still supports .NET 1.1.

Build Information:

As of this release, you can now use eBay's SDK for .NET with Microsoft's Vista operating system, provided that you:

Comments:

UploadSiteHostedPicture

Since the classes in the eBay Picture Service (EPS) have been replaced by the UploadSiteHostedPictures Trading API (XML) call, the DotNET SDK now supports the UploadSiteHostedPictures call. Because this is a Trading API call, you will need to provide an eBay developer authorization token (that you obtain with your application keys) when making this call.

The UploadSiteHostedPictures call is the only call in the Trading API that doesn't support SOAP. Therefore, you need to use the following (XML) endpoints (Gateway URLs):

In addition, it is important that you use these endpoints for both the production and sandbox environments. The addresses for both environments must be consistent because you will need to update the authorization token in your ApiContext class before switching from one platform to the other (Trading API (XML) and SDK servers use different authorization keys.)

You can still use the EPS libraries with this release, but they will eventually be discontinued, so we recommend that you migrate to the newer call as soon as you can. The UploadSiteHostedPictures call enables you to upload files in image formats such as JPG by including a binary attachment after the XML input, as part of the request. The call returns SiteHostedPictureDetails.FullURL, which must be stored by your application (for associating the picture using the Item.PictureDetails.PictureURL field of AddItem, ReviseItem, or RelistItem).

For more information, please see the following:

Selling Manager Pro (SMP) calls are supported in this release.

Support for ProPay

This release also includes support for the ProPay payment method. ProPay is a third party application that allows small businesses to accept credit cards. For more information about ProPay, see www.ProPay.com. For more information about accepted eBay payment methods, see BuyerPaymentMethodCodeType in the Trading Call Reference.

Updates to SDK Samples

An updated ASP attributeDemo sample includes return policy information that is integrated with the rest of the Item details, instead of being posted on a separate page. It also includes a dynamic lookup feature for Shipping Service, Payment Methods, Listing Type, and Listing Duration. This sample demonstrates the usage of eBay Custom Item Specifics with the Trading API GetCategoryFeatures and GetCategorySpecifics calls.

Please note that for Return Policy and for the requirement to specify shipping, some samples contain hard-coded fields. Therefore, if you want to change the target site used in the sample, you must integrate GetCategoryFeaturesCall and GeteBayDetailsCall into the sample. For important information, see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center .

Documentation of Recent API Features

For important information about the latest API features, including new requirements for listings , please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center .

Removal of Legacy XML Classes

As of this release, all legacy XML classes and calls have been removed. The new UploadSiteHostedPictures call is the only remaining XML call.


Back to top

SDK Version 581 for .NET Point Release

This release contains API feature updates and documentation and sample updates

Documentation of Recent API Features Available

For important information about the latest API features, including new requirements for listings , please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center .

Recent API Feature Updates

The eBay SDK for .NET contains updated wrapper classes, updated test cases, and other updates that facilitate your use of recent API features. Changes include updates to user token retrieval and deprecation of eBay Express .

Updates to SDK Samples

Some SDK samples are updated based on recent API features. Please note that for Return Policy and for the requirement to specify shipping, some samples contain hard-coded fields. Therefore, if you want to change the target site used in the sample, you must integrate GetCategoryFeaturesCall and GeteBayDetailsCall into the sample. For important information, see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center .


Back to top

SDK Version 575 and Subsequent Point Releases

This feature supports .NET 2.0 and provides API feature updates.

Support for Microsoft .NET Framework version 2.0

Beginning with this release, the SDK will only support Microsoft .NET Framework versions 1.1 and 2.0 (not version 1.0 , which Microsoft has retired).

If you are still using version 1.0, please update your .NET Framework version. This may require that you upgrade your integrated development environment.

Recent API Feature Updates

The eBay SDK for .NET contains updated wrapper classes, updated test cases, and other updates that facilitate your use of recent features of the API.

Documentation of Recent API Features Available

For information about the latest API features, please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center .


Back to top

SDK Version 561 and Subsequent Point Releases

This release provides new authentication features and new wrapper classes.

User Authentication Improvements

The eBay SDK for .NET includes the user-authentication improvements released with Trading API version 557. For information about these improvements, see the Release Notes for version 557 of the Trading API and see Authentication and Authorization .

The SDK changes include 3 new wrapper classes (GetSessionIDCall, GetTokenStatusCall, and RevokeTokenCall) and new FetchTokenCall functionality. Please use the new FetchTokenCall functionality in your application. The SoapApiDemo samples for both C# and VB.NET are updated with the new FetchTokenCall functionality. The C# SoapApiDemo sample is updated to show uses of the 3 new wrapper classes. The VB.NET SoapApiDemo sample is updated to show the use of GetTokenStatusCall.

Code Generator Improvements

The code generator in ...\SDKInstallDir\Code Generator is easier to use and no longer generates stubs for non-SOAP calls.

Visual Basic 6 Sample Removed

The Visual Basic 6 sample (formerly under ...\SDKInstallDir\Samples\VB6) has been removed from the SDK. Please see the VB.NET sample (under ...\SDKInstallDir\Samples\VB.NET) instead.

Recent API Feature Updates

The eBay SDK for .NET contains updated wrapper classes, updated test cases, and other updates that facilitate your use of recent features of the API.

Documentation of Recent API Features Available

For information about the latest API features, please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center .


Back to top

SDK Version 549 and Subsequent Point Releases

This release supports sitewide attributes.

Attributes Library Supports Sitewide Attribute Sets

The Attributes Library in the SDK now supports downloading and rendering sitewide characteristic sets. This enables you to include sitewide attributes in listings.

On many sites, you use sitewide attribute sets to fill in an item's Return Policy fields, the Item Condition field, or both. Some categories may support zero, one, or both of these sets (as indicated in each sitewide set's "exclude list").

The changes described here assume you are already familiar with the Attributes Library. (For information about working with the Attributes Library, see The Attributes API.)

In the IAttributesMaster interface and AttributesMaster class, these new methods have been defined:

Also, in the AttributesMaster class, the RenderHtml() method has been overloaded to support rendering Return Policy fields (using eBay's XSL stylesheet). This method checks whether the data is for a return policy, and adds the pageId attribute to the SelectedAttributes node if it is.

Note: In a few cases, the Item Condition attribute may appear twice when you render standard and sitewide data for a category (please inform eBay if this occurs). This occurs when a category is mapped to a standard characteristic set that defines an Item Condition attribute locally, and the category is also mapped to a sitewide Item Condition characteristic set. To avoid unexpected results, the seller should either use the local Item Condition defined in the standard set, or you should make sure the same value is used for both when you list the item.

A few helper methods have been added to or modified in IAttributesXmlProvider and AttributesXmlDownloader:

A few helper methods have also been added to ICategoryCSProvider and CategoryCSDownloader:

Before CategoryCSDownloader downloads sitewide characteristic sets, it checks to see what version of the metadata is already stored locally and compares it to the version on the site. If the version on the site is different, or if the metadata isn't stored locally, it downloads the appropriate metadata from the site and stores it in the local file system. These are the filename conventions (where version is the metadata version, not the request version):

Sitewide characteristic set mapping (all categories) site.ALL.version.swcs
Sitewide characteristic set mapping (one category) site.categoryID.version.swcs
site.categoryID.version.

Here are a few cases that may be helpful when you're testing sitewide attributes in the Sandbox:

For a sample that uses the new functionality in the Attributes library, see C:\Program Files\eBay\SDKInstallDir\Samples\ASP.NET\AttributesDemo and the Readme file for that sample.


Back to top

SDK Version 523 and Subsequent Point Releases

This release provides an enhanced attributes library.

Attributes Library Enhanced

The Attributes Library now gives you the option to store attribute metadata locally, and only download updates for a site if a newer version exists on the site. Each provider includes one or more Get methods for this purpose. In the downloader classes that implement these provider interfaces, these methods check to see what version of the metadata is already stored locally and compare it to the version on the site. If the version on the site is different, or if the metadata isn't stored locally, these Get methods download the appropriate metadata from the site and store it in the local file system.

These are the filename conventions (where version is the metadata version, not the request version):

XSL file site.version.attrxsl
Category-to-CS mappings (all categories) site.ALL.version.catcs
Category-to-CS mappings (one category) site.categoryID.version.catcs
Attributes CS (all sets) site.ALL.version.attrcs
Attributes CS (one or more sets) site.CSIdHashcode.version.attrcs

For example, if you retrieve a full attribute metadata XML file from the UK site (without specifying a particular CSId), and the attribute system version is 8005, the filename would be: UK.ALL.8005.attrcs.

If you retrieve attribute metadata for one or more CSIds, the downloader creates a hashcode for the set (the sum of the IDs), and uses that value in the filename.

The downloader saves these files in the C:\temp directory.

Important: You can delete these locally stored files, but if you edit or rename them, your application may fail.

Alternatively, each provider includes Download methods to enable you to force a full download of the metadata without checking the version. In the downloader classes, these methods store the metadata in memory only.

For more information about working with the Attributes Library, see The Attributes API. For a sample that uses the new functionality in the Attributes library, see C:\Program Files\eBay\SDKInstallDir\Samples\ASP.NET\AttributesDemo and the Readme file for that sample.

Also note that the following (existing) class and interface definitions have been moved from the AttributesMaster.cs file to individual files in eBay.Service.SDK.Attribute.

Recent API Feature Updates

The eBay SDK for .NET contains updated wrapper classes, updated test cases, and other updates that facilitate your use of recent features of the API.

Documentation of Recent API Features Available

For information about the latest API features, please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center .

Removal of Sample

The following sample (formerly under ...\SDKInstallDir\Samples\C#) has been removed from the SDK: SamplePaymentApplication.


Back to top

SDK Version 511 and Subsequent Point Releases

This release provides new helper classes.

Changes to Download Location and to Documentation

The eBay SDK for .NET no longer is available in the Community Codebase. Instead, it is available on the eBay SDK for .NET download page. The 511 version includes the 511 NDoc.

For information about the latest API features, please see the Trading API Release Notes and the Trading Web Services API Guide at the Windows Developer Center. The Trading Web Services API Guide replaces the eBay SDK for .NET Guide.

No Wrapper Class Currently Available for the UploadSiteHostedPictures Call

Schema version 513 introduced a new XML API call (UploadSiteHostedPictures) for uploading pictures for listings. Availability of this call in the SOAP API is planned for a future date, to be announced. Until this call is available in the SOAP API, no wrapper class will be available for this call in the SDK.

Deletions of Deprecated Fields and Calls

Many deprecated calls and fields were deleted in WSDL version 499. Due to the large number of deletions , SDK Version 511 is not backward compatible.

Helper Classes Available for GetCategoryFeaturesCall and GeteBayDetailsCall

You can use two new helper classes (in ...\SDKInstallDir\Source\eBay.Service.SDK\Util) for storing the data returned by GetCategoryFeaturesCall and GeteBayDetailsCall.

SampleSellingApplication Not Compatible with This SDK Version

The sample titled SampleSellingApplication (in ...\SDKInstallDir\Samples\C#\SampleSellingApplication) is not compatible with this SDK version.

Removal of Two Samples

The following samples (formerly under ...\SDKInstallDir\Samples\C#) have been removed from the SDK: AttributeBulkEditorControl and AttributeBulkEditorDemo.


Back to top

SDK Version 503 for .NET Point Release

This release deprecates several calls and provides API feature updates.

Deletions of Deprecated Fields and Calls

Due to a large number of deletions from version 499 of the schema, SDK version 503 is not backward compatible. Deprecated calls and fields were deleted on schema version 499 .

For information about SDK changes, please see the NDoc installed in the C:\Program Files\eBay\SDKInstallDir\docs\LibRef folder. Additional information about schema deletions is in the Deprecated Objects page in the Input/Output Reference. Please also read the eBay Schema Versioning Strategy page.

Recent API Feature Updates

This SDK point release contains updated wrapper classes and other updates that facilitate your use of new API features. The following features, described in the Trading API Release Notes, are among the API features included in this SDK release:

Update to Shipping Discount Profiles Feature on API Version 505

In the Shipping Discount Profiles feature, changes to WSDL elements were made on API version 505. To use the Shipping Discount Profiles feature, please update your SDK to WSDL version 505 or later.

Update to CurrencyUtility Class

The GetDefaultCurrencyCodeType method of the CurrencyUtility class has been updated to return currencies for newer eBay sites.


Back to top

SDK Version 495 for .NET Full Release

This release provides API feature updates.

Recent API Feature Updates

The eBay SDK for .NET contains updated wrapper classes, updated test cases, and other updates that facilitate your use of recent features of the API.

GetMyeBayCall Removed

The GetMyeBayCall wrapper class has been removed from the SDK due to deprecation of the underlying request/response elements in the schema. For more information about deprecated elements, please see the Versioning Strategy and Versioning Summary. Additionally, the GetMyeBay code has been removed from sample code.

References to SiteHostedPicture and VendorHostedPicture Removed

The PictureDetails field replaced the SiteHostedPicture and VendorHostedPicture fields in the API. Therefore, references in sample code to SiteHostedPicture and VendorHostedPicture have been removed from the SDK. For information about when the PictureDetails field replaced the SiteHostedPicture and VendorHostedPicture fields, please see the Versioning Summary.

Updated Samples

Four dialog boxes, including dialog boxes for use of GetCartCall and SetCartCall, have been added to the SoapApiDemo sample (C:\Program Files\eBay\SDKInstallDir\Samples\C#\SoapApiDemo).

Consolidation of Multi-Call Test Programs

The multi-call test programs delivered with the SDK have been consolidated. They require only a single compilation after you have opened TestScenarios.sln in C:\Program Files\eBay\SDKInstallDir\Source\SanityTest\TestScenarios. Additionally, they use only one Account Settings dialog box.

Multi-Call Test Programs for Adding Orders and for Retrieving Shipping Information

Multi-call test programs for adding orders and for retrieving shipping information have been added to the SDK. To run the test programs, use TestScenarios.sln in C:\Program Files\eBay\SDKInstallDir\Source\SanityTest\TestScenarios.

GetCharitiesCall Wrapper Class Updated

The GetCharitiesCall wrapper class can be used without any call-specific input fields in order to retrieve all charity nonprofit organizations. Formerly, at least one call-specific input field was required in the wrapper class.


Back to top

SDK Version 485 and Subsequent Point Releases

This release provides logging and performance helpers.

Control Payload Logging

You can use the new ExceptionFilter class to specify several types of logging. You can specify logging in cases of specific API errors and HTTP status codes. You also can specify logging in general cases of API exceptions and HTTP exceptions. The new logging feature makes logging more useful and reduces the size of your logs.

The FrmMain.cs file in the SOAPApiDemo sample (at C:\Program Files\eBay\SDKInstallDir\Samples\C#\SoapApiDemo) shows one way to use the new ExceptionFilter class. To use the new logging feature for a program, you can add values from C:\Program Files\eBay\SDKInstallDir\Source\Helper\AppSettingHelper.cs to the app.config file for the program. To see an example of how to log only calls resulting in HTTP status codes 404 and 502, add the following line to the app.config file of SoapApiDemo (case insensitive):

<add key="LogPayloadHttpStatusCodes" value="404;502"/>
To see an example of how to log only calls resulting in error codes 17 and 124, add the following line to the app.config file of SoapApiDemo:
<add key="LogPayloadErrorCodes" value="17;124"/>
To see an example of how to log only calls resulting generally in API exceptions, add the following line to the app.config file of SoapApiDemo:
<add key="LogPayloadExceptions" value="ApiException"/>
To see an example of how to log only calls resulting generally in HTTP exceptions, add the following line to the app.config file of SoapApiDemo:
<add key="LogPayloadExceptions" value="HttpException"/>
To see an example of how to log only calls resulting generally in API and HTTP exceptions, add the following line to the app.config file of SoapApiDemo:
<add key="LogPayloadExceptions" value="ApiException;HttpException"/>

Reporting for Performance Latencies

Enhancements to core SDK files can help you determine the time needed for each phase of a SOAP API call (client-side phases for encoding and decoding, network-transport phases, and server-side phase).

For an example of how to use the enhancements, see the MultiThread sample (C:\Program Files\eBay\SDKInstallDir\Samples\C#\MultiThread).

Multi-Call Test Programs Added for Leaving Feedback and Getting Item Transactions

Multi-call test programs for leaving feedback and getting item transactions have been added to the SDK.

To run the test programs, use the following solution file: C:\Program Files\eBay\SDKInstallDir\Source\SanityTest\testscenarios\SanityTestScenarios.sln.

The folders of the new programs are in the following folder: C:\Program Files\eBay\SDKInstallDir\Source\SanityTest\testscenarios. The new program that shows one way to test LeaveFeedbackCall is in the SanityTestSNR2 folder. The new program that shows one way to test GetItemTransactionsCall is in the SanityTestSNR3 folder.

AddMemberMessage Removed from WSDL

AddMemberMessage was removed from the WSDL on version 481. As previously announced, this call has been replaced by AddMemberMessageAAQToPartner, AddMemberMessageRTQ, and AddMemberMessagesAAQToBidder. For information about schema changes, please see the Trading API Release Notes (which contain tables showing the schema changes that occur every two weeks) at the Developer Documentation Center .


Back to top

SDK Version 479 and Subsequent Point Releases

This release updates the attributes library and updates the API features.

Attributes Library Updated

The validation rule logic in the Attributes Library (C:\Program Files\eBay\SDKInstallDir\Source\eBay.Service.SDK.Attribute) has been updated to match the current site logic. For information about updates to the Attributes Library, see Attributes Library Notes . The next release of the Trading API documentation will be updated to reflect the same changes.

Sanity Test Suite Improved

The reliability of the Sanity Test suite (under the Source\SanityTest folder) has been improved. You can use the Sanity Test suite for simple testing after you change code in the SDK.

Recent API Feature Updates

The eBay SDK for .NET contains wrapper classes and other updates that facilitate your use of recent features of the API.

Database Sample Removed

The eBay SDK for .NET no longer includes the database sample. In past releases, the database sample was installed at the following location: C:\Program Files\eBay\SDKInstallDir\Samples\C#\DatabaseSample. Additionally, references in other samples to the database sample have been removed. However, the compiled version of the database sample, eBay.Service.SDK.Integration.dll, is available in the following location: C:\Program Files\eBay\SDKInstallDir\eBay.Service.SDK.Integration.dll. In pre-459 releases, the database sample files were referred to as the "integration library." Please note that if you regenerate eBay.snk and then rebuild ebay.Service.dll, errors can occur if you compile and run a sample that depends on the database sample.


Back to top

SDK Version 471 and Subsequent Point Releases

This release adds new samples and call retry helpers.

Commands for Registering Some Files Were Moved

Commands in C:\Program Files\eBay\SDKInstallDir\RegSDK.bat for registering eBay.Service.SDK.Integration.dll and AttributeBulkEditBox.dll have been moved to C:\Program Files\eBay\SDKInstallDir\Samples\C#\RegSDKSample.bat.

Multi-Call Test Program Added

A multi-call test program demonstrates a scenario that uses 8 different API calls involving data of a single item listing. To run the multi-call test program, use the following solution file: C:\Program Files\eBay\SDKInstallDir\Source\SanityTest\testscenarios\SanityTestScenarios.sln.

Call Retry for HTTP Errors

You can use updates to the CallRetry and ApiException classes to detect HTTP errors and subsequently perform call retry. Specifically, you can implement call retry in response to 502 HTTP errors, 404 HTTP errors, and related HTTP errors from a web server. In the SoapApiDemo sample, at C:\Program Files\eBay\SDKInstallDir\Samples\C#\SoapApiDemo, updates to FrmGetItem.cs, including a GetCallRetry method, show one way to use the new functionality of the CallRetry class.

StoresFixedPrice Tag To Be Obsolete

The StoresFixedPrice tag, currently available for international sites, will soon be obsolete. The 471 API schema released in late July contained additions to ItemTypeFilterCodeType that apply to searches with GetSearchResults and GetCategoryListings. The additions to ItemTypeFilterCodeType must be used instead of the StoresFixedPrice tag. For more information, please see the Trading API Release Notes (which contain tables showing schema changes that occur every two weeks) at the Developer Documentation Center.


Back to top

SDK Version 465 and Subsequent Point Releases

This release adds wrapper classes and new Time classes.

AddItemCall, Other Calls Store Images in a PictureDetails Container

The following wrapper classes now store images in a PictureDetails container, by default: AddItemCall, VerifyAddItemCall, RelistItemCall, and AddLiveAuctionItemCall. Formerly, a SiteHostedPicture container was used. If you want your application to continue using a SiteHostedPicture container, set the UseDeprecatedPictureStructure property of the wrapper class to true. Note that SiteHostedPicture is deprecated. Applications eventually will have to use PictureDetails because with API version 439 and higher, PictureDetails is used for pictures associated with an item.

Class for Specifying Time Values Improved

The following properties are added to the TimeFilter class: TimeFilter.TimeFromUTC and TimeFilter.TimeToUTC. For more information, see Note About Time Values .

Invalid Codetype Values Provided

An exception resulting from an invalid codetype value now includes the text of the specific value that caused the exception.


Back to top

SDK Version 459 and Subsequent Point Releases

This release changes the name of the integratio library.

Name of Integration Library Changed

The name of the integration library has been changed to "Database Sample." The name change includes a change to the name of the folder containing the sample; the name of the eBay.Service.SDK.Integration folder has been changed to DatabaseSample. The sample is meant solely to show one way to store and access eBay data.


Back to top

Pre-Version-459 of the SDK

This topic discusses the pre 459 versions of the SDK.

Pre-Version-459 Changes

Please see the Past Releases section of the Release Notes in the following GZ file: eBayDotNETSDKAPIAllDocs459.tar.gz.


Back to top

Back to top

User-Contributed Notes

   
 
 
 

© 2009–2011 eBay Inc. All rights reserved.
eBay and the eBay logo are registered trademarks of eBay Inc.
All other brands are the property of their respective owners.