Merchant Data API

Merchant Data API Release Notes

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:

Q2 2020
Version Release Date
1159 2020-Jun-19
1157 2020-Jun-05
1155 No Schema or Doc Updates
1153 No Schema or Doc Updates
1151 No Schema or Doc Updates
1149 No Schema or Doc Updates
Q1 2020
Version Release Date
1147 No Schema or Doc Updates
1145 No Schema or Doc Updates
1143 No Schema or Doc Updates
1141 No Schema or Doc Updates
1139 2020-Jan-31
1137 No Schema or Doc Updates
1135 Skipped
Q4 2019
Version Release Date
1133 Not Released
1131 2019-Oct-25
1129 2019-Oct-11
Q3 2019
Version Release Date
1127 Not Released
1125 Not Released
1123 Not Released
1121 Not Released
1119 Not Released
1117 Not Released
1115 Not Released

These release notes go back four quarters. For older release notes, see the Release Notes archive.

Version 1157

Index of Changed Calls - 1157

Schema Changes - 1157

Announcements - 1157

New Features - 1157

Changed Functionality - 1157

Documentation Changes and Errata - 1157

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1157

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1157

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.

Announcements - 1157

Change Requests

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.

Old Order ID Format Values No Longer Supported in Responses

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.

New Required Item Specifics Rolled Out to Some Categories

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.

Listing Designer Templates Retired

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.

New Features - 1157

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.

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.

Documentation Changes and Errata - 1157

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.

Clarification on PrivateListing Field

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.

Clarified the Behavior of Domestic and International Return Policies

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.

Version 1145

Index of Changed Calls - 1145

Schema Changes - 1145

Announcements - 1145

New Features - 1145

Changed Functionality - 1145

Documentation Changes and Errata - 1145

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1145

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1145

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.

Announcements - 1145

Change Requests

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.

Only New Order ID Format will be Returned for Paid Orders Beginning in April

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.

CharityNumber Field Scheduled to be Deprecated

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.

New Features - 1145

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.

Changed Functionality - 1145

This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.

New Behavior for PaymentStatus Field in Order Report

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.

Documentation Changes and Errata - 1145

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 Some Updates to Charity-related Documentation

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.

Version 1139

Index of Changed Calls - 1139

Schema Changes - 1139

Announcements - 1139

New Features - 1139

Changed Functionality - 1139

Documentation Changes and Errata - 1139

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1139

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.

New Calls

No new calls in this release.

Changed Calls

No changed calls in this release.

Schema Changes - 1139

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.

Announcements - 1139

Change Requests

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.

New Features - 1139

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.

Changed Functionality - 1139

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.

Documentation Changes and Errata - 1139

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 About ePIDs Not Being Supported at Variation Level

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.

Added Note and Link About Customizing View Item Description in Mobile Devices

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 Address Fields

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:

Version 1131

Index of Changed Calls - 1131

Schema Changes - 1131

Announcements - 1131

New Features - 1131

Changed Functionality - 1131

Documentation Changes and Errata - 1131

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1131

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1131

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

Announcements - 1131

Change Requests

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.

New Features - 1131

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 Boolean Fields Added to Indicate if Order/Line Item Amounts Include 'Collect and Remit' Tax

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.

Changed Functionality - 1131

This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.

New Error Code Added to Cover BIN Prices Exceeding Threshold

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.

Documentation Changes and Errata - 1131

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.

Version 1129

Index of Changed Calls - 1129

Schema Changes - 1129

Announcements - 1129

New Features - 1129

Changed Functionality - 1129

Documentation Changes and Errata - 1129

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1129

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1129

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)

Announcements - 1129

Change Requests

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.

Changes to eBay Collect and Remit Taxes

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.

New Features - 1129

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.

Changed Functionality - 1129

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.

Update to OrderReport for eBay Collect and Remit Taxes

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.

Documentation Changes and Errata - 1129

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.