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 - 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.
Documentation Changes and Errata - 1145
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 April 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. From June 2019 up until now, users could control whether the new or old order ID format was returned in response payloads. This change affects the following calls:
Note that unique identifiers of orders change as they transition from 'commit to buy'/unpaid to paid orders. So, users will still be able to pass in the IDs for unpaid orders for OrderAck and SetShipmentTrackingInfo, but once orders are paid for, sellers should only use/reference the new order ID format (for paid orders), as these are the identifiers that will also be known to the buyers.
Currently, in Add/Revise/Relist calls, sellers have an option to identify a nonprofit organization with the eBay unique identifier through the Charity.CharityID field, or they can identify the same nonprofit organization using the PayPal Giving Fund unique identifier through the Charity.CharityNumber field. The CharityNumber field has been scheduled for deprecation, so sellers using the CharityNumber field should make plans to migrate to the CharityID field instead.
The eBay unique identifier for nonprofit organizations is shown in the id attribute of each Charity container returned in the response of the GetCharities call.
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 - 1145.
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.
Previously, the Succeeded enumeration value would automatically get returned in the Payment.PaymentStatus field for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1145 and Changed Functionality - 1145.
Made it more clear in Add/Revise/Relist call documentation that the CharityID field in CharityType is designed for the eBay unique identifier of a nonprofit organization, and the CharityNumber field in CharityType is designed or the PayPal Giving Fund unique identifier of a nonprofit organization. The CharityNumber field has been scheduled for deprecation, so users should make plans to use CharityID instead.
Documentation Changes and Errata - 1139
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 - 1139.
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 - 1139 and Changed Functionality - 1139.
Added a note to the VariationProductListingDetails.ProductReferenceID field about it not being supported for any categories. Currently, sellers cannot associate an eBay catalog product with single variations within a multiple-variation listing. If the seller attempts to supply an eBay Product Identifier (ePID) at the variation level, a warning will get returned and the ePID value will just be dropped. This change affects the AddFixedPriceItem, ReviseFixedPriceItem, RelistFixedPriceItem, and VerifyAddFixedPriceItem calls.
Included a note and a link in the Item.Description field about the View Item Description Summary Feature. This feature allows sellers to customize the description of an item as it appears on a mobile device. This customization is done through the use of special HTML div and span tags and attributes.
Added site-specific max length values for several address-related fields (in AddressType), including Street1, Street2, CityName, StateOrProvince, and PostalCode. For all five of these fields, the max lengths according eBay marketplace are shown:
Documentation Changes and Errata - 1131
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 |
|---|---|---|
OrderDetailsType.TotalIncludeseBayCollectedTax |
Field | New |
OrderLineItemType.TotalIncludeseBayCollectedTax |
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.
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 - 1131.
New TotalIncludeseBayCollectedTax boolean fields added to SoldReport and FeeSettlementReport responses to indicate if order and order line item amounts include eBay 'Collect and Remit' taxes. eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Good and Services' taxes that are applicable to Australian and New Zealand sellers. If this TotalIncludeseBayCollectedTax boolean field is returned as true, the tax amount shown in the Taxes.TaxDetails.TaxAmount field for each line item is reflected in the total line item cost and total order cost. The total order cost is shown in the OrderDetails.OrderTotalCost field, and the total order line item cost is shown in the OrderLineItem.TotalCost field. For a single line item order, the amounts in these two fields should be the same, but for a multiple line item order, the seller would need to view and add up the taxes shown in the Taxes.TaxDetails.TaxAmount field for each line item in the order.
As of early November, for orders subject to eBay 'Collect and Remit' taxes, PayPal began distributing order funds to the seller's account with the sales tax included. However, shortly after the order funds clear in the seller's account, the 'Collect and Remit' tax amount is pulled by PayPal from the seller's account and then disributed to the appropriate taxing authority. Previously, PayPal was stripping this 'Collect and Remit' tax from the buyer's payment and directly submitting this amount to the appropriate taxing authority, and this tax amount never showed up in the sellers account.
This change does not affect sellers that are already opted in to eBay managed payments. For these sellers, the sales tax amount will never be included in a seller payout.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
A new error code (21920255) was added to cover 'Buy it Now' prices that exceed the maximum thresdhold for a category. If a seller specifies the 'Buy it Now' price at a value above this threshold, this error code is returned and the seller is blocked from listing/revising an item.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1131 and Changed Functionality - 1131.
None for this release.
Documentation Changes and Errata - 1129
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 |
|---|---|---|
CollectionMethodCodeType |
Type | New (reserved for future use) |
TaxDetailsType.CollectionMethod |
Field | New (reserved for future use) |
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 early November, for orders subject to eBay 'Collect and Remit' taxes, PayPal will begin distributing order funds to the seller's account with the sales tax included. However, shortly after the order funds clear in the seller's account, the 'Collect and Remit' tax amount will be pulled by PayPal from the seller's account and then disributed to the appropriate taxing authority. Currently, PayPal is stripping this 'Collect and Remit' tax from the buyer's payment and directly submitting this amount to the appropriate taxing authority, and this tax amount never shows up in the sellers account.
eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' tax that is applicable to Australian and New Zealand sellers. To accomodate for these changes, the order management calls and the GetAccount call was updated. See the Changed Functionality section for more information about how these API calls are handling this logic change.
This change does not affect sellers that are already opted in to eBay managed payments. For these sellers, the sales tax amount will never be included in a seller payout.
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 - 1129.
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.
Beginning in early November, for orders subject to eBay 'Collect and Remit' taxes, PayPal will begin distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' tax that is applicable to Australian and New Zealand sellers. Due to this change, the following updates were made to OrderReport:
This change does not affect sellers that are already opted in to eBay managed payments. For these sellers, the sales tax amount will never be included in a seller payout. For sellers that are opted in to eBay managed payments, the 'Collect and Remit' tax will only be shown in the Transaction.eBayCollectAndRemitTaxes container, and not in the Transaction.Taxes. For sellers not opted in to eBay managed payments, both of these containers will appear in the response showing the 'Collect and Remit' tax details.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1129 and Changed Functionality - 1129.
None for this release.
Copyright © 2009–2020 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.