The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues.
If you are getting started with the API, the following locations have information about joining the eBay Developers Program, creating test users, and other steps to getting your application certified to go live against the eBay production servers:
|
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
The lowest supported version is 707.
To learn how versioning works in the Trading API, see eBay's Schema Versioning Strategy.
Documentation Changes and Errata - 827
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
ExternalTransactionType.ExternalTransactionStatus |
Element | New |
GetOrdersRequestType.SortingOrder |
Element | New |
ItemType.OutOfStockControl |
Element | New |
OrderType.MonetaryDetails |
Element | New |
PaymentInformationCodeType |
Complex type | New |
PaymentInformationType |
Complex type | New |
PaymentsInformationCodeType |
Complex type | New |
PaymentsInformationType |
Complex type | New |
PaymentTransactionCodeType |
Complex type | New |
PaymentTransactionType |
Complex type | New |
PaymentTransactionStatusCodeType |
Enumerated type | New |
ReasonHideFromSearchCodeType.OutOfStock |
Enum | New |
TransactionReferenceCodeType |
Enumerated type | New |
TransactionReferenceType |
Complex type | New |
TransactionType.MonetaryDetails |
Element | New |
UserIdentityCodeType |
Enumerated type | New |
UserIdentityType |
Complex type | New |
See the Site Status Updates for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 827.
The four primary Get calls (GetItemTransactions, GetOrders, GetOrderTransactions, GetSellerTransaction) now return a new container, MonetaryDetails, which provides information about how funds exchanged for an order are allocated to payees.
MonetaryDetails includes multiple Payment containers. Each Payment instance represents one allocation of funds, by identifying the Payer, the Payee, the PaymentAmount and the PaymentStatus (Pending|Failed|Succeeded).
For example, for an order made under eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. In this release, only payment information is returned. Refund information will be returned in an upcoming release.
The Get calls (GIT/GO/GOT/GST) now return ExternalTransaction.ExternalTransactionStatus, an enumerated value that indicates the current processing status of a PayPal payment for an eBay order (Failed|Succeeded|Pending).
GetOrders provides a new field, SortingOrder, an enumerated value that specifies how orders returned by this call should be sorted (using LastModifiedTime as the sort key): Ascending or Descending.
The new OutOfStockControl boolean field was added to ItemType. If this is set to 'true', when the quantity of an GTC (Good 'til Canceled) fixed price item goes to 0 (zero), the listing is hidden from eBay search but the listing is still alive. After the quantity is updated to more than 0, the listing will appear again.
This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can just hide the listing from the search results until they receive more of the item. Since the listing stays alive, the sales history and SEO are retained.
OutOfStock was added as a value for ReasonHideFromSearchCodeType. This value indicates that the item is out-of-stock, which causes the listing to be hidden from search, but keeps the listing alive.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 827 and Changed Functionality - 827.
None for this release.
Documentation Changes and Errata - 825
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
FedExRateOptionCodeType.FedExDiscounted |
Enum | New |
ListingDetailsType.EndingReason |
Element | New |
ReturnsWithinOptionsCodeType.Months_1 |
Enum | New |
ShippingRateTypeCodeType.Discounted |
Enum | New |
ShippingServiceCodeType.CA_PostTrackedPacketsInternational |
Enum | New |
ShippingServiceCodeType.CA_PostTrackedPacketsUSA |
Enum | New |
ShippingServiceCodeType.USPSStandardPost |
Enum | New |
See the Site Status Updates for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 825.
If a seller ended a listing early through an API call (such as EndItem) or on the Web site, an EndingReason value is returned under the ListingDetails container in GetItem. This field will start being returned in Version 825.
The ShippingServiceOptions container, the InternationalShippingServiceOption container, and the ShippingType field are now returned under the WonList and DeletedFromWonList containers in the GetMyeBayBuying response.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
eBay has added 3 new enumeration values to ShippingServiceCodeType. The new shipping service values are CA_PostTrackedPacketsInternational, CA_PostTrackedPacketsUSA and USPSStandardPost. Issue GeteBayDetails with DetailName set to ShippingServiceDetails; values that are returned in ShippingServiceDetails.ShippingService are available on your eBay site.
GetItemShipping, GetItemTransactions and GetSellerTransactions may now return a new enumeration value, Discounted, in ShippingDetails.ShippingRateType. Discounted indicates that the UPS Discounted shipping rate scale is being used for the shipment.
A new enumeration value, FedExDiscounted, can be used to indicate that the FedEx Discounted shipping rate scale is being selected for the user. This value is submitted or returned in SellerPaymentPreferences.FedExRateOption by SetUserPreferences or GetUserPreferences, respectively.
A new 'Months_1' value can be passed in the ReturnPolicy.ReturnsWithinOption field in Add/Revise/Relist API calls for the German and Austrian sites. If set, this value will also be returned in GetItem and other Trading API calls that retrieve the Item object. This is not a valid value for the US, UK, or other sites.
If the seller has set the ShipToLocation as 'Worldwide' for an item, but has not specified any international shipping service options, 'NotSpecified' is returned as the ShippingType value in GetMyeBayBuying.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 825 and Changed Functionality - 825.
None for this release.
Documentation Changes and Errata - 823
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
ListingDetailsType.EndingReason |
Element | New (Going live with Version 825) |
If a seller ended a listing early through an API call (such as EndItem) or on the Web site, an EndingReason value is returned under the ListingDetails container in GetItem. This field will start being returned in Version 825.
See the Site Status Updates for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 823.
Sellers can now list an item on eBay with an option to ship on the same business day the item is ordered.
Use DispatchTimeMax (in add, relist and revise calls) to specify an item's handling time in days (a positive integer) for domestic delivery. A DispatchTimeMax value of 0 means that the seller commits to delivering the shipment to the shipping carrier by the end of the business day. This will not affect the shipping time, which is specified separately from handling time.
The meaning of "business day" in this context depends on the locale of the listing site and the time the cleared payment is received. Each eBay site has a default order cut off time, typically 2:00 PM local time on most eBay sites. For orders placed (and cleared payment received) before the local order cut off time, the order must be shipped by the end of the current day. For orders completed at or after the order cut off time, the order must be shipped by the end of the following day (excluding weekends and local holidays).
Note: If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating handling and shipping time.
You can override the default order cut off time for individual users. Use the SetUserPreferences call and specify a new cut off time for the authenticated user in DispatchCutOffTimePreference.CutOffTime. Provide the time value in Universal Coordinated Time (UTC/GMT), accounting for any difference in daylight saving time between GMT and the seller's time zone if necessary.
You can inspect the order cut off time currently set for the authenticated user by calling GetUserPreferences and setting ShowDispatchCutoffTimePreferences to true. The response returns the cut off time in DispatchCutOffTimePreference.CutOffTime.
For certain listing categories such as Vehicles, Real Estate, Specialty Services and Classified Ads listings, DispatchTimeMax is ignored, so same day handling will not apply to items in those categories. DispatchTimeMax is also ignored when using local pickup only, freight shipping, or no shipping.
For details about same day handling and order cut off times, see Handling Time and Estimated Delivery Time in the Trading API Users Guide.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 823 and Changed Functionality - 823.
None for this release.
Documentation Changes and Errata - 821
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
AccountDetailEntryCodeType.CreditStoresSubscriptionEarlyTermination |
Enum | New |
AccountDetailEntryCodeType.FeeStoresSubscriptionEarlyTermination |
Enum | New |
BestOfferStatusCodeType.PendingBuyerConfirmation |
Enum | New |
BestOfferStatusCodeType.PendingBuyerPayment |
Enum | New |
RequiredSellerActionCodeType.ResolveReturn |
Enum | New |
Business Policies profiles (payment, return policy, and shipping) are now live in the Production environment. This means that Business Policies can now be created, retrieved, updated, and deleted with the Business Policies Management API, and these Business Policies profiles can be applied to listings through the SellerProfiles containers in the Add/Revise/Relist Trading API calls.
Business Policies are not yet available to all sellers. Once Business Policies become available to a seller, that seller must opt in to Business Policies through the Sell tab in My eBay. A seller can verify whether or not their account is opted in to Business Policies by making a call to GetUserPreferences, and including the ShowSellerProfilePreferences flag in the call request. In the GetUserPreferences response, the seller will look for a 'true' value in the SellerProfilePreferences.SellerProfileOptedIn field. A seller can also discover which payment, return policy, and shipping profiles are default for the policy type/category group pair by looking for a value of 'true' in the SellerProfilePreferences.SupportedSellerProfiles.SupportedSellerProfile.CategoryGroup.IsDefault field.
A seller cannot use the Business Policies Management API in the Production environment to create and manage profiles until their account has been opted in to Business Policies. Beginning in mid-June 2013, all sellers will be opted in to Business Policies automatically. Once a seller is opted in to Business Policies, eBay will automatically create some Business Policies profiles for the seller's account based on listings created by that seller in the last 90 days. A seller can create as many payment, return policy, and shipping profiles as they want, but there can only be one default profile for each policy type/category group pair.
For more information on Business Policies, see the Business Policies Management API Users Guide.
See the Site Status for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 821.
Two new values added to BestOfferStatusCodeType. 'PendingBuyerConfirmation' will be returned if the seller is waiting on the buyer to commit to buying the item at the counter offer price. 'PendingBuyerPayment' will be returned if the seller is still awaiting on payment from the buyer. When applicable, these two new values will be returned in GetBestOffers and GetMyeBaySelling.
'ResolveReturn' was added as a value for RequiredSellerActionCodeType. 'ResolveReturn' will be returned in the PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction field of GetMyeBaySelling and order management calls (such as GetOrders) if the buyer is returning the item through eBay's managed return process. The seller will have to resolve the return case and issue a refund to the buyer before the Final Value Fee for the original sale is credited back to the seller's account.
The PaymentHoldDetails container is only returned if a payment hold has been placed on the order.
As of May 2013, eBay will virtually eliminate the basic upfront cost to list and the final value fees have been simplified to just five competitive category-based rates. For complete details, see 2013 Spring Seller Update page.
As of May 2013, to keep the unique eBay Auction-style listings a great attraction for buyers, when you add Buy It Now to any Auction-style listing, it must now be at least 30 percent over your listing's start price. Previously, the requirement was 10% over the listing start price. Note: This change is for the eBay-US site only.
To see the percentage requirement for other sites, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Beginning in May 2013, fixed-price items, auction items (with Buy It Now enabled), and Best Offer items will be subject to remaining on sale (and available to other buyers) until the buyer that has committed to buy the item has actually paid for the item.
For more information on this change, see the 2013 Spring Seller Update page.
If an "Item not received" or an "Item significantly not as described" eBay Buyer Protection case is ruled in favor of the seller, all buyer feedback (positive, negative, or neutral), detailed seller ratings, and related comments are permanently removed from the seller's record, preventing this feedback and data from negatively affecting the seller's account.
For more information on this change, see the 2013 Spring Seller Update page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 821 and Changed Functionality - 821.
None for this release.
Documentation Changes and Errata - 819
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
AdditionalCompatibilityEnabledCodeType |
Enumerated type | Removed |
SendInvoiceRequestType.AdjustmentAmount |
Element | New |
To provide a better experience for both buyers and sellers, eBay will begin testing an improved workflow for Best Offer-enabled listings as of Seller Release 13.1. For Immediate Payment-enabled items, buyers must pay for the item to secure the accepted Best Offer price. For items that are not Immediate Payment-enabled, buyers must explicitly confirm their intent to buy the item to secure the accepted Best Offer price. This change should reduce the frequency of unpaid items.
The schema change supporting this workflow will initially consist of new BestOfferStatusCodeType enumerations PendingBuyerPayment and PendingBuyerConfirmation, available for calls such as GetBestOffer, GetMyeBayBuying, PlaceOffer and RespondToBestOffer:
PendingBuyerPayment status is in effect for the offer. Once the buyer pays, the offer status is set to Accepted and a transaction is created. PendingBuyerConfirmation status is in effect for the offer. Once the buyer confirms, the offer status is set to Accepted and a transaction is created. If the offer does not reach Accepted status in 48 hours, it will expire.
Note: Although these new enumerations will be in the Trading API WSDL as of version 821, they will not be functional until this feature is announced for Seller Release 13.1.
Initially, the new workflow will apply only to a subset of the Best Offer-eligible categories during testing. Continue using the existing Best Offer workflow for all other eligible categories.
See the Site Status for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 819.
The new AdjustmentAmount field allows the seller to adjust the total cost of the order through the SendInvoice call. A positive dollar value passed through this field applies an extra charge to the order, and a negative dollar value passed through this field applies a discount to the order.
Sellers can now use AddFixedPriceItem and ReviseFixedPriceItem calls to enable the Best Offer feature on a fixed-price listing. To enable the Best Offer feature using either of these calls, include the BestOfferDetails.BestOfferEnabled field in the request and set its value to 'true'. Additionally, the seller can set the minimum Best Offer price and the Best Offer "Auto Accept" price using the ListingDetails container of either call.
Not all categories support the Best Offer feature. To verify if a category supports this feature, call GetCategoryFeatures, passing in the Category ID into the CategoryID field, and including 'BestOfferEnabled' as a FeatureID value. If the category supports the Best Offer feature, the Category.BestOfferEnabled field will read as 'true' in the response.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
In ShippingServiceCodeType, the Royal Mail Standard Parcel service (UK_RoyalMailStandardParcel enumeration) has been deprecated. It is no longer available and should not be returned by GeteBayDetails.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 819 and Changed Functionality - 819.
In the VerifyAddFixedPriceItem call, the ShippingPackageDetails container was restored to the call reference in the previous release, but its child fields were not. Those fields should once again be visible in the call reference.
In ShippingServiceCodeType, the descriptions of six UK shipping service enumerations have changed. Their new descriptions are as follows: UK_myHermesDoorToDoorService is "Hermes Tracked"; UK_RoyalMailFirstClassStandard is "Royal Mail 1st Class"; UK_RoyalMailSecondClassStandard is "Royal Mail 2nd Class"; UK_RoyalMailFirstClassRecorded is "Royal Mail 1st Class Signed For"; UK_RoyalMailSecondClassRecorded is "Royal Mail 2nd Class Signed For"; and UK_RoyalMailSpecialDeliveryNextDay is "Royal Mail Special Delivery™ 1:00 pm".
Documentation Changes and Errata - 817
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
DispatchCutOffTimePreferencesType |
Complex type | Removed |
AdditionalCompatibilityEnabledDefinitionType |
Complex type | New |
DispatchCutoffTimePreferencesType |
Complex type | New |
ListingRecommendationType |
Complex type | New |
ListingRecommendationsType |
Complex type | New |
RecommendationType |
Complex type | New |
AdditionalCompatibilityEnabledCodeType |
Enumerated type | New |
AddFixedPriceItemResponseType.ListingRecommendations |
Element | New |
AddItemResponseContainerType.ListingRecommendations |
Element | New |
AddItemResponseType.ListingRecommendations |
Element | New |
CategoryFeatureType.AdditionalCompatibilityEnabled |
Element | New |
FeatureDefinitionsType.AdditionalCompatibilityEnabled |
Element | New |
ItemType.IncludeRecommendations |
Element | New |
RelistFixedPriceItemResponseType.ListingRecommendations |
Element | New |
RelistItemResponseType.ListingRecommendations |
Element | New |
ReviseFixedPriceItemResponseType.ListingRecommendations |
Element | New |
ReviseItemResponseType.ListingRecommendations |
Element | New |
SiteDefaultsType.AdditionalCompatibilityEnabled |
Element | New |
VerifyAddFixedPriceItemResponseType.ListingRecommendations |
Element | New |
VerifyAddItemResponseType.ListingRecommendations |
Element | New |
VerifyRelistItemResponseType.ListingRecommendations |
Element | New |
FeatureIDCodeType.AdditionalCompatibilityEnabled |
Enum | New |
NotificationEventTypeCodeType.ShoppingCartItemEndingSoon |
Enum | New |
It will soon be possible to list an item on eBay with an option to ship on the same business day the item is ordered.
Sellers use DispatchTimeMax (in add, relist and revise calls) to specify an item's handling time in days (a positive integer) for domestic delivery. A DispatchTimeMax value of 0 means that the seller commits to delivering the shipment to the shipping carrier by the end of the business day. This will not affect the shipping time, which is specified separately from handling time.
The meaning of "business day" in this context depends on the locale of the listing site and the time the cleared payment is received. Each eBay site has a default order cut off time, typically 2:00 PM local time on most eBay sites. For orders placed (and cleared payment received) before the local order cut off time, the order must be shipped by the end of the current day. For orders completed at or after the order cut off time, the order must be shipped by the end of the following day (excluding weekends and local holidays).
For certain listing categories such as Vehicles, Real Estate, Specialty Services and Classified Ads listings, DispatchTimeMax is ignored, so same day handling will not apply to items in those categories. DispatchTimeMax is also ignored when using local pickup only, freight shipping, or no shipping.
Same day handling is now available for testing on the eBay Sandbox. It will be available on eBay production sites as of Seller Release 13.1. For details about same day handling, see Handling Time and Estimated Delivery Time in the Trading API User Guide.
Beginning in Version 821 (for some categories), sellers can start adding parts compatibility name-value pairs (through the ItemCompatibilityList container in Add/Revise/Relist calls) for boats' parts and accessories items. All boats' parts and accessories categories should support the Boats Parts Compatibility feature by Version 825. In addition to sellers being able to list boats' parts and accessories items with parts compatibility data, buyers will be able to search for these items using boat characteristics, including the following:
To verify if a specific category supports Boats Parts Compatibility, use GetCategoryFeatures, passing in a CategoryID value in the request, and then look for a 'true' value in the AdditionalCompatibilityEnabled field of the corresponding Category node in the request.
Note: Although AdditionalCompatibilityEnabled flags are already in the WSDL for the GetCategoryFeatures call, these flags will not become applicable until the Boats Parts Compatibility feature starts getting wired on for categories beginning in Version 821.
This change has no impact on the API or third-party tools: eBay requires that each listing has one image file that is uploaded to an eBay server. If you use the Sell Your Item flow to upload pictures based on self-hosted image files, the first self-hosted image was uploaded to the eBay server. In May, the Self Hosting feature in the Sell Your Item flow will no longer upload your first image file. To do that, please use the Copy Web Files feature. This feature lets you upload as many as 12 image files for display at the top left of the listing, as well as additional features.
This changes only the process you use to upload the require image file to eBay in the Sell Your Item flow. It has no impact in any way on the API, self-hosted image capabilities, existing listings or existing photos, or third party tools.
See the Site Status for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 817.
If the IncludeRecommendations field is included and set to 'true' in an Add/Revise/Relist/Verify call, one or more listing recommendations will be returned in the ListingRecommendations container in the call request. Each listing recommendation will help the seller improve the quality of the listing. Listing recommendation types include the following:
Listing recommendations are supported by the following calls:
If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s).
ShoppingCartItemEndingSoon added as a new Platform Notification. This notification is sent to a subscribed buyer (or application) when the listing for an unpurchased item in the buyer's cart is about to end. This notification uses a TimeLeft property that allows the buyer to specify when the notification is sent based on how much time is left before the listing ends.
An eBay user can subscribe to the ShoppingCartItemEndingSoon notification by using the SetNotificationPreferences call.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The Royal Mail Standard Parcel shipping service (UK_RoyalMailStandardParcel) has been deprecated and can no longer be offered for listings with the AddItem family of calls. If this value is returned by a call to GeteBayDetails with a DetailName value of ShippingServiceDetails, the accompanying ValidForSellingFlow field will be false, indicating that the UK_RoyalMailStandardParcel shipping service option is not supported.
Sellers can now use the AddDispute call to create an Unpaid Item case as soon as two days (it was four days) after order line item creation. To create an Unpaid Item case in the AddDispute call, the seller sets the DisputeReason value in the request to "BuyerHasNotPaid".
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 817 and Changed Functionality - 817.
The ShippingPackageDetails container and its fields are available for four calls, but were missing from the call reference. They are now shown in the input prototype and documented in the argument listings for the following calls:
Documentation Changes and Errata - 815
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
None for this release.
Beginning with the release of Version 817 on March 27, sellers can use the AddDispute call to create an Unpaid Item case as soon as two days (currently, it is four days) after order line item creation. To create an Unpaid Item case in the AddDispute call, the seller sets the DisputeReason value in the request to "BuyerHasNotPaid".
See the Site Status for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 815.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 815 and Changed Functionality - 815.
Added additional requirement and seller/item eligibility information to the AutoPay field used in Add/Revise/Relist/VerifyAdd API calls. The AutoPay field allows sellers to set up fixed-price and auction (Buy It Now only) listings as immediate payment items.
Clarification: Transaction.TotalTransactionPrice is returned by the GetMyeBayBuying call, although the documentation did not indicate this before.
Clarification: When you add, revise or relist an item, you must provide either Item.PostalCode or Item.Location to indicate the geographical location of the item (along with Country) to be displayed on eBay listing pages. If you specify PostalCode, eBay derives the location from the postal code. If you specify both PostalCode and Location, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing.
Documentation Changes and Errata - 813
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
None for this release.
Beginning with the release of Version 817 on March 27, sellers can use the AddDispute call to create an Unpaid Item case as soon as two days (currently, it is four days) after order line item creation. To create an Unpaid Item case in the AddDispute call, the seller sets the DisputeReason value in the request to "BuyerHasNotPaid".
See the for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 813.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Using the AddDispute call and using the BuyerHasNotPaid value in the DisputeReason field, a seller can create an Unpaid Item case as soon as two days after order line item creation.
The call frequency limit on revising a single listing has been adjusted. Previously, the limit was set at 60 revisions per hour per listing. The new limit is 150 revisions per day per listing.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 813 and Changed Functionality - 813.
Prior to the 813 release, the description of PaidTime in the GetOrders response, read, "This field is not returned until payment has been made and checkout is complete." This was not entirely accurate, since the PaidTime value will actually be returned as soon as the buyer pays for the order, and it is possible that the checkout flow will still be in the pending state (Order.CheckoutStatus.Status=Pending).
Prior to the 813 release, the eBay sites that don't support the ReturnPolicy.RefundOption field were not called out in the docs.
Documentation Changes and Errata - 811
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
PaymentHoldReasonCodeType |
Enumerated type | New |
PaymentHoldDetailType.PaymentHoldReason |
Element | New |
RequiredSellerActionCodeType.ResolveBuyerMessageInr |
Enum | New |
RequiredSellerActionCodeType.ResolveBuyerMessageSnad |
Enum | New |
RequiredSellerActionCodeType.UploadTrackingInfo |
Enum | New |
See the Site Status for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 811.
New PaymentHoldReason field added to the PaymentHoldDetails container that is returned in GetMyeBaySelling and the order management calls. The enumerated value returned in the PaymentHoldReason field indicates why the buyer's payment for the order is being held by PayPal instead of being distributed to the seller's account.
Three new RequiredSellerAction values added to the PaymentHoldDetails container that is returned in GetMyeBaySelling and the order management calls. The three new RequiredSellerAction values are summarized below:
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 811 and Changed Functionality - 811.
The table of notification payloads in the Trading API Guide has been updated to reflect the current set of notifications. The table contains links to the discussion of each notification in the Guide, as well as to the Call Reference page for each Trading API call that produces output equivalent to the notification payload.
Documentation Changes and Errata - 809
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
None for this release.
See the Site Status for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 809.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 809 and Changed Functionality - 809.
In GeteBayDetails, the descriptions of two tokens returned in ShippingServiceDetails.ShippingService have changed. The service with the token USPSFirstClassMailInternational is now described as "USPS First Class Mail Intl / First Class Package Intl Service." The service with the token USPSParcel is now described as "USPS Parcel Select."
Documentation Changes and Errata - 807
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
ShippingServiceCodeType.AU_ExpressPostSatchel3kg |
Enum | New |
ShippingServiceCodeType.AU_ExpressPostSatchel500g |
Enum | New |
ShippingServiceCodeType.AU_PrePaidParcelPostSatchels5kg |
Enum | New |
ShippingServiceCodeType.AU_RegisteredParcelPostPrepaidSatchel5kg |
Enum | New |
We're working hard on making improvements to the Sandbox. We're pleased to announce that we now release API and UI changes to the Sandbox and Production environments at the same time. (Previously, changes to the Sandbox released up to 1 week after Production.)
Please note the following exceptions:
See the System Announcements for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 807.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
A shipping dispatch (handling) time value of '0' is no longer valid for use on eBay sites. If a listing with flat or calculated shipping has no handling time commitment, DispatchTimeMax is empty or is not returned. If you wish to indicate that a listing with flat or calculated shipping has no handling time commitment, submit Item.DispatchTimeMax as an empty field.
Note: The DispatchTimeMax value of '0' will be used for a new feature in a future release.
eBay has added 4 new enumeration values that can be returned by GeteBayDetails in ShippingServiceDetails.ShippingService. These new services expand the number of weight classes available for express, prepaid and registered parcel post shipping in Australia. For a full list of the new shipping services, see the GeteBayDetails Change History.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 807 and Changed Functionality - 807.
The TotalTransactionPrice field was erroneously omitted from the call reference, although it was being returned by GetMyeBaySelling. TotalTransactionPrice is the price of one order line item. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through a non-variation, fixed-price listing, consider this value the per-unit price. To get the total amount, multiply TotalTransactionPrice by the value of Transaction.QuantityPurchased.
For eBay Motors Vehicle listings, TotalTransactionPrice is the deposit amount. Applicable to Half.com (for GetOrders).
The description of the TransactionPrice field was incorrect. TransactionPrice is the price of one order line item. This price is returned only for Best Offer items. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through Best Offer, this value is the per-unit price.
For eBay Motors Vehicle listings, TransactionPrice is the deposit amount. Applicable to Half.com (for GetOrders).
The ActualShippingCost field varies in usage depending on the call:
0.00.
0.00 indicates free shipping. For the other calls, this field is always returned but defaults to 0.00 until payment has been made on the order.
The eBay Trading API Guide previously stated that as of May 2012, eBay would no longer support ID-based attributes. The content remained in the docs for several months, as a reference for developers who needed to update their applications to remove dependencies on these features. The content related to ID-based attributes and attribute-based product search has now been removed from the Trading API Guide:
Documentation Changes and Errata - 805
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
ShippingServiceCodeType.AT_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.AT_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.AT_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.AT_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BEFR_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BEFR_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BEFR_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BEFR_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BENL_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BENL_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BENL_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.BENL_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.CH_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.CH_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.CH_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.CH_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.DE_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.ES_ENTREGA_KIALA_8KG |
Enum | New |
ShippingServiceCodeType.ES_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.ES_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.ES_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.ES_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.FR_KIALA_DELIVERY |
Enum | New |
ShippingServiceCodeType.FR_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.IE_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.IE_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.IE_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.IE_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.IT_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.NL_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.NL_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.NL_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.NL_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.PL_EconomyDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.PL_ExpressDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.PL_StandardDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.PL_TrackedDeliveryFromAbroad |
Enum | New |
ShippingServiceCodeType.UK_IntlTrackedPostage |
Enum | New |
ShippingServiceCodeType.UK_TrackedDeliveryFromAbroad |
Enum | New |
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 805.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
eBay has added 39 new enumeration values that can be returned by GeteBayDetails in ShippingServiceDetails.ShippingService. Most of the new services cover "Delivery From Abroad" shipping in four versions: Economy, Express, Standard and Tracked. These are available on the eBay AT, BEFR, BENL, CH, ES, IE, NL and PL sites. The DE, FR, IT and UK sites now provide only the Tracked version of the "Delivery From Abroad" shipping service. In addition, the ES and IE sites each have a new Kiala shipping service. For a full list of the new shipping services, see the GeteBayDetails Change History.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 805 and Changed Functionality - 805.
GetItemRecommendations has been marked as deprecated in the Trading API Call Reference. Related content has been removed from the Trading API Guide. If you are currently using this call, you can continue to use it until it is removed from the schema. However, the call is no longer recommended, as most of its features depend on deprecated functionality (such as ID-based attributes).
Documentation Changes and Errata - 803
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
AccountDetailEntryCodeType.CreditReturnRefund |
Enum | New |
AccountDetailEntryCodeType.FeeReturnRefund |
Enum | New |
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 803.
CreditReturnRefund and FeeReturnRefund added as possible values returned in GetAccount. CreditReturnRefund is a credit issued to the buyer's account by eBay in a case where the buyer has used the eBay US Managed Returns process and return shipped the item to the seller, but the seller has not issued a refund to the buyer within seven business days after receiving the returned item. FeeReturnRefund is the fee charged to the seller's account to compensate eBay for issuing the refund that was supposed to be issued by the seller.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 803 and Changed Functionality - 803.
Clarified information regarding the ReservePrice field when relisting an item. The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing.
Documentation Changes and Errata - 801
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
None for this release.
The following features and changes for US Motors (Site ID 100) vehicle listings have been rolled out to the Sandbox environment as of December 4. These changes will go live to production on February 5, 2013:
For more information about these changes, see the eBay Motors Seller Update.
On February 5, 2013, price changes will go into effect for the following features when listing in the vehicle categories on US Motors (Site ID 100):
These prices changes do not apply to the Parts and Accessories categories on US Motors.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 801.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The maximum length of a picture URL (eBay-hosted or an external URL) has increased from 150 to 500 characters. This change affects the PictureURL and ExternalPictureURL fields of AddItem (and the entire Add/Revise/Relist call family), GetItem, UploadSiteHostedPictures and other Trading calls that retrieve the Item.PictureDetails container. Developers should modify their applications as necessary to accommodate this change.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 801 and Changed Functionality - 801.
The original description was confusing and incorrect. It said:
The URL for the uploaded picture. Store this value for association with an item listing. That is, after you use UploadSiteHostedPictures to upload an image, use the value in FullURL to associate the image with an item (specify the value in Item.PictureDetails.PictureURL in AddItem, ReviseItem, or RelistItem) within 48 hours. Unassociated pictures are automatically deleted after that period.
The 48 hours and last sentence are incorrect. Here is the corrected description.
The URL for the uploaded picture. Store this value for association with an item listing. That is, after you use UploadSiteHostedPictures to upload an image, use the value in FullURL to associate the image with an item (specify the value in Item.PictureDetails.PictureURL in AddItem, ReviseItem, or RelistItem) prior to the UseByDate returned in the response.
Documentation Changes and Errata - 799
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
None for this release.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 799.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 799 and Changed Functionality - 799.
Sellers who have not opted in to the Global Shipping Program can specify up to four domestic and five international shipping services for a listing.
Sellers who are participating in the Global Shipping Program can specify up to four domestic and four international shipping services, plus Global Shipping. This is the case regardless of whether or not the Global Shipping Program is actually offered for the listing.
If the Global Shipping Program is offered for a listing, it takes precedence, and becomes the only available international shipping option offered to any Global Shipping-eligible buyer who views that listing. However, if the buyer or the item is determined by eBay or the international shipping provider to be ineligible for the Global Shipping Program, the other international shipping options will automatically be offered for the listing instead.
Currently, sellers may offer shipping via the Global Shipping Program in their listings, subject to the following qualifications:
Items must also meet certain eligibility requirements before they can be listed with the Global Shipping Program:
Documentation Changes and Errata - 797
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
None for this release.
Starting with Version 801, the maximum length of a picture URL (eBay-hosted or an external URL) is being increased from 150 to 500 characters. This change will affect AddItem (and the entire Add/Revise/Relist call family), GetItem, and UploadSiteHostedPictures. Developers should modify their applications as necessary to accommodate this change coming in Version 801.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 797.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
eBay Store Cross Promotions data are no longer returned in the following Trading API calls:
Similarly, Cross Promotion preferences can no longer be set or retrieved using the SetUserPreferences and GetUserPreferences calls, respectively.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 797 and Changed Functionality - 797.
None for this release.
Documentation Changes and Errata - 795
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
AccountDetailEntryCodeType.FeeFedExShippingLabel |
Enum | New |
AccountDetailEntryCodeType.CreditFedExShippingLabel |
Enum | New |
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 795.
FeeFedExShippingLabel and CreditFedExShippingLabel added as possible values returned in GetAccount. FeeFedExShippingLabel is a fee charged to the seller's account for printing out and using a FedEx shipping label from eBay. CreditFedExShippingLabel is a credit issued by eBay to reimburse the seller for a FedEx shipping label. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 795 and Changed Functionality - 795.
For GetItemTransactions and GetSellerTransactions, the Transaction.ShippingServiceSelected container does not return accurate shipping service and cost information for multiple line item orders. Use GetOrders instead, and provide the order's combined OrderID value to retrieve this information.
For GetOrders and GetOrderTransactions, you must provide the order's combined OrderID value to ensure that the ShippingService and ShippingServiceCost fields return the correct values for the order.
To avoid loss of shipping details when using a revise or relist call to modify a listing, you must include values for all of the ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Documentation Changes and Errata - 793
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
ReasonHideFromSearchCodeType |
Enumerated type | New |
DispatchTimeMaxDetailsType.ExtendedHandling |
Element | New |
ItemType.HideFromSearch |
Element | New |
ItemType.ReasonHideFromSearch |
Element | New |
AccountDetailEntryCodeType.CreditAuctionEndEarly |
Enum | New |
AccountDetailEntryCodeType.FeeAuctionEndEarly |
Enum | New |
Sellers on the eBay DE and UK websites are now able to configure and apply an international shipping rate table to their listings. This complements the domestic shipping rate table that is already available.
With an international rate table, a seller can specify an alternative shipping rate for each shipping service category, in each of several international regions. The shipping service categories are Economy, Standard and Express. The international rate table has nine top-level base regions: Africa, Asia, Central America and Caribbean, Europe, Middle East, North America, Oceania, Southeast Asia, and South America. Each base region, and each country in that region, can have a different shipping rate. The seller can configure the table to apply its specified rates as a flat amount or a surcharge by weight. This selection applies to the entire table.
For more information about international shipping rate tables, see Using Shipping Rate Tables in the Trading API User's Guide.
As of October 1, 2012, all eBay listings must contain at least one picture. Sellers will be blocked from creating, revising, or relisting any item without a picture.
Seller-level call rate limits are being introduced for Add and Revise Listing calls. Each user is allowed 1200 Add Listing calls and 1200 Revise Listing calls per 30 seconds, which equates to about 3.5 million calls per 24-hour period. Add Listing calls include AddItem, AddFixedPriceItem, AddItems, AddSellingManagerTemplate, VerifyAddItem, and VerifyAddFixedPriceItem. Revise Listing calls include ReviseItem, ReviseFixedPriceItem, and ReviseSellingManagerTemplate.
Version 793 also introduces a call frequency limit on revising a single listing. Sellers are not allowed more than 60 revisions per hour per listing.
Users who exceed these call frequency limits will be temporarily blocked from listing, and an error message (ErrorCode 21919144) will alert them to this fact. These call frequency limits are subject to change without notice.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 793.
The GetMyeBaySelling and GetSellerList calls now return the GlobalShipping flag. If true, the Global Shipping Program is the default international shipping option for the listing, and eBay designates an appropriate international shipping service. If the value of GlobalShipping is false, the seller is responsible for specifying an international shipping service for the listing if desired.
GetMyeBaySelling now returns the IsMultiLegShipping flag, which indicates whether a listed item was shipped using the Global Shipping Program. This field is returned under the DeletedFromSoldList and SoldList containers.
In the GetSellerList call, the BuyerInfo.ShippingAddress container includes Country and PostalCode, which for Global Shipping Program orders now contain the country and postal code, respectively, of the buyer, not of the international shipping provider. The GetMyeBaySelling call returns PostalCode as well.
GetMyeBaySelling returns the ShippingServiceCost field under the DeletedFromSoldList and SoldList containers. For a Global Shipping Program order, it now contains the cost of the domestic leg of the item shipment (to the international shipping provider's warehouse).
In GetMyeBaySelling, the Transaction.TotalPrice field contains the purchase price of items in a Global Shipping Program order awaiting payment; for paid orders, this field contains the purchase price of the items plus the cost of domestic shipping to the international shipping provider's warehouse. This field is returned under SoldList.OrderTransactionArray.OrderTransaction for single-transaction orders, and under SoldList.OrderTransactionArray.OrderTransaction.Order.TransactionArray for multiple-transaction orders
The GeteBayDetails call returns a new field, DispatchTimeMaxDetailsType.ExtendedHandling, which indicates that the seller has specified a default handling time of 4 business days or more (an "exception handling time") in preferences. Sellers should be aware that long handling times might put off or discourage potential buyers.
FeeAuctionEndEarly and CreditAuctionEndEarly added as possible values returned in GetAccount. FeeAuctionEndEarly is a fee charged to the seller's account if the seller ends an active auction (with one or more bids) early. CreditAuctionEndEarly is a credit issued by eBay to the seller's account if a duplicate auction listing is ended administratively by eBay. A seller is only eligible for this credit if the auction listing had zero bids and the listing was never surfaced in eBay Search.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
In the GetOrders call, the ActualShippingCost field is returned only after checkout is completed on the order. A value of 0.00 indicates free shipping.
The UnitQuantity field's type has changed from int to double.
No more than 40 orders can be combined using the AddOrder call. This means that the TransactionArray container can contain a maximum of 40 orders (Transaction containers).
Some duplicate listings on the US, CA, CA-FR and eBay Motors (Part and Accessories only) sites may be temporarily hidden from eBay Search. The HideFromSearch flag in GetItem will indicate that the item is currently being hidden from search, and the ReasonHideFromSearch value will indicate why the item is being hidden from search.
Is it possible that a previously hidden listing will be resurfaced in search if the original auction listing or other duplicate listings get bids or are purchased through Buy It Now. It is also possible that eBay will administratively end duplicate auction listings with zero bids. If this occurs, the listing fee will be credited back to the seller's account.
For more information, read eBay's Duplicate Listings Policy help page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 793 and Changed Functionality - 793.
Previously, the Trading API Call Reference showed the MultiLegShippingDetails container being returned in multiple locations in each of several calls. This is not the case; MultiLegShippingDetails is returned only in the following locations:
Documentation Changes and Errata - 791
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
ShippingServiceCodeType.DE_DeutschePostBriefIntlEcon |
Enum | New |
ShippingServiceCodeType.DE_DeutschePostBriefIntlPri |
Enum | New |
ShippingServiceCodeType.UK_ParcelForceIntlEconomy |
Enum | New |
ShippingServiceCodeType.UK_ParcelForceIntlExpress |
Enum | New |
ShippingServiceCodeType.UK_ParcelForceIntlValue |
Enum | New |
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 791.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
New International shipping services were added for the UK and DE sites as part of the EU delivery estimate project. For UK, these new enumeration values are UK_ParcelForceIntlExpress, UK_ParcelForceIntlValue, and UK_ParcelForceIntlEconomy. For DE, these new enumeration values are DE_DeutschePostBriefIntlEcon and DE_DeutschePostBriefIntlPriority.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 791 and Changed Functionality - 791.
The AmountType data type, based on the double type, is typically used to specify details such as prices, fees, costs, and payments. In some cases, a whole number (i.e., without a period) can be passed or returned as a monetary value. This is necessary to support certain currencies that are only expressed as whole numbers (like the Italian Lira and Spanish Peseta).
Because a double is used to represent the amount, this also means whole monetary amounts may be returned with only one 0 after the decimal. For example, a dollar value could be returned as 1.0 instead of 1.00 in calls like AddItem. For fields of type AmountType, see the individual topics for specific restrictions beyond this.
Documentation Changes and Errata - 789
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
GetPopularKeywordsRequestType |
Complex type | Removed |
GetPopularKeywordsResponseType |
Complex type | Removed |
GetProductsRequestType |
Complex type | Removed |
GetProductsResponseType |
Complex type | Removed |
ItemType.ConditionDescription |
Element | New |
ItemType.RelistParentID |
Element | New |
TransactionType.IntangibleItem |
Element | New |
TransactionType.InvoiceSentTime |
Element | New |
TransactionType.UnpaidItem |
Element | New |
As an alternative to GetProducts, use the FindProducts call of the Shopping API.
The StoresFixedPrice value is no longer supported and should no longer be used in the ListingType field when adding, revising, or relisting an item. If it is used in a listing, no checkout notification will be sent to the seller since there is no longer any checkout notifications tied to this listing type.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 789.
The ConditionDescription field was added to all listing calls, and will become available for use by sellers starting November 1. This string field is used by the seller to more clearly describe the condition of items that are not brand new. See the 785 Entry for more information on this feature.
GetItem and GetItems now return the RelistParentID for all relisted items. The RelistParentID is the eBay Item ID of the current item's parent.
The UnpaidItem container is now returned in GetOrders, GetOrderTransactions, GetItemTransactions, and GetSellerTransactions. This container consists of details related to the type and status of an Unpaid Item case. This container is only returned if an eBay or PayPal Unpaid Item case is associated with the order.
The IntangibleItem flag is now returned in GetOrderTransactions, GetItemTransactions, and GetSellerTransactions. This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. This value is primarily used by PayPal to see if the item qualifies for PayPal's Seller Protection program.
The InvoiceSentTime dateTime field is now returned in GetOrders, GetOrderTransactions, GetItemTransactions, and GetSellerTransactions. This field indicates the date/time that an order invoice was sent from the seller to the buyer.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 789 and Changed Functionality - 789.
Due to the recent deprecation of the GetCategoryListings and GetSearchResults calls, the functionality of these calls is now provided by the eBay Finding and Shopping APIs. The Searching for Items chapter of the Trading API User's Guide has been revised to omit references to the deprecated calls, and users are now referred to the Finding API User's Guide and the Shopping API FindProducts Call Reference for information about similar search functionality. The functionality now provided by the Finding and Shopping APIs includes free-text keyword queries; product queries with and without a product ID; item, aspect and domain filtering; and managing the amount and ordering of search results.
List/relist/revise calls include the ListingSubtype2 input field with which you can specify a ClassifiedAd subtype of the Lead Generation listing type. This subtype value indicates a classified ad (or digital download) listing on ebay.com websites, not on ebayclassifieds.com. The ebayclassifieds.com site is not supported by the Trading API. For information about other differences between these two sites, see Advertising with classified ads on eBay and eBay Classifieds.
Documentation Changes and Errata - 787
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change | Notes |
|---|---|---|---|
AccountDetailEntryCodeType.CreditGlobalShipping |
Enumeration | Removed | |
AccountDetailEntryCodeType.FeeGlobalShipping |
Enumeration | Removed | |
QuantityRestrictionPerBuyerInfoType |
Complex type | New | |
ItemType.IsIntermediatedShippingEligible |
Element | New | |
ItemType.QuantityRestrictionPerBuyer |
Element | New | |
ItemType.UnitInfo |
Element | New | |
RateTableDetails.InternationalRateTable |
Element | New | Available in 791 |
SellerInfo.InternationalRateTable |
Element | New | Available in 791 |
AccountDetailEntryCodeType.CreditGlobalShippingProgram |
Enum | New | |
AccountDetailEntryCodeType.FeeGlobalShippingProgram |
Enum | New |
In mid-September 2012, sellers on the eBay DE and UK websites will be able to configure and apply an international shipping rate table to their listings. This will complement the domestic shipping rate table that is already available.
With an international rate table, a seller can specify an alternative shipping rate for each shipping service category, in each of several international regions. The shipping service categories are Economy, Standard and Express. The international rate table has nine top-level base regions: Africa, Asia, Central America and Caribbean, Europe, Middle East, North America, Oceania, Southeast Asia, and South America. Each base region, and each country in that region, can have a different shipping rate. The seller can configure the table to apply its specified rates as a flat amount or a surcharge by weight. This selection applies to the entire table.
The Trading API has two new fields with which international rate tables can be implemented. With User.SellerInfo.InternationalRateTable,you can determine whether a seller has configured an international shipping rate table. Use Item.ShippingDetails.RateTableDetails.InternationalRateTable to apply the seller's configured international rate table to a listing, or to remove it from the listing.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 787.
The QuantityRestrictionPerBuyer container was added to Add, Revise, and Relist Item calls. This container allows the seller to restrict the quantity of items that may be purchased by one buyer during the duration of a fixed-price listing (single or multi- variation).
When true, the new boolean field Item.IsIntermediatedShippingEligible indicates that sellers can offer shipment via the Global Shipping Program when listing the current item.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The AccountDetailsEntryType field used by the GetAccount call contains two enumeration values with names that have changed. FeeGlobalShipping is now FeeGlobalShippingProgram, and CreditGlobalShipping is now CreditGlobalShippingProgram. The meanings of these two enumerations have not changed.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 787 and Changed Functionality - 787.
The Item.ShippingDetails.RateTableDetails container and its DomesticRateTable field are used to apply seller-configured shipping rate tables to the item listing. The documentation for these elements has been revised to be more accurate and easier to understand.
Documentation Changes and Errata - 785
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
GlobalShippingEnabledDefinitionType |
Complex type | New |
ModifyNameArrayType |
Complex type | New |
ModifyNameType |
Complex type | New |
UnitInfoType |
Complex type | New |
CategoryFeatureType.GlobalShippingEnabled |
Element | New |
FeatureDefinitionsType.GlobalShippingEnabled |
Element | New |
GetUserPreferencesRequestType.ShowGlobalShippingProgramPreference |
Element | New |
GetUserPreferencesResponseType.OfferGlobalShippingProgramPreference |
Element | New |
SiteDefaultsType.GlobalShippingEnabled |
Element | New |
VariationsType.ModifyNameList |
Element | New |
AccountDetailEntryCodeType.CreditGlobalShipping |
Enum | New |
AccountDetailEntryCodeType.FeeGlobalShipping |
Enum | New |
FeatureIDCodeType.GlobalShippingEnabled |
Enum | New |
Starting November 1, eBay will support a new field called Item Condition Description (in the Sell Your Item form and other tools) to help sellers more clearly describe the condition of items that are not new.
This field will help buyers more quickly find and understand the item's condition. It should also help to reduce disputes, as many buyers miss comments that are buried deep in the seller's item description.
AddItem and related calls will support a new ConditionDescription field. We recommend that you start using it when available, to help buyers better understand the condition of items that are not new.
GetItem and related calls in the Trading API, and GetSingleItem and GetMultipleItems in the Shopping API will return ConditionDescription.
The Finding API and other search calls will not return item condition descriptions. eBay's search engine will not search text within item condition descriptions.
For details about the policies and rules for using ConditionDescription, see "Describing Details About the Condition of Items That Are Not New" in the Specifying an Item's Condition section of the Trading API Guide.
We are aiming to release this functionality in the Sandbox in September, and in production in November. Keep an eye on these release notes and announcements from eBay for updates.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 785.
ReviseFixedPriceItem and RelistFixedPriceItem now allow you to modify names of variation specifics (e.g., change "Material" to "Fabric") by using a new ModifyNameList node.
These calls also now allow you to add new variation specific names to an existing variation in an active listing. See Revising and Relisting with Variations in the Trading API Guide for more information.
FeeGlobalShipping and CreditGlobalShipping added as new enumeration values in AccountDetailEntryCodeType. GetAccount will return these values if there is a fee or credit applied to the user's account related to Global Shipping.
GetUserPreferences now indicates a seller's preference for the Global Shipping Program. When you set the new ShowGlobalShippingProgramPreference input field to true, GetUserPreferences returns the OfferGlobalShippingProgramPreference field, which is true if the seller has opted in to the Global Shipping Program and is able to offer global shipping to international buyers.
The European Union requires listings for certain types of products to include the price per unit for comparison purposes. The GetItem call provides a new output container, UnitInfo, to return the designation (one of Kg 100g 10g L 100ml 10ml M M2 M3 Unit) in the UnitType field, and the quantity in the UnitQuantity field. eBay calculates and displays the price per unit for that unit type in the item listing (for example, "£2.47/Kg"). This information is currently provided only by EU business sellers, and only for listings with a Buy It Now option. For more information, see the Trading API Call Reference for UnitInfo.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
In response to requests from our developer community, GetSellerList now returns ConditionID and ConditionDisplayName.
GetCategoryFeatures.FeatureID has a new code list value, GlobalShippingEnabled. Provide this value to determine if a specified category or the current site supports Global Shipping (Category.GlobalShippingEnabled = true or SiteDefaults.GlobalShippingEnabled = true, respectively).
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 785 and Changed Functionality - 785.
None for this release.
Documentation Changes and Errata - 783
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
RestockingFeeValueDetailsType |
Complex type | New |
SellerReturnPreferencesType |
Complex type | New |
RestockingFeeCodeType |
Enumerated type | New |
GetUserPreferencesRequestType.ShowSellerReturnPreferences |
Element | New |
GetUserPreferencesResponseType.SellerReturnPreferences |
Element | New |
ReturnPolicyDetailsType.RestockingFeeValue |
Element | New |
ReturnPolicyType.RestockingFeeValue |
Element | New |
ReturnPolicyType.RestockingFeeValueOption |
Element | New |
ShippingServiceOptionsType.ImportCharge |
Element | New |
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 783.
The RestockingFeeValueOption field added in Add/Revise/Relist calls allows US sellers to charge buyers a restocking fee for returned items.
Call GeteBayDetails to retrieve the list of allowed enumeration values for RestockingFeeValueOption. Set DetailName to ReturnPolicyDetails in the request and then look for ReturnPolicyDetails.RestockingFeeValue in the response.
GetItem (and other Get calls that retrieve item data) has also been enabled to retrieve the RestockingFeeValueOption value for an item.
US sellers must be opted in to eBay Return Center in order to list a restocking fee through the API. The eBay Return Center pilot launched on July 10, 2012. The eBay Return Center full launch is scheduled for early August 2012. Please refer to http://pages.ebay.com/help/sell/return-process.html for more information on eBay returns and the seller opt-in process.
By including and setting the ShowSellerReturnPreferences flag to true in GetUserPreferences, sellers can determine if their account has been opted in to eBay Return Center. US sellers must be opted in to eBay Return Center in order to list a restocking fee through the API. The eBay Return Center pilot launched on July 10, 2012. The eBay Return Center full launch is scheduled for early August 2012. Please refer to http://pages.ebay.com/help/sell/return-process.html for more information on eBay returns and the seller opt-in process.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 783 and Changed Functionality - 783.
The ShippingServiceSelected.ImportCharge field was in the schema for GetItemTransactions, GetOrders, GetOrderTransactions and GetSellerTransactions, but erroneously not visible in the Call Reference. It is now visible.
The ShipmentLineItem and LogisticsProviderShipmentToBuyer containers and their child fields were erroneously included in the schema for GetItemTransactions, GetOrders, GetOrderTransactions and GetSellerTransactions, and have been removed.
Documentation Changes and Errata - 781
For a current list of known issues, see Site Status and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
ShippingDetailsType.GlobalShipping |
Element | New |
ShippingServiceCodeType.AU_StandardDeliveryFromOutsideAU |
Enum | New |
As of this release, the Global Exchange program is called the Global Shipping Program. All references to "Global Exchange" in the Trading API call reference and the User's Guide have been changed to "Global Shipping Program."
The Global Shipping Program is now available for testing with simulated responses in the Sandbox. The full functionality of the Global Shipping Program will be available in August 2012.
IMPORTANT: When issuing Trading API calls to make use of the Global Shipping Program, you must set the schema version number in the call request to 787, regardless of the actual schema version you're currently using. This will be necessary until the full release of the Global Shipping Program.
For more information, see Standard Data for All Calls.
The PlaceOffer API call is not compatible with eBay's Global Shipping Program prior to version 787. This means that when a buyer attempts to purchase an item that's listed with International Priority Shipping as an international shipping option and PlaceOffer is invoked, the buyer will receive an error message indicating that the item can be purchased only on one of the main eBay sites.
You must upgrade your application to version 787 of the Trading API schema before attempting to call PlaceOffer to let buyers purchase Global Shipping Program-enabled items.
See the Site Status for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 781.
AU_StandardDeliveryFromOutsideAU added as a possible shipping service option. This option can be specified by sellers on the AU site if the item is being shipped from a location outside of Australia using standard delivery.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 781 and Changed Functionality - 781.
None for this release.
Back to topCopyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.