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 - 1193
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
FulfillmentType |
Type | New |
Program.Fulfillment |
Field | New |
ShippingServiceCostOverride.ShippingSurcharge |
Field | Removed |
The SoldReport call has been decommissioned. eBay recommends that large sellers and developers migrate to the Sell Feed API order_task methods, or OrderReport of LMS.
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 - 1193.
A new Fulfillment container will be returned in OrderReport for paid orders being fulfilled by eBay or an eBay fulfillment partner.
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 all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Condition ID 2500, 'Seller Refurbished' is the other option for sellers.
Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center.
The capability for sellers to create and maintain multiple domestic and international shipping rate tables has rolled out to the UK and Germany marketplaces. Prior to this, these sellers only had one 'default' domestic shipping rate table and one 'default' international shipping rate table.
In Add/Revise/Relist calls, a seller specifies the domestic and/or international shipping rate table to use for the listing through the ShippingDetails.RateTableDetails container.
Multiple shipping rate tables are now supported in the following marketplaces: US, Australia, Canada (English and French), Italy, UK, and Germany.
The ShippingServiceCostOverride.ShippingSurcharge has been removed from WSDL. This field was already not usable and was marked as deprecated. Sellers can only apply shipping surcharges to shipping service options through the Shipping rate tables tool in My eBay.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1193 and Changed Functionality - 1193.
None for this release.
Documentation Changes and Errata - 1189
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.
None for 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 - 1189.
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 following warning message was added:
21920296: PayPal email address, PayPal payment method and Item.PaymentDetails container have been removed from this Classified listing.
The existing 21916605 error message was updated to: Only single item quantity is permitted when the listing is in auction-style or under selected categories in FixedPrice format. Before the update, this error message text was not covering the fixed-price use case.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1189 and Changed Functionality - 1189.
The ShippingSurcharge field in ShippingServiceCostOverrideType marked as deprecated. Sellers can no longer directly apply shipping surcharges to listings through Add/Revise calls or through shipping business policies. Shipping surcharges can only be applied to shipping service options through the Shipping rate tables tool in My eBay.
Added a note to Item.eBayPlus field description about the field not being supported for Australian sellers. In Australia, eBay will evaluate/determine whether a listing is eligible for eBay Plus, and the seller has no control over setting the feature for a listing.
Documentation Changes and Errata - 1179
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 - 1179.
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 - 1179 and Changed Functionality - 1179.
Some minor documentation updates were made to various type files.
Documentation Changes and Errata - 1177
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 - 1177.
New enumeration values were added to AuthenticityVerificationType. Values now account for order line items that fail authentication and are not able to be returned to the seller because of legal constraints, and for order line items that are passed with exception.
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.
Below is the list of updated error messages that rolled out with the 1177 release:
10122: Picture URL cannot contain semicolon.21920282: New Payment Terms of Use will soon be in effect. Please go to replaceable_value to accept the agreement.21920283: You need to accept the new Payment Terms of Use before you can create or revise listings. Please go to replaceable_value to accept the agreement.These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1177 and Changed Functionality - 1177.
None for this release.
Documentation Changes and Errata - 1173
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.
The 2020 Fall Seller Update page was published. Below are some of the highlights:
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 - 1173.
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 currency of the listing fees returned under the Fees container in add/revise/relist calls will reflect the listing site's currency, and not necessarily the seller's default/home currency. Previously, the currency used for these listing fees was the seller's default/home currency even if that seller was listing on a site outside of their home country. This change affects the following calls:
Below is the list of the new error messages that rolled out with the 1173 release:
21920292: You cannot remove a SKU when Item InventoryTrackingMethod is set to SKU.21920293: This application is not permitted to update the eBay fulfillment flag.21920294: Picture URL cannot be a stock photo. replaceable_value picture URL(s) have been dropped.21920295: Picture URL cannot contain html or javascript content like ".cookie", ".location", "ebviewitem.", "showhelp", "showmodaldialog", "navigateandfind", "createpopup", "standardwrite", "writepersonalizedheader", "blockactivecontent".These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1173 and Changed Functionality - 1173.
None for this release.
Documentation Changes and Errata - 1169
For a current list of known issues, see Site Status Updates and the Knowledge Base.
No calls were added, modified, deprecated, or affected by documentation changes in this release.
There are 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.
The Quantity and StartPrice response fields in the InventoryStatusType are being deprecated, and they will no longer be supported after April 30, 2022. eBay has found that the values returned for these fields are not reliably accurate and recommends that the responses for these fields be ignored.
The Quantity and StartPrice request fields can still be used, and sellers can leverage the GetItem call to verify that the requested quantity and/or price updates were successful.
This deprecation affects the ReviseInventoryStatus call.
There are no new features in 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.
Error messages (21920285, 21920286, 21920287, 21920288, 21920290, and 21920291) were added to this release of the Trading API. Error message (80) was also updated. Below is the list of the new and updated error messages that rolled out with the 1169 release:
80: This site does not support Private Dutch Auction, Private Buy It Now Auction or Private Fixed Price listings.21920285: Quantity cannot be updated for items that are fulfilled by eBay.21920286: Items that are fulfilled by eBay do not allow these operations - Edit item SKU, Edit variation SKU, Add/Delete variations, Add/Delete variation specifics and Add/Delete variation pictures.21920287: SKU is required in every variation for items that are fulfilled by eBay.21920288: If your item sells for $10,000 or more, you agree to accept payment via Escrow.com and to allow eBay to amend your return policy to offer 7-day returns. Learn more at https://pages.ebay.com/escrow.21920290: eBay fulfillment cannot be applied to an item when there is a pending offer.21920291: Additional shipping cost was dropped from the listing either because it is not applicable or the quantity was set to <=1.These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1169 and Changed Functionality - 1169.
None for this release.
Documentation Changes and Errata - 1165
For a current list of known issues, see Site Status Updates and the Knowledge Base.
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
AuthenticityVerificationType |
Type | New |
TransactionProgramType |
Type | New |
Transaction.Program |
Field | New |
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 SoldReport call is being deprecated. No new features and/or fields will be added to SoldReport, and it will no longer be supported at all after January 30, 2021. eBay recommends that large sellers and developers migrate to the Sell Feed API order_task methods, or OrderReport of LMS.
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 - 1165.
A new Program container is returned for orders subject to the Authenticity Guarantee service program. With the Authenticity Guarantee service program, some high-value items in specific categories, like luxury watches or handbags, must be authenticated by a third-party authenticator before being sent to the buyer.
This program is initially only available to a select number of sellers, but this program will eventually become applicable and required for all sellers selling specific items in specific categories.
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 - 1165 and Changed Functionality - 1165.
None for this release.
Documentation Changes and Errata - 1161
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 - 1161.
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 calculation of the Final Value Fee is changing for managed payments sellers, so the values returned in the FinalValueFee field for each order line item in OrderReport should only be considered as estimated values. The getTransactions method of the Finances API can be used to get accurate Final Value Fee values.
See the Selling fees for managed payments sellers help page for more information about how Final Value Fees are changing for managed payments sellers.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1161 and Changed Functionality - 1161.
The retiring of Listing Designer templates was already announced with Version 1157, but now the ListingDesigner field in ItemType has been removed from the 1161 Version of the WSDL. Existing listings that are already using a Listing Designer template will remain unchanged. If a seller tries to use a Listing Designer template using the ListingDesigner container, it will have no effect on the listing, but the seller will receive a warning message about Listing Designer templates no longer being available.
Documentation Changes and Errata - 1157
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.
Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level. When the new order ID format was first introduced in June 2019, eBay gave sellers the option of using the old or the new format. To use the old Order ID format, sellers could use a WSDL older than Version 1113, or they could set the Compatibility-Level header to a value predating Version 1113. That capability is no longer available, and only new order ID values are returned for paid orders.
Note that only OrderReport returns new Order ID values. SoldReport was never enabled to return new Order ID values.
As part of the Spring 2020 Seller Update, it was announced that new required item specifics were rolled out, or were scheduled to roll out to several categories, including Watches, Electronics, Home & Garden, Business & Industrial, Sporting Goods, Toys, and Fashion. For a complete list of specific changes to these categories, see the Item Specifics page on Seller Center.
Sellers can also use the GetCategorySpecifics call or the getItemAspectsForCategory or fetchItemAspects methods of the Taxonomy API to retrieve the latest item specifics metadata for one, multiple, or all (leaf) categories. A new Taxonomy SDK is also available to compare and discover the item specifics metadata that was recently added or changed in any of eBay's leaf categories.
As of May 31, 2020, sellers are no longer able to use Listing Designer templates when they create or revise listings. Existing listings that are already using a Listing Designer template will remain unchanged.
If a user attempts to use the ListingDesigner container in an Add/Revise/Relist API call, it will have no effect on the listing, but the seller will receive a warning message about Listing Designer templates no longer being available.
The GetDescriptionTemplates call will still retrieve Listing Designer template data, but none of retrieved templates will be usable to create or revise a listing.
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 - 1157.
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 - 1157 and Changed Functionality - 1157.
The PrivateListing field was mistakenly removed from the Trading WSDL and docs back in Version 1045, but was added back in Version 1095. Although this field was removed from WSDL, the logic for this field was never wired off and the field was still honored if provided. The PrivateListing field allows sellers to make bidders on auction listings anonymous to other fellow bidders, and only the seller can see bidders' user IDs.
Updated return policy-related documentation to make it more clear that if a seller does not add a separate international return policy for an item, the settings in the domestic return policy will be used instead. For more information on setting separate domestic and international return policies, see the International returns policyhelp topic.
Copyright © 2009–2021 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.