Merchant Data API
You can find links to the Merchant Data API documentation in the top navigation bar.
Are you new to the Large Merchant Services solution?
If so, see Large Merchant Services User Guide -- an introduction to the eBay Large Merchant Services solution.
Are you just getting started with the eBay Developer's Program?
The following links provide useful information for beginners:
|
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
Documentation Changes and Errata - 983
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 983.
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 - 983 and Changed Functionality - 983.
None for this release.
Documentation Changes and Errata - 981
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.
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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
A GuaranteeShipping boolean field was added to the WSDL, but this field will not be returned in OrderReport until the feature becomes available to sellers in October.
Once the feature becomes available, and turned on in the API, this field will be returned as true if the seller chose to use eBay's Guarantee Shipping feature at listing time. With eBay's Guarantee Shipping, the seller will never pay more for shipping than what is charged to the buyer. The Guarantee Shipping price will be based on the shipping service option and on the dimensions and weight of the shipping package. Initially, eBay's Guarantee Shipping feature can not be selected with the Add/Revise/Relist API calls, but must be set up through the Web flow.
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 - 981.
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 - 981 and Changed Functionality - 981.
None for this release.
Documentation Changes and Errata - 979
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 979.
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 - 979 and Changed Functionality - 979.
It was called out in the Call Reference documentation for OrderReport that only orders less than 90 days old may be retrieved with this call.
Documentation Changes and Errata - 977
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 977.
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 - 977 and Changed Functionality - 977.
General cleanup of API Call Reference documentation was performed for Version 977.
Documentation Changes and Errata - 975
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 975.
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 - 975 and Changed Functionality - 975.
None for this release.
Documentation Changes and Errata - 971
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 971.
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 - 971 and Changed Functionality - 971.
Minor updates were made to the field description for the BuyerTaxIdentifier field that is returned in OrderReport.
Documentation Changes and Errata - 965
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.
No changed 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.
| Name | Part of Schema | Type of Change |
|---|---|---|
ProductListingDetailsType.ProductID |
Element | Removed |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 965.
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.
Sellers should no longer use the ProductListingDetails.ProductID field to identify an eBay catalog product in an add/revise/relist call. Instead, the seller should only pass in the eBay Product ID (ePID) through the ProductListingDetails.ProductReferenceID field.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 965 and Changed Functionality - 965.
None for this release.
Documentation Changes and Errata - 963
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.
No changed 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.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
The 2016 Spring Seller Update has been released. Below is a summary of the announced new features and changes:
Starting soon, a seller's choice to opt into or out of Business Policies will determine which API fields can be used when creating/revising/relisting their listings.
Using Business Policies
To list items using Business Policies, the seller will have defined at least one of each of the following Business Policies types:
You can create and manage these profiles in My eBay, or by using the Business Policies Management API. If you are opted in to Business Policies, you will only reference the profile IDs of these business policies in the Item.SellerProfiles container in an Add/Revise/Relist call, and the payment, return policy, and shipping-related fields in those referenced business policies will be used to create or revise the listing instead of the "legacy" payment, return policy, and shipping fields in the Trading API. If you pass in Business Policies profile IDs and the legacy fields, the legacy fields will be ignored and dropped. See the Mapping Business Policies Management API Fields to Trading API Fields table in the Business Policies Users Guide for a complete list of the legacy Trading API fields and their equivalent Business Policies fields that should be used instead.
Opt-In Enforcement Details
Previously, sellers who were opted into Business Policies could create listings using either the Business Policies API fields or the equivalent legacy Trading API fields, or even a combination of the two. This will no longer be allowed.
Any seller who is opted into Business Policies will not be able to use the legacy fields at all, for Payment, Returns or Shipping in any new listing. If legacy fields are passed into the request, they will be ignored and dropped and the seller may get a warning message to that effect.
One exception to this requirement: when an opted-in seller has an existing listing. If the listing uses only legacy fields, the seller can relist or revise the item using legacy fields, until the listing expires/ends, or is withdrawn by the seller. However, if the listing uses a combination of legacy fields and business policies, the seller will be prevented from continuing the listing, and will receive an error message indicating that they must cancel the listing and recreate it with business policies only.
Opt-Out Enforcement Details
If a seller is opted out of (or have not opted into) Business Policies, that seller cannot reference any business policies to create, relist, or revise any listing.
Actions to Take
Act now to ensure that your selling application gracefully anticipates the upcoming change, so sellers will not be inconvenienced as they conduct their business on eBay:
true.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 - 963.
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 - 963 and Changed Functionality - 963.
None for this release.
Documentation Changes and Errata - 959
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 959.
In the AddItem family of calls, the ItemCompatabilityType type has been expanded to accept eBay Product ID (ePID) numbers on the DE and UK eBay sites to specify parts compatibility for motorcycle and scooter parts compatibility. For details and examples, see the Features 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 - 959 and Changed Functionality - 959.
Previously, the documentation erroneously indicated that Shipment.ShipmentLineItem was conditionally required in the SetShipmentTrackingInfo call request. In fact, the ShipmentLineItem container was and is part of ShipmentTrackingDetails, and the documentation now correctly displays Shipment.ShipmentTrackingDetails.ShipmentLineItem in the request prototype.
Documentation Changes and Errata - 957
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
In the AddItem family of calls, the ItemCompatibilityType type will soon be expanded to accept eBay Product ID (ePID) numbers on the DE and UK eBay sites to specify parts compatibility for motorcycles (in DE, scooter parts compatibility is also supported). For details and examples, see the Features Guide.
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 - 957.
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.
Sellers in the UK and US who take advantage of the Global Shipping Program send their shipments to the respective address of their international shipping provider's domestic warehouse, from which the carrier completes the shipment. The mailing addresses of the UK and US warehouses have changed.
The new warehouse addresses are returned by the OrderReport call. The new addresses are as follows:
UK Warehouse
GSP Shipping Centre, 1 Langham Park South Normanton DE55 2GF
US Warehouse
1850 Airport Exchange Blvd #200 Erlanger KY 41025
For details about how to use this information, see Addressing a Global Shipping Program Shipment.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 957 and Changed Functionality - 957.
None for this release.
Documentation Changes and Errata - 955
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.
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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 955.
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.
Skrill (formerly Moneybookers), Paymate, and ProPay are no longer supported as acceptable payment methods on any eBay site. Starting with Version 945, sellers were already blocked from specifying these payment methods in listing calls, but the enumeration values associated with these payment methods (Moneybookers, Paymate, and ProPay) were still being returned in OrderReport and SoldReport. These three enumeration values have now been removed from BuyerPaymentMethodCodeType and will not be returned in any calls.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 955 and Changed Functionality - 955.
The Shipment container in the request payload structure of the SetShipmentTrackingInfo call was previously misrepresented. The deprecated ShippingCarrierUsed and ShipmentTrackingNumber fields had been replaced by a new ShipmentTrackingDetails container with new versions of those same fields, as well as a set of Global Shipping Program fields, but neither the old or the new fields appeared in the documentation. This has been fixed, so the Shipment container now looks like the following:
<Shipment>
<ShipmentTrackingDetails>
<ShippingCarrierUsed></ShippingCarrierUsed>
<ShipmentLineItem>
<LineItem>
<CountryOfOrigin></CountryOfOrigin>
<Description></Description>
<ItemID></ItemID>
<Quantity></Quantity>
<TransactionID></TransactionID>
</LineItem>
</ShipmentLineItem>
<ShipmentTrackingNumber></ShipmentTrackingNumber>
</ShipmentTrackingDetails>
<ShippedTime></ShippedTime>
</Shipment>
Note: The ShipmentLineItem container is required only for Global Shipping Program shipments. For more information about all of the fields in the ShipmentTrackingDetails container, see the SetShipmentTrackingInfo call reference.
Documentation Changes and Errata - 951
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 951.
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 - 951 and Changed Functionality - 951.
General cleanup of API Call Reference documentation was performed for Version 951.
Documentation Changes and Errata - 949
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 949.
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 - 949 and Changed Functionality - 949.
General cleanup of API Call Reference documentation was performed for Version 949, including an update to the copyright year in all page footers.
Documentation Changes and Errata - 947
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 947.
The eBay US site now supports a new type of flat rate shipping service: Flat Rate Freight. This feature provides convenience and predictable cost to buyers on freight shipping of heavy and bulky packages within the United States. Any listing that requires freight shipping can be offered by the seller with free shipping or a single flat rate for all domestic buyers. The seller negotiates the actual shipping cost with the freight carrier separately from the checkout process, so the sale can be completed quickly. This improves on conventional freight, which requires the seller to negotiate the shipping cost with the carrier and the buyer before completing the sale.
When using the Add, Relist, Revise, or Verify families of calls to create a listing, the combination of the ShippingDetails.ShippingType and ShippingDetails.ShippingServiceOptions.ShippingService fields is unique for each eBay site and freight shipping option. For Flat Rate Freight, set ShippingType to Flat and ShippingService to FlatRateFreight.
Flat Rate Freight is technically a flat rate option (ShippingType=Flat), but the guidelines for both flat rate shipping and freight shipping apply to Flat Rate Freight. For details, see Specifying Flat Rate Shipping and Specifying Freight Shipping.
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 - 947 and Changed Functionality - 947.
None for this release.
Documentation Changes and Errata - 945
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.
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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
Sellers can no longer specify Skrill/Moneybookers, ProPay, or Paymate as accepted payment methods when adding/revising/relisting items. If Moneybookers, Paymate, and/or ProPay are provided as values in a PaymentMethods field of an add/revise/relist call, the listing will be rejected. Existing listings that have any of these accepted payment methods will be allowed to stay active without any revisions, but beginning in mid to late November, eBay will start asking sellers to modify these listings as well, removing these deprecated payment methods from the listings.
Note that the Moneybookers, Paymate, and/or ProPay may still get returned in OrderReport in the short term, but once these values are hard deprecated, they will not be returned at all.
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 - 945.
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 - 945 and Changed Functionality - 945.
None for this release.
Documentation Changes and Errata - 943
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.
No changed 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.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
Starting with Version 945 and going forward, the Decimal enumeration value of ValueTypeCodeType will be replaced by the Numeric data type when the recommended Item Specific is numeric in nature. For the Version 943 WSDL and older, Decimal will continue being returned.
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 - 943.
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 - 943 and Changed Functionality - 943.
None for this release.
Copyright © 2009–2015 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.