This archive document contains information about releases that go back longer than four quarters ago. For more recent releases, see the current Release Notes.
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:
| Q4 2007 | Q3 2007 | Q2 2007 | Q1 2007 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Version | Release Date | Version | Release Date | Version | Release Date | Version | Release Date | ||||
| 545 | Not Released | 531 | 2007-9-19 | 519 | 2007-6-27 | 505 | 2007-3-21 | ||||
| 543 | 2007-12-18 | 529 | 2007-9-5 | 517 | 2007-6-13 | 503 | 2007-3-7 | ||||
| 541 | Not Released | 527 | 2007-8-22 | 515 | 2007-5-30 | 501 | 2007-2-21 | ||||
| 539 | 2007-11-14 | 525 | 2007-8-8 | 513 | 2007-5-16 | 499 | 2007-2-7 | ||||
| 537 | 2007-10-31 | 523 | 2007-7-25 | 511 | 2007-5-2 | 497 | 2007-1-24 | ||||
| 535 | 2007-10-17 | 521 | 2007-7-11 | 509 | 2007-4-18 | 495 | 2007-1-10 | ||||
| 533 | 2007-10-3 | 507 | 2007-4-4 | ||||||||
These releases go back longer than four quarters ago. For more recent releases, see the current Release Notes.
No 545 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 543
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Schema component | Nature of Change |
|---|---|---|
CompleteSaleRequestType.Shipment |
Element | New |
TradingAssistantCodeType |
Enumerated type | Reserved for future use |
SellerPaymentMethodCodeType.PayPal |
Enum | New |
Various ShippingServiceCodeType Enums |
Enum | New |
There will not be a 545 schema release. The 547 schema and API documentation will be available by January 14, 2008.
In February and August of each year, eBay increments the lowest supported schema version. (See eBay's Version Support Schedule.)
In February (release 551), the lowest supported version will change from 447 to 473. This means we will stop supporting objects that were deprecated prior to version 473:
For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
See the System Announcements 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 - 543.
A seller can now add a tracking number to a transaction via CompleteSale.Shipment.ShipmentTrackingNumber.
If a seller prints postage through PayPal, a tracking number is automatically added to the transaction.
The tracking number is returned via GetSellerTransactions or GetItemTransactions (via TransactionArray.Transaction.ShippingDetails).
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.
GetProductSearchPage now returns a Keyword attribute for some characteristic sets. If the attribute's label is "Keyword", you use it like any other attribute. You enter the attribute's ID and a string value in the SearchAttributes node of GetProductSearchResults as usual, but eBay may search for that string against multiple attributes in the catalog.
For example, for strollers, GetProductSearchPage only returns a Keyword attribute instead of separate Brand, Product Type, and Model attributes (for the US site). If you pass the Keyword attribute's ID and a value in GetProductSearchResults, eBay will find products by matching the value to keywords in each product's Brand, Product Type, and Model attributes.
Note that in GetProductSearchResults, you still use the SearchAttributes node to search with a Keyword attribute. (You don't use the plain-text QueryKeywords field.)
The Dutch language Belgium site (site ID 123) recently changed attributes in the Immobilien (Real Estate) category (ID 140866) by adding a parent attribute to differentiate types of real estate.
If you try to relist an item that was listed with the old (non-dependent or single-tier) attributes, you may receive an error if you don't add the correct parent attribute. As a general rule, you should always provide a complete, updated set of attributes when you are relisting an item with Item Specifics.
If you try to revise an item that was listed with the old (non-dependent) attributes, you may get errors even if you specify the new parent attribute correctly and you pass in a completely updated AttributeSetArray. Here's why: During the revise flow for many categories, eBay may validate the listing's original attributes before validating new attributes you pass in. If the original attributes cause errors, the processing fails and the new attributes aren't validated. If this occurs, you can end the listing and relist it instead.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 543 and Changed Functionality - 543.
The documentation for the Feedback notification has been updated to state that all applications that subscribe will get the notification, regardless of how the item was listed (i.e., whether the item was listed through the API or through the web).
The documentation notes that if domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost.
This point was added to the documentation: To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.
No 541 schema was released.
Documentation Changes and Errata - 539
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
ShippingCarrierDetailsType |
Complex type | New |
GeteBayDetailsResponseType.ShippingCarrierDetails |
Element | New |
OfferType.BestOfferID |
Element | New |
OfferType.Message |
Element | New |
PlaceOfferResponseType.BestOffer |
Element | New |
ShippingServiceDetailsType.ShippingCarrier |
Element | New |
BidActionCodeType.Accept |
Enum | New |
BidActionCodeType.Counter |
Enum | New |
BidActionCodeType.Decline |
Enum | New |
BidActionCodeType.Offer |
Enum | New |
DetailNameCodeType.ShippingCarrierDetails |
Enum | New |
ShippingServiceCodeType.FR_LaPosteLetterMax |
Enum | New |
See the System Announcements 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 - 539.
A buyer can use PlaceOffer to make a best offer on a best-offer-enabled item. For the input values to use, see PlaceOffer. If an item is best-offer enabled and a buyer makes a best offer (or counter-offer, etc.) on the item, the buyer can get the status of the best offer (and of a possible seller-counter-offer, etc.) using the GetBestOffers call.
Please note that when PlaceOffer is used to make a best offer, no affiliate-related commissions are paid.
For information about the sites this feature applies to, see the Best Offer Auto-Accept feature at New Features - 537. For information about using PlaceOffer in the production environment, see the PlaceOffer Policies and Guidelines. PlaceOffer is available for evaluation by all in the Sandbox (test) environment.
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 following changes have occurred in GetSearchResults:
The minimum donation percentage that you can allocate to an eBay Giving Works charity for items that you are selling through the eBay Motors site has been lowered from 10% to 5% in consideration of the higher selling price of most items sold on eBay Motors.
During the week of Nov 12, eBay will modify the listing flow in the Event Tickets category. We will remove the requirement for sellers to enter the face value of the tickets for events taking place in regulated US states and Canadian provinces, and there will no longer be a disclaimer in ticket listings which states the maximum amount that can be bid for the tickets.
Important: Sellers are still responsible for making sure that their transactions do not violate any applicable laws or the terms of the ticket itself. For more information, see the following page in the eBay online help. (Expand the "Additional Information" section for a list of regulated US states and Canadian provinces.)
Event Ticket Resale Policy
http://pages.ebay.com/help/policies/event-tickets.html
GetAttributesCS will stop returning a Face Value attribute, and it will no longer provide metadata that identifies regulated states and provinces.
The documentation will be updated to remove references to face value dependencies in an upcoming release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 539 and Changed Functionality - 539.
AdType is no longer marked as deprecated in the schema, because it is still used by US Real Estate categories. Adding an item in a US Real Estate category triggers a warning for AdType listings, but the item is still listed. Please ignore the warning.
The documentation for Item.SellerContactDetails has been updated to note that it uses Item.SellerContactDetails.Street, not Street1.
The documentation for Item.Location has been updated to note that, for a classified ad type items for eBay Motors, the value in Item.Location is used as item location only if the Item.SellerContactDetails.Street and the Item.SellerContactDetails.Street2 are empty. Else, the value in Item.SellerContactDetails.Street and Item.SellerContactDetails.Street2 will be used as item location.
This call has a CurrencyID field and many of its other fields have a currencyID attribute. To avoid an error, the same value of CurrencyCodeType should be used in each occurrence within the same request.
Documentation Changes and Errata - 537
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Schema component | Nature of Change |
|---|---|---|
BestOfferAutoAcceptEnabledDefinitionType |
Complex type | New |
ClassifiedAdAutoAcceptEnabledDefinitionType |
Complex type | New |
PaisaPayFullEscrowEnabledDefinitionType |
Complex type | New |
ShippingPackageDetailsType |
Complex type | Reserved for future use |
CategoryFeatureType.BestOfferAutoAcceptEnabled |
Element | New |
CategoryFeatureType.ClassifiedAdAutoAcceptEnabled |
Element | New |
CategoryFeatureType.PaisaPayFullEscrowEnabled |
Element | New |
CharityInfoType.DisplayLogoSelling |
Element | New |
CharityInfoType.LogoURLSelling |
Element | New |
FeatureDefinitionsType.BestOfferAutoAcceptEnabled |
Element | New |
FeatureDefinitionsType.ClassifiedAdAutoAcceptEnabled |
Element | New |
FeatureDefinitionsType.PaisaPayFullEscrowEnabled |
Element | New |
GeteBayDetailsResponseType.ShippingPackageDetails |
Element | Reserved for future use |
ItemType.MechanicalCheckAccepted |
Element | New |
ListingDetailsType.BestOfferAutoAcceptPrice |
Element | New |
RemindersType.DeclinedRTERequestCount |
Element | New |
RemindersType.DocsForCCProcessingToSendCount |
Element | New |
RemindersType.ItemReceiptConfirmationToReceiveCount |
Element | New |
RemindersType.ItemReceiptToConfirmCount |
Element | New |
RemindersType.PendingRTERequestCount |
Element | New |
RemindersType.RTEToProcessCount |
Element | New |
RemindersType.RefundCancelledCount |
Element | New |
RemindersType.RefundInitiatedCount |
Element | New |
RemindersType.RefundOnHoldCount |
Element | New |
RemindersType.ShippingDetailsToBeProvidedCount |
Element | New |
SellerType.PaisaPayEscrowEMIStatus |
Element | New |
ShipmentType.Notes |
Element | New |
SiteDefaultsType.BestOfferAutoAcceptEnabled |
Element | New |
SiteDefaultsType.ClassifiedAdAutoAcceptEnabled |
Element | New |
SiteDefaultsType.PaisaPayFullEscrowEnabled |
Element | New |
TransactionType.PaisaPayID |
Element | New |
BuyerPaymentMethodCodeType.PaisaPayEscrow |
Enum | New |
BuyerPaymentMethodCodeType.PaisaPayEscrowEMI |
Enum | New |
DetailNameCodeType.ShippingPackageDetails |
Enum | New |
FeatureIDCodeType.BestOfferAutoAcceptEnabled |
Enum | New |
FeatureIDCodeType.ClassifiedAdAutoAcceptEnabled |
Enum | New |
FeatureIDCodeType.PaisaPayFullEscrowEnabled |
Enum | New |
Various enums of NotificationEventTypeCodeType |
Enums | Reserved for internal use |
PaymentMethodSearchCodeType.PaisaPayEscrowEMI |
Enum | New |
As announced in the 529 Release Notes, two earlier styles of schema documentation are no longer supported: the WSDLdoc and the Visual Schema. These documents are frozen at schema version 537.
As announced in May 2007, the Type documentation is easier to access and browse than the WSDLdoc. The Type documentation is highly integrated into the Input/Output Reference. Additionally, the Type documentation contains call-specific, "where used" information that is not in the WSDLdoc.
At the top of any Input/Output Reference page is a link to the index of the Type documentation, enabling you to quickly access documentation for a particular type.
See the System Announcements 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 - 537.
When an item is listed with the Best Offer feature, the seller can specify a price at which offers are automatically accepted. Use of an auto-accept price is similar to use of a minimum-best-offer price. Specify an auto-accept price as Item.ListingDetails.BestOfferAutoAcceptPrice when you use AddItem, ReviseItem, RelistItem, or VerifyAddItem.
Use GetCategoryFeatures to determine if BestOfferAutoAcceptPrice is supported for the category you want to use. You can use BestOfferAutoAcceptPrice on the following sites: US (site ID 0), Canada (site ID 2), Canada French (site ID 210), United Kingdom (site ID 3), Australia (site ID 15), Austria (site ID 16), Belgium French (site ID 23), Germany (site ID 77), Italy (site ID 101), Belgium Dutch (site ID 123), Spain (site ID 186), and Switzerland (site ID 193).
In December 2007, an upgraded version of the PaisaPay payment method will be available on the India site (site ID 203). This upgraded version will introduce an additional post-transaction flow. The PaisaPay method will ensure that the buyer's funds will be secure and remit to the seller only after the item has been shipped by the seller and after the item has been received by the buyer. For some sellers the remittance may happen before the buyer confirms receipt, although the buyer's money will be protected.
This feature will also introduce a new sub-payment method called PaisaPay EMI (equal monthly installment) payment method. Only sellers eligible for the PaisaPay EMI payment method will be able to offer the PaisaPay EMI payment method. The PaisaPay EMI payment method allows buyers to pay in equal monthly installments using ICICI bank credit cards.
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.
GetItem now returns Item.MechanicalCheckAccepted for Car category listings on the UK site to signify that the seller allows the bidder to request mechanical inspection services from RAC.
Now you can provide an alternate URL for your logo when using eBay Giving Works. Set CharityInfoType.DisplayLogoSetting to true, and then specify CharityInfoType.LogoURLSetting to take advantage of this new option.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 537 and Changed Functionality - 537.
Documentation has been updated to state that failing to specify ShippingDetails.InsuranceOption results in ShippingDetails.InsuranceFee being ignored.
Documentation Changes and Errata - 535
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Schema component | Nature of Change |
|---|---|---|
GetExpressWishListRequestType |
Complex type | New |
GetExpressWishListResponseType |
Complex type | New |
RegionOfOriginDetailsType |
Complex type | Reserved for future use |
WishListEntryType |
Complex type | New |
WishListType |
Complex type | New |
StatusCodeType |
Enumerated type | Reserved for future use |
WishListSortCodeType |
Enumerated type | New |
ApplicationDeliveryPreferencesType.PayloadVersion |
Element | New |
ExpressProductType.DetailsURL |
Element | New |
GetItemRequestType.IncludeTaxTable |
Element | New |
GeteBayDetailsResponseType.RegionOfOriginDetails |
Element | Reserved for future use |
OrderType.PaidTime |
Element | New |
OrderType.ShippedTime |
Element | New |
PlaceOfferResponseType.TransactionID |
Element | New |
SetUserNotesRequestType.TransactionID |
Element | New |
TransactionType.PayPalEmailAddress |
Element | New |
AccountDetailEntryCodeType.CreditImmoProFeatureFee |
Enum | New |
AccountDetailEntryCodeType.CreditImmoProFee |
Enum | New |
AccountDetailEntryCodeType.ImmoProFeatureFee |
Enum | New |
AccountDetailEntryCodeType.ImmoProFee |
Enum | New |
UserStatusCodeType.Guest |
Enum | New |
See the System Announcements 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 - 535.
Before API version 535, if you wanted GetItem to return a tax table (if a tax table was associated with an item), you had to set DetailLevel to ReturnAll or ItemReturnDescription. Now, you can use GetItem.IncludeTaxTable, which makes it possible to get a tax table without setting a DetailLevel.
Beginning with API version 535, if a tax table is associated with the item:
Note that if no tax table is associated with the item, no tax table is returned, even if IncludeTaxTable is set to true.
OrderType now contains PaidTime and ShippedTime. If an order has been marked as having been paid for or having been shipped, the corresponding element is returned in GetOrders and GetOrderTransactions.
Before this API version, you could set a User Note for an item being watched. You can now set a User Note for a transaction by providing SetUserNotes.TransactionID.
You can specify PayloadVersion in SetNotificationPreferences if you want to receive notification payloads compatible with your application's schema version.
If you do not specify PayloadVersion in SetNotificationPreferences, the behavior of notifications is the same as it was before the PayloadVersion field was added to the schema (that is, notifications are based on the API version specified as part of your SetNotificationPreferences call).
If you are using SetNotificationPreferences, specify the PayloadVersion field to specify the API version for all notifications for the calling application. If you are using GetNotificationPreferences, the PayloadVersion field contains the API version for all notifications for the calling application.
The PlaceOffer call can return the TransactionID field if, on input, you specified Purchase in the Action field. The TransactionID field contains the ID of the transaction created. For PlaceOffer, this output field applies to the following types of listings: FixedPriceItem and StoresFixedPrice. The output field also applies to Chinese BIN if you specified Purchase on input.
By the end of October, the new status of Guest will be available. Specifically, the User.Status output field of GetUser can contain a new enum value, Guest. This value indicates that the user is a Guest user.
A Guest user has completed certain actions, e.g. has been through checkout using the streamlined Buy-It-Now flow. For more information, see GetUser. The Guest enum value also can be returned by GetItem, GetItemTransactions, and GetSellerTransactions.
This API, available now, enables users to retrieve eBay Express wish lists and view them or publish them to, for example, social networking sites.
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 - 535 and Changed Functionality - 535.
None for this release.
Documentation Changes and Errata - 533
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Schema component | Nature of Change |
|---|---|---|
ListingSubtypeCodeType |
Enumerated type | New |
ListingSubtypeEnum |
Enumerated type | Removed |
PictureUploadPolicyCodeType |
Enumerated type | New |
CalculatedShippingRateType.MeasurementUnit |
Element | New |
ItemType.ListingSubtype |
Element | Removed |
ItemType.ListingSubtype2 |
Element | New |
UploadSiteHostedPicturesRequestType.PictureUploadPolicy |
Element | New |
CountryCodeType.ME |
Enum | New |
CountryCodeType.RS |
Enum | New |
MyMessagesAlertResolutionStatusCode.CustomCode |
Enum | New |
SellerBusinessCodeType.CustomCode |
Enum | New |
ShippingServiceCodeType.USPSExpressMailFlatRateEnvelope |
Enum | New |
ShippingServiceCodeType.USPSExpressMailInternationalFlatRateEnvelope |
Enum | New |
ShippingServiceCodeType.USPSPriorityMailFlatRateBox |
Enum | New |
ShippingServiceCodeType.USPSPriorityMailFlatRateEnvelope |
Enum | New |
ShippingServiceCodeType.USPSPriorityMailInternationalFlatRateBox |
Enum | New |
ShippingServiceCodeType.USPSPriorityMailInternationalFlatRateEnvelope |
Enum | New |
SummaryFrequencyCodeType.CustomCode |
Enum | New |
SummaryWindowPeriodCodeType.CustomCode |
Enum | New |
See the System Announcements 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 - 533.
In Q4 2007, changes to the eBay Philippines and eBay Malaysia sites will enable the sites to have more features. The changes will affect the behavior and values of various fields. The Philippines and Malaysia sites will behave similarly to the Singapore site. The documentation has been updated for these upcoming changes. See Field Differences for eBay Sites for information about fields for international sites.
In upcoming weeks, applications (including non-listing apps, such as photo-editors) will be able to specify that an uploaded picture is available to a seller on the eBay site. The new option is part of the My Picture Uploads feature.
The schema additions for the My Picture Uploads feature are in this schema release. However, the corresponding changes for the eBay site will be available in upcoming weeks.
See the PictureUploadPolicy field of the UploadSiteHostedPictures call for the options that will be available to applications.
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.
It is possible for a seller to offer a shipping service which turns out to be a mis-match in some way with the item(s) being shipped. For example, if a buyer purchases more than one of an item, the weight might be too great for First Class mail. In such a case, GetItemShipping will omit that shipping service from the response.
As of version 533, the package size of "USPS flat rate envelope" (for eBay US listings) is deprecated, and six new shipping services have been added to ShippingServiceCodeType for US domestic and international shipping: USPSExpressMailFlatRateEnvelope, USPSExpressMailInternationalFlatRateEnvelope, USPSPriorityMailFlatRateBox, USPSPriorityMailFlatRateEnvelope, USPSPriorityMailInternationalFlatRateBox, USPSPriorityMailInternationalFlatRateEnvelope.
This change is seen in all calls in which shipping services are involved.
A seller can offer both flat rate box and flat rate envelope services at the same time.
If a seller offers any of these flat rate services, the seller is required to specify a package weight, even though these services are weight-independent. Since each service has a maximum weight limit, eBay validates the weight provided by the seller.
The seller must specify a package size of Package/Thick Envelope when using calculated shipping.
If a seller submits a request with the deprecated package size, it will be converted to Package/Thick envelope. USPS Priority Mail services will be converted to USPSPriorityMailFlatRateEnvelope (or its international counterpart, if appropriate). Likewise, USPS Express Mail services will be converted to USPSExpressMailFlatRateEnvelope (or its international counterpart). A non-blocking warning message will be returned to the seller in the API response.
Active listings using USPS Flat Rate Envelope remain unaffected in the View Item and Checkout flows. eBay will internally treat it as a flat rate service when calculating the cost.
Calculated Shipping is coming in mid-November for the following sites: CA, CAFR, AU. Both domestic and international shipping will be supported. Postal carriers include Canada Post and Australia Post. This is an expansion to calculated shipping support which currently includes the US site.
Item.ShippingDetails.CalculatedShippingRate.MeasurementUnit will be added to better handle the difference between Metric and English weights and dimensions. It can be specified in the input for the following calls:
Custom Item Specifics has now been expanded from 90 leaf categories to 3750 leaf categories. In the next few months, we plan to offer Custom Item Specifics in all categories that do not yet support ID-based attributes.
For information on using Custom Item Specifics, see the eBay Web Services Guide.
The Item.ListingSubtype field is being deprecated as of release 533, and is replaced by the Item.ListingSubtype2 field. The ListingSubtypeEnum code list associated with ListingSubtype will also be deprecated in this release and will be replaced by the ListingSubtypeCodeType list.
If you use a request version lower than 533, you will receive both the ListingSubtype and ListingSubtype2 fields in your call response for applicable items (see eBay's versioning rules for more information). If an item's listing subtype is LocalMarketBestOfferOnly, the new ListingSubtype2 field will return the LocalMarketBestOfferOnly value, but the ListingSubtype field will be returned as null (as before). (If the item's listing subtype is ClassifiedAd, the ClassifiedAd value will be returned in both fields.)
If you use request version 533 (or later), you will only receive the new ListingSubtype2 field.
These changes were necessary for backward compatibility, as the ListingSubtypeEnum code list did not define CustomCode and therefore could not be extended to support LocalMarketBestOfferOnly.
The documentation for Third Party Checkout has been revised to emphasize that applications must use the seller's token when making API calls. The buyer's token that is retrieved via FetchToken is only to be used for authenticating the buyer. It is not to be used for other API calls; other calls will fail if the buyer's token is used, since the token is not authorized for other purposes.
Documentation Changes and Errata - 531
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
| No changes this release. | Not applicable. | Not applicable. |
See the System Announcements 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 - 531.
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 - 531 and Changed Functionality - 531.
The documentation has been updated to state that you must use HTTP version 1.0 for the UploadSiteHostedPictures call.
For the GetSearchResults call, the documentation has been updated to state that if you use UserIdFilter.IncludeSellers or UserIdFilter.ExcludeSellers, the maximum number of sellers you can specify is 100.
The documentation for the GetItem and GetFeedback calls has been updated to state that if a listing ended more than 90 days ago, item information such as the title is not returned.
Documentation Changes and Errata - 529
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Schema component | Nature of Change |
|---|---|---|
FetchTokenRequestType.IncludeRESTToken |
Element | New |
FetchTokenResponseType.RESTToken |
Element | New |
SellingManagerProductDetailsType.CustomLabel |
Element | Reserved for future use |
SellingManagerProductDetailsType.ProductID |
Element | Reserved for future use |
SellingManagerProductDetailsType.QuantityAvailable |
Element | Reserved for future use |
SellingManagerProductDetailsType.UnitCost |
Element | Reserved for future use |
In Q4 2007, we plan to stop supporting two earlier styles of schema documentation in the Trading API: the WSDLdoc and the Visual Schema.
As announced in May 2007, the Type documentation is easier to access and browse than the WSDLdoc. The Type documentation is part of the Input/Output Reference.
If you still use the early-style schema documentation and cannot find needed information in the Type documentation, please drop us a note in the Documentation Forum. The Type documentation is highly integrated into the Input/Output Reference. Additionally, the Type documentation contains call-specific, "where used" information that is not in the WSDLdoc.
At the top of any Input/Output Reference page is a link to the Type Index, enabling you to quickly access documentation for a particular type.
See the System Announcements 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 - 529.
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.
You can use the FetchToken call to retrieve a REST token for a user.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 529 and Changed Functionality - 529.
The samples for AddSecondChanceItem and VerifyAddSecondChanceItem have been corrected. The updates were required for removal of the Fees container from the sample output.
The documentation for County has been updated to note that it is only used by the eBay UK site.
The maximum length for Street1 and Street2 is 100 characters, not 64.
Documentation Changes and Errata - 527
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Schema component | Nature of Change |
|---|---|---|
ShippingServiceCodeType enums (various) |
Enum | New |
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 - 527.
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.
The "Local Delivery/Pickup" shipping service has been deprecated. Two new shipping services have been created as a replacement: "Local Pickup" and "Local Delivery". These behave just like any other shipping service.
Any use of the old shipping service named "Local Delivery/Pickup" will be replaced with "Local Pickup" and a warning will be issued.
In addition, several eBay sites that did not previously support "Local Pickup" as a shipping service now support it.
Local Pickup is available for these sites: US, CA, CAFR, AU, IT, NL, ES.
Local Delivery is available for these sites: US, SG.
New enumeration values in ShippingServiceCodeType: AU_Pickup, CA_Pickup, Delivery, ES_Pickup, FR_Pickup, IT_Pickup, NL_Pickup, Pickup, SG_Delivery.
Instead of "Bidder 1", "Bidder 2", etc., anonymized UserIDs (like HighBidder) will show masked IDs like a****b on the US site (The "Bidder 1", "Bidder 2" format is still used for the UK or AU sites.)
There are no API changes for this. eBay is adding 5 new local market subscription types on 527, but those types will be mapped to the existing LocalMarketRegular value in GetUser (like it is for the rest of the eBay site). In other words, developers won't see any difference in behavior. (But if sellers are aware of their subscription level and they ask why they're not seeing these subscriptions called out, this detail is documented in LocalMarketRegularSubscriptionDefinitionType.)
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 527 and Changed Functionality - 527.
A new maximum length for transaction IDs was announced in May 2006 in the Release Notes and in the weblog. The documentation has been corrected to contain this maximum length for transaction IDs.
The GetCategoryListings documentation has been corrected to no longer list the following fields as possible output fields for this call: PictureURL and PhotoDisplay.
Documentation Changes and Errata - 525
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Schema component | Nature of Change |
|---|---|---|
MotorsLocalMarketEnabledDefinitionType |
Complex type | New |
AuthTokenTypeCodeType |
Enumerated type | Reserved for future use |
AdFormatEnabledCodeType.LocalMarketBestOfferOnly |
Enum | New |
CountryCodeType.GG |
Enum | New |
CountryCodeType.JE |
Enum | New |
CountryCodeType.ZZ |
Enum | New |
CurrencyCodeType.ATS |
Enum | New |
ShippingPackageCodeType enums (various) |
Enum | New |
None for this release. (See New Features for important changes in this release.)
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 - 525.
Effective the week of August 6, when sellers list vehicles for the eBay Motors Local Market only, Item.ListingType must be set to LeadGeneration. FixedPriceItem will no longer be allowed. Additional contact details, Item.ExtendedSellerContactDetails and Item.SellerContactDetails, will be supported for Local Market Listings. New types have been added to the Trading API to support this functionality.
When you list an item, you can use the GalleryPlus feature for self-hosted pictures.
Formerly, the GalleryPlus feature required that a picture was hosted through eBay Picture Services (EPS).
Shopping.com merchants can set the existing SetUserPreferences Request flag value to "All" to make their listings show up on eBay Express if they meet the necessary Express criteria. They can set the flag to "optout" if they don't want their listings to show up on eBay Express.
As previously announced, with release 525 (this release), the lowest supported version has changed from 415 to 447. This means we no longer support objects that were deprecated prior to version 447. See eBay's Tech Support Alert for a list of the fields that are no longer supported. (These fields are no longer listed in eBay's deprecated objects list in this documentation.)
In February and August of each year, eBay increments the lowest supported schema version. In February 2008, the lowest supported version will change to 473. (See eBay's Version Support Schedule.)
As previously announced, IDs used for eBay Stores may reach 64-bit values soon. When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. We will no longer be including biweekly reminders of this expected change in these release notes.
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 - 525 and Changed Functionality - 525.
None for this release.
Documentation Changes and Errata - 523
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
CategoryItemSpecificsType |
Complex type | New |
GetCategorySpecificsRequestType |
Complex type | New |
GetCategorySpecificsResponseType |
Complex type | New |
GetItemRequestType.IncludeItemSpecifics |
Element | New |
GetItemTransactionsRequestType.Platform |
Element | New |
GetOrderTransactionsRequestType.Platform |
Element | New |
GetSellerTransactionsRequestType.Platform |
Element | New |
ShippingServiceCodeType enums (various) |
Enums | New |
TransactionType.CartID |
Element | New |
TransactionType.SellerContactBuyerByEmail |
Element | New |
As previously announced, in August (release 525), the lowest supported version will change from 415 to 447. This means we will stop supporting objects that were deprecated prior to version 447. For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
As previously announced, IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
Effective the week of August 6, when sellers list vehicles for the eBay Motors Local Market only, Item.ListingType must be set to LeadGeneration. FixedPriceItem will no longer be allowed. Additional contact details, Item.ExtendedSellerContactDetails and Item.SellerContactDetails, will be supported for Local Market Listings.
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 - 523.
A handful of shipping carriers have been added for eBay Spain and eBay France.
In early August, eBay US and international sites will enable sellers to create custom Item Specifics in certain categories.
With custom Item Specifics, you enter name/value pairs as strings in AddItem and related calls. GetItem retrieves these strings as-is, in the order in which the seller specified them.
Unlike the current Attributes system, there are no IDs to look up. However, we do give you an option to download names and values that are popular in each category.
Initially, we are releasing this functionality in categories that don't already support Item Specifics (that is, categories that don't support the existing ID-based attributes model). At launch, only a few categories will support custom Item Specifics, but many more categories will support this feature over the next few months. See the Knowledge Base for a list of categories that initially support this feature:
https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1109
For an overview and XML samples, see Working with Custom Item Specifics in the eBay Trading Web Services guide.
Use these calls to list with custom Item Specifics:
In addition, the following calls provide optional functionality for more advanced use cases:
Shopping.com merchants can retrieve transaction information for items sold on Shopping.com via the Shopping.com shopping cart. Shopping.com transactions include the shopping cart identifier, CartID, and SellerContactBuyerByEmail, which indicates whether the buyer has opted to accept emails from all the seller(s) in the Shopping.com shopping cart.
To retrieve transactions made on Shopping.com, set Platform to Shopping in the request for GetItemTransactions, GetOrderTransactions, or GetSellerTransactions.
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 - 523 and Changed Functionality - 523.
The documentation has been corrected with the addition of the MemberMessage.Subject field to the required input for Transaction.AddMemberMessageAAQToPartner.
The documentation has been updated with the following: If you use GeteBayDetails in preparation for listing in the US Motors Parts & Accessories categories, use site ID 0 (which is the site ID of the US site) when you call GeteBayDetails.
Documentation Changes and Errata - 521
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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
CategoryFeatureType.ItemSpecificsEnabled |
Element | New |
CategoryFinanceOfferArrayType |
Complex type | Removed |
CategoryFinanceOfferType |
Complex type | Removed |
CategoryListingsOrderCodeType.PricePlusShippingAsc |
Enum | New |
CategoryListingsOrderCodeType.PricePlusShippingDesc |
Enum | New |
DetailNameCodeType.ItemSpecificDetails |
Enum | New |
DetailNameCodeType.UnitOfMeasurementDetails |
Enum | New |
FeatureDefinitionsType.ItemSpecificsEnabled |
Element | New |
FeatureIDCodeType.ItemSpecificsEnabled |
Enum | New |
FinanceOfferArrayType |
Complex type | Removed |
FinanceOfferType |
Complex type | Removed |
GetCategory2FinanceOffer |
Request/Response | Removed |
GeteBayDetailsResponseType.ItemSpecificDetails |
Element | New |
GeteBayDetailsResponseType.UnitOfMeasurementDetails |
Element | New |
GetFinanceOffers |
Request/Response | Removed |
GetRecommendationsResponseContainerType.ItemSpecificsRecommendations |
Element | New |
ItemSpecificDetailsType |
Complex type | New |
ItemSpecificsEnabledCodeType |
Simple type | New |
ItemSpecificsEnabledDefinitionType |
Complex type | New |
ItemSpecificSourceCodeType |
Simple type | New |
ItemSpecificsRecommendationsType |
Complex type | New |
ItemType.FinanceOfferID |
Element | Removed |
NameValueListType.Source |
Element | New |
NotificationEventTypeCodeType.ItemRevisedAddCharity |
Enum | New |
OrderType.FinanceOfferID |
Element | Removed |
PromotionRuleType.PromotedItem |
Element | Removed (not used) |
PromotionRuleType.SiteID |
Element | Removed (not used) |
RecommendationEngineCodeType.ItemSpecifics |
Enum | New |
SearchSortOrderCodeType.PricePlusShippingAsc |
Enum | New |
SearchSortOrderCodeType.PricePlusShippingDesc |
Enum | New |
ShippingServiceDetailsType.DimensionsRequired |
Element | New |
ShippingServiceDetailsType.ServiceType |
Element | New |
ShippingServiceDetailsType.ShippingPackage |
Element | New |
ShippingServiceDetailsType.SurchargeApplicable |
Element | New |
ShippingServiceDetailsType.ValidForSellingFlow |
Element | New |
SiteDefaultsType.ItemSpecificsEnabled |
Element | New |
UnitOfMeasurementDetailsType |
Complex type | New |
UnitOfMeasurementType |
Complex type | New |
In a few weeks, eBay will be releasing new functionality that enables sellers to create their own Item Specifics in certain categories, and to choose from popular Item Specifics that other sellers have created.
Initially, we will release this functionality in categories that don't already support Item Specifics. At launch, only a few categories will support this feature, but many more categories will enable custom Item Specifics over the next few months.
With custom Item Specifics, you enter name/value pairs as strings in AddItem and related calls. GetItem retrieves these strings as-is, in the order in which the seller specified them. There are no IDs to look up, but we do provide you with recommended names and values based on popular usage.
In release 521, we are providing a preview of the API changes.
Although this feature is not yet functional, all of the following changes are included in the schema as of release 521, except where noted. A few additional fields may be added when the feature is released.
For an overview and XML samples, see Working with Custom Item Specifics in the eBay Trading Web Services guide.
Starting in mid-August, Trading API calls must use SSL 3.0 to make the HTTPS connection. HTTPS connections to the API using SSL 2.0 will no longer be allowed. Support for SSL 2.0 has already been dropped from the Sandbox.
Please refer to this Knowledge Base article for further detail and check status of the switch over to SSL 3.0 requirement using this System Announcement.
As previously announced, in August (release 525), the lowest supported version will change from 415 to 447. This means we will stop supporting objects that were deprecated prior to version 447. For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
As previously announced, IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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 - 521.
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.
Values applicable to GetSearchResults and GetCategoryListings have been added to the schema for the Price Plus Shipping Sort feature. This feature is planned to be enabled by the end of September 2007 for the following sites: US (site ID 0), Germany (77), Canada (2), and Australia (15). This feature causes item sorting to consider shipping costs. For additional information, see the Order field of GetSearchResults.
When you revise a item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. See "Identifying Listings that Benefit Nonprofits" in the Describing Items in a Listing section of the eBay Web Services Guide.
The following new elements are returned under ShippingServiceDetails: DimensionsRequired, ServiceType, ShippingPackage, SurchargeApplicable, ValidForSellingFlow. See ShippingServiceDetails in the Input/Output Reference.
Now the eBay partner can receive notification when an item has been revised to include their charity. (See 'Working with Platform Notifications' in the eBay Web Service Guides for more information.)
Paypal promotional financing is no longer supported in eBay listings. Therefore, GetCategory2FinanceOffer and GetFinanceOffers calls have been deprecated and are no longer functional.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 521 and Changed Functionality - 521.
The documentation is updated with policies and guidelines for using PlaceOffer in the Production environment.
Before using PlaceOffer, please carefully review the PlaceOffer Policies and Guidelines. The PlaceOffer Policies are required for use of PlaceOffer in the production environment. Please carefully write your application to follow all the PlaceOffer Policies.
PlaceOffer enables a user to submit a bid (make an offer) on an item. For competitive-bidding listings (Chinese and Dutch auctions), the call makes a bid. For fixed-price listings (Basic Fixed-Price and eBay Stores Inventory listings), the call purchases the item.
Back to topDocumentation Changes and Errata - 519
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.
