Please note the following important information:
Contents |
---|
Release Information for the eBay SDK for Java |
Installation Instructions |
General Information for the eBay SDK for Java |
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. 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.
This release is compatible with eBay's 1131 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
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.
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.
This release is compatible with eBay's 1065 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
With release 1055, the Java Trading API SDK supports OAuth for authentication. eBay uses the OAuth 2.0 protocol only for authorizing the eBay Buy and Sell RESTful APIs. Now, OAuth can be used with the Trading API, as well. With the Trading API, all calls use the authorization code grant type, meaning users must go through the sign-in flow to grant permission to the application to make calls on their behalf. Please refer to the Using OAuth with the eBay traditional APIs for more information.
Using OAuth with the SDK
eBay uses the OAuth 2.0 protocol for authorizing the eBay Buy and Sell RESTful APIs. eBay’s OAuth implementation can also be used with the Trading API. With the Trading API, all calls use the authorization code grant type, meaning users must go through the sign-in flow to grant permission to the application to make calls on their behalf. For details about using authorization code grant type to retrieve access tokens, see Getting User Tokens in the Using eBay RESTful APIs guide.
When you are able to retrieve access tokens and refresh your tokens, you simply pass your token to the ApiContext object and the SDK does the rest.
ViewItemWithOAuthToken sample has been added illustrating the usage of OAuth User Access Token instead of Auth&Auth Token to access eBay Trading API Serveras below
Important: eBay will be adding scopes for use with the Trading API specifically. When new scopes are available, your application must be ready to implement them. Users will be required to sign-in and go through the permission grant flow when the new scopes are implemented.
This release is compatible with eBay's 1055 Trading WSDL.
Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
This release is compatible with eBay's 1027 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
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.
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.
This release is compatible with eBay's 951 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
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.
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.
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.
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.
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.
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.
This release is compatible with eBay's 861 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
This release is compatible with eBay's 849 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
This release is compatible with eBay's 837 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
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.
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.
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.
This release is compatible with eBay's 797 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
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.
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.
This release is compatible with eBay's 779 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.
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 elements and features.
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.
AttributesDemo samples has been replaced with ItemSpecificsDemo sample illustrating the usage of Item specifics instead of ID-Based Attributes. ID-based attribute will be deprecated soon. Seller Profile have been used to display the new way for specifying payment, shipping, and return Policy Values.
consoleAddItem, consoleAddItemDirect, consoleAddFixedPriceItem samples have been illustrated with new seller Profile Objects to Specify Payment, Shipping, and Return Policy Values.
This release is compatible with eBay's 747 Trading WSDL, and supports the following new features.
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 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 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.
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.
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.
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.
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.
Information on one or more item or shipping discounts can now be retrieved using GetOrders and other order retrieval calls.
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.
Please refer to the Trading API Release Notes for a detailed list of the new calls and elements since the previous Java SDK release
This release is compatible with eBay's 735 Trading WSDL, and supports the following new features.
Sellers can specify discount pricing values for an item to give the item either a Strike-Through Pricing (STP) or Minimum Advertised Price (MAP) display treatment. This feature is available to qualified sellers (and their associated developers) who participate in the Discount Pricing program. Once qualified, sellers can apply Discount Pricing to both MSKU and Non-MSKU items. STP is available on the US, UK, and DE sites while MAP is available only on the US site. For more information, see: Displaying Discount Pricing Information to Buyers.
Please refer to the Trading API Release Notes for a detailed list of the new calls and elements since the previous Java SDK release
This release is compatible with eBay's 715 Trading WSDL, and has the following features.
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: https://developer.ebay.com/DevZone/codebase/javasdk-jaxb/FindingKitJava_1.0.zip.
This release is compatible with eBay's 705 Trading WSDL, and contains no new features.
This release is compatible with eBay's 687 Trading WSDL, and supports the following new features.
Commons logging is replaced with SLF4J (Simple Logging Facade for Java) for better logging support. A Notes About Logging section is added in the readme.
The JavaSDK package is re-organized so that its files and folders are in more readily expected locations, as follows.
A source jar is now provided in the lib/srcjar folder, for source debugging.
The consoleAddItem sample has been enhanced. It now demonstrates how to set item specifics.
A consoleAddFixedPriceItem sample is added. It demonstrates how to set item variations.
This release is compatible with eBay's 673 Trading WSDL, and contains support for the following new features.
This SDK now supports the ConditionID setting on AddItem and related calls. See the Trading Call Reference to learn about Item.ConditionID.
Two new Java 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 Maven pom.xml file is provided in the helloWorld and consoleAddItem samples; refer to readme_maven.txt in the sample folder for instructions for building and running these samples with Maven. Also included: a pom.xml file for building ebaysdkcore.jar with Maven. Refer to {SDK Root}/build/maven_build/readme.txt for build instructions.
This release is compatible with eBay's 661 Trading WSDL, and contains support for the following new features.
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.
A new UploadPictures sample has been added in the apiCallsDemo. This sample shows how to use the eBay Picture Service (EPS) to upload pictures.
Per your request, we removed the Apache log4j dependency and used Apache commons logging instead in the JavaSDK core library. However, you can still see how to configure Apache log4j in the SDK samples.
The readme for the attributesDemo sample has been updated to reflect the latest changes to the sample.
This release is compatible with eBay's 639 Trading WSDL, and contains support for the following new features.
The Java attributesDemo sample has been simplified. 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.
The eclipse project files for JavaSDK have been updated, all absolute references (library, source, jdk) have been changed to relative references, now all projects can be imported into eclipse environment without additional reference updates.
For instructions about how to setup JavaSDK in Eclipse, please refer to the DevEnvReadme in SDK root folder.
This release is compatible with eBay's 631 Trading WSDL, and contains support for the following new features.
A new class, SdkProxySelector.java, is included in this release 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.
The new DetailsDownloader.java, helper class shows you how to cache eBay details locally.
With the exception of, GetTokenStatus, RevokeToken, GetSessionID, and FetchToken, all Java SDK API calls can now be made with an eBay API developer token (instead of full eBay API developer credentials.)
This release is compatible with eBay's 623 Trading WSDL, and there are no new features.
This release is compatible with eBay's 615 Trading WSDL, and contains support for the following new features.
Four new classes, AddFixedPriceItem.java, ReviseFixedPriceItem.java, RelistFixedPriceItem.java and AddFixedPriceItem.java, have been added in this release. These classes can be used as single calls within a Java method, or they can be used within data files in the Large Merchant Services solution.
This release is compatible with eBay's 603 Trading WSDL, and contains support for the following new features.
Two new helper classes, CategoriesDownloader.java and FeaturesDownloader.java, have been added in this release. The CategoriesDownloader.java class caches eBay Category information to a local disk. The FeaturesDownloader.java 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.
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 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.
This release is compatible with eBay's 595 Trading WSDL, and contains support for the following new features.
In this release, the eBay SDK for Java has been migrated from Axis 1.1 to JAX-WS for use with production code. We recommend that you upgrade your production applications from the Axis version of the eBay SDK for Java to the JAX-WS version. For more information, please see Migrating to the JAX-WS eBay SDK for Java.
Since the classes in the eBay Picture Service (EPS) have been replaced by the UploadSiteHostedPictures Trading API (XML) call, the Java 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):
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:
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.
An updated JSP 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.
Some SDK samples have been 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.
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.
As of this release, all legacy XML classes and calls have been removed. The new UploadSiteHostedPictures call is the only remaining XML call.
In this second Beta release, the eBay SDK for Java has been migrated from Axis 1.1 to JAX-WS. For more information, please see Migrating to the JAX-WS eBay SDK for Java (Beta Release).
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.
The eBay SDK for Java 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.
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.
In this release, the eBay SDK for Java has been migrated from Axis 1.1 to JAX-WS. This migration includes changes to the SDK core classes, wrapper classes, samples, and test cases. Stubs and datatypes are now generated with the wsimport tool under the JAX-WS standard, and this process is automated as before by using Ant (the name of the buildfile is build.xml). For more information, please see Migrating to the JAX-WS eBay SDK for Java.
SDK version 561, and earlier SDK versions, were based on Axis 1-1.
A new StubModifier tool is used to handle unrecognized enum values received in a SOAP response. The tool post-processes the stubs generated by Apache Axis WSDL2Java. The tool contains the StubModifier class, located in ...\source\Tools\StubModifier\src\tools\webservices\wsdl\stubutil\StubModifier.java.
The eBay SDK for Java 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 apiCallsDemo and signinRedirect samples are updated with the new FetchTokenCall functionality. Additionally, the apiCallsDemo is updated to show uses of GetTokenStatusCall and RevokeTokenCall.
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.
For information about previous versions, see the Axis 1.1 Java SDK Readme.
Please note that upgrades to an SDK should always be done in a test environment and fully tested before used in production.
In this section, you will use an ANT project file, build.xml, to do the following:
Note:
To build the SDK, use the following steps:
The WSDL is located at https://developer.ebay.com/webservices/Version/ebaySvc.wsdl.
Version in the URL means latest or it means a numerical version of a WSDL release (see the top of the particular WSDL file).
In the case of Version meaning latest, the WSDL is the latest released version (https://developer.ebay.com/webservices/latest/ebaySvc.wsdl). If Version in the URL means a numerical version of the WSDL, Version is a number (for example, https://developer.ebay.com/webservices/445/ebaySvc.wsdl).
Hypothetically, if the latest release of the WSDL were 449, you would find that WSDL version at both https://developer.ebay.com/webservices/latest/ebaySvc.wsdl and at https://developer.ebay.com/webservices/449/ebaySvc.wsdl.
eBay has tested the eBay SDK for Java using the following client environments:
Note: You can use any integrated development environment (IDE) with the eBay SDK for Java, as long as it supports the above environments.
Starting with SDK version 687, the eBay SDK uses the Simple Logging Facade for Java (SLF4J), a simple facade for
various logging frameworks, e.g. log4j, java.uitl.logging (also referred to as JDK 1.4 logging).
By default, eBay SDK uses log4j as the underlying
logging framework. To let log4j work properly, you need to configure log4j beforehand. For example, you can
configure log4j in the log4j.properties file and put this file in the classpath of your application (for a sample log4j.properties file, please refer
to the SDK sample consoleAddItem, in {SDKRoot}\samples\consoleAddItem\src\main\resources).
If you want to switch to another logging framework such as java.util.logging, you need to remove slf4j-log4j12-1.6.1.jar and log4j-1.2.16.jar from your
classpath, then add slf4j-jdk14-1.6.1.jar (in {SDKRoot}\lib\externalLib\optional\slf4j-1.6.1) in your classpath. For details about how to configure
java.util.logging, please refer to Java SDK documentation.
For more details about SLF4J, please refer to its official site.
SDK logging can be further configured by setting ApiContext instance accordingly, for example, if you want to
disable SOAP payload logging (by default, it is enabled), just call setLogSOAPMessages (false) on the ApiLogging instance (property of ApiContext).
For more settings of ApiLogging, please refer to SDK library reference.
© 2005–2010 eBay Inc. All rights reserved.