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:

Q3 2018
Version Release Date
1081 2018-Sep-28
1079 Not Released
1077 2018-Aug-31
1075 Not Released
1073 2018-Aug-03
1071 Not Released
1069 Not Released
Q2 2018
Version Release Date
1067 2018-Jun-22
1065 Not Released
1063 Not Released
1061 Not Released
1059 Not Released
1057 Not Released
Q1 2018
Version Release Date
1055 Not Released
1053 Not Released
1051 Not Released
1049 Not Released
1047 Not Released
1045 Not Released
1043 Not Released
Q4 2017
Version Release Date
1043 Not Released
1041 Not Released
1039 2017-Oct-27
1037 Not Released

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

Version 1081

Index of Changed Calls - 1081

Schema Changes - 1081

Announcements - 1081

New Features - 1081

Changed Functionality - 1081

Documentation Changes and Errata - 1081

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

Index of Changed Calls - 1081

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 - 1081

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 - 1081

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 Regional Shipping Rate Tables Available for Three More Countries

Regional shipping rate tables have been enabled for the following sites: Canada (English), Canada (French), and Italy. With regional shipping rate tables, the seller can customize and set the shipping rates based on shipping speed (One-Day, Expedited, Standard, Economy) and distance to specified domestic regions. Regional shipping rate tables are required for sellers opted into the eBay Guaranteed Delivery feature and using the 'Door-to-Door' option.

In Add/Revise/Relist calls, a domestic shipping rate table can be applied to a listing by using the DomesticRateTableId field. The unique identifiers of shipping rate tables can be found by using the getRateTables method of the Account API, or these identifiers can be viewed in the browser's URL field when a specific rate table is selected.

New Features - 1081

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 - 1081.

None for this release.

Changed Functionality - 1081

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.

30-Day Listing Duration Enabled for eBay Motors Listings

Sellers can now select a 30-day listing duration for eBay Motors listings. The 30-day listing duration will replace the 21-day listing duration, a duration time that will soon be wired off for eBay Motors listings.

In Add/Revise/Relist calls, the listing duration is set with the ListingDuration field, and Days_30 is used for a 30-day listing duration.

CategoryBasedAttributesPrefill Field Deprecated

The CategoryBasedAttributesPrefill field is no longer applicable, has no affect, and has been removed from the WSDL as of Version 1081. It should no longer be used in Add/Revise/Relist/Verify calls. If this field is used, a warning will be triggered when the call is executed.

More Flexibility in Revising Charitable Listings

A seller can now disable any charitable donation that is set up for a listing by using the DeletedField in a Revise call, and passing in the string value, Item.Charity. The charitable donation feature cannot be disabled for an auction listing if there are any active bids on the listing, and it cannot be disabled if there are any pending Best Offers/Counter Offers on a listing.

Similarly, the non-profit organization and donation percentage in an active listing can now be modified in a Revise call, as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing. To revise the non-profit organization and/or donation percentage, the CharityID and/or DonationPercent fields are used.

More Flexibility in Deleting Variations

A seller can now use the ReviseFixedPriceItem call to delete a variation in a multiple-variation listing, even if that variation still has quantity and/or has had one or more previous sales during the life of the listing. The Variation.Delete boolean field is used to delete the variation. Previously, if a variation had any purchases, you could not delete the variation, but only set its quantity to zero.

Documentation Changes and Errata - 1081

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1081 and Changed Functionality - 1081.

Max Length of PaymentInstructions Field Corrected

The maximum length of the PaymentInstructions field (in ShippingDetails container) was inaccurately documented as 1000, when the actual maximum length is actually 500 characters. This field can be used in Add/Revise/Relist calls, and is also returned in order management calls when set on the listing.

Shipping Insurance and Warranty Documentation Cleaned Up

Sellers can no longer offer shipping insurance and product warranties to buyers through API flows, so all types and fields related to shipping insurance and product warranties have been marked as deprecated, but have not been completely removed from the public WSDL yet.

Version 1077

Index of Changed Calls - 1077

Schema Changes - 1077

Announcements - 1077

New Features - 1077

Changed Functionality - 1077

Documentation Changes and Errata - 1077

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

Index of Changed Calls - 1077

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 - 1077

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
EndReasonCodeType.ProductDeleted Enum New

Announcements - 1077

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.

Updates to California Proposition 65 Going into Effect

As of August 30, 2018, California will require certain sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact health of California buyers. To enable sellers to show this warning on a listing, eBay is adding a new 'California Prop 65 Warning' item specific to listing flows.

Unlike standard item specifics that allow a maximum of 65 characters in the NameValueList.Value field in an Add/Revise/Relist call, the matching value for the 'California Prop 65 Warning' item specific allows up to 800 characters of text. When a seller passes in this item specific, eBay will automatically insert a warning symbol icon for the listing.

This requirement applies to all single and multiple-variation listings in most eBay US categories (including eBay Motors, Motors Parts & Accessories, and PBSE-enforced categories).

For multiple-variation listings, the 'California Prop 65 Warning' is passed just once at the listing level, and will be propagated to each variation. For Product-Based listings, this 'California Prop 65 Warning' is also required at listing time, and will get picked up by the listing.

For more information about Proposition 65, see the New Proposition 65 Warnings page on the CA.gov site.

New Features - 1077

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 - 1077.

None for this release.

New End Listing Reason Added

A new ProductDeleted enumeration value was added to EndReasonCodeType. This enumeration value cannot be used by the seller in an End listing call, but it will get returned in GetItem if a listing was administratively ended by eBay if the item in a listing becomes unpurchasable due to the eBay Catalog product associated with the listing being removed from the catalog.

Changed Functionality - 1077

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.

No Restriction on Dropping Secondary Category on a Listing

Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category in a ReviseItem or ReviseFixedPriceItem call, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field, as shown below:

<SecondaryCategory>
   <CategoryID>0</CategoryID>
</SecondaryCategory>

Documentation Changes and Errata - 1077

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1077 and Changed Functionality - 1077.

Updated RestrictedToBusiness Field Description

Updated the RestrictedToBusiness field description to include UK as another country that supports Business-to-Business listings.

Version 1073

Index of Changed Calls - 1073

Schema Changes - 1073

Announcements - 1073

New Features - 1073

Changed Functionality - 1073

Documentation Changes and Errata - 1073

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

Index of Changed Calls - 1073

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 - 1073

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 - 1073

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.

Return Policy Metadata Moving to GetCategoryFeatures

Currently, the GeteBayDetails call in Trading API is used to retrieve site-level, return policy metadata. Starting in September 2018, the GetCategoryFeatures call in Trading API will start returning category-level metadata for both domestic and international return policies, and developers should make plans to use that call for this metadata instead.

2018 Fall Seller Update Now Available

The 2018 Fall Seller Update is now available. Below are just a few updates that are available in the Seller Update:

New Features - 1073

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 - 1073.

Support for Variation-Level ePIDs in PBSE Categories

The VariationProductListingDetails.ProductReferenceID in AddFixedPriceItem, ReviseFixedPriceItem, and RelistFixedPriceItem calls has been wired on for use when listing in PBSE categories. This field can only be used for listings in categories where PBSE is either enabled or enforced. In PBSE-enforced categories, a unique ePID will actually be required for each variation in the multiple-variation listing.

Changed Functionality - 1073

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.

Months_1 Enum in ReturnsWithinCodeType Being Deprecated

The Months_1 enum value, historically only supported on the DE and AT sites, is scheduled to be deprecated, and DE and AT sellers may be blocked from creating, revising, or relisting an item if they do use this value in the ReturnPolicy.InternationalReturnsWithinOption or ReturnPolicy.ReturnsWithinOption fields beginning in late August 2018. Use Days_30 instead.

30-Day Return Period Replaces 14-day as the Default

If the ReturnsWithinOption and/or InternationalReturnsWithinOption values are not specified in the Return Policy of an Add/Revise/Relist call, the default value with by 30 Days (Days_30). Previously, the default value was 14 Days (Days_14)

Valid Best Offer Threshold Values Retained When Revising Item

If the price for a fixed-price item (set in the StartPrice field) is changed with a ReviseItem or ReviseFixedPriceItemcall, the Best Offer Auto-Accept (BestOfferAutoAcceptPrice) and/or Best Offer Auto-Decline (MinimumBestOfferPrice) price values will be retained (if set for the listing) as long as they are still considered valid against the new fixed price.

Documentation Changes and Errata - 1073

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1073 and Changed Functionality - 1073.

Updated DomesticRateTableId and InternationalRateTableId Descriptions

Updated the DomesticRateTableId and InternationalRateTableId field descriptions to describe how to unassociate/remove a shipping rate table from an individual listing using the Revise or Relist calls.

Corrected Description of Transaction.TransactionPrice Field

Made a correction to the field description. This field was inaccurately described as including shipping charge and sales tax, when it accurately only indicates the sales price of one unit of the item. This field is returned in OrderReport.

Version 1067

Index of Changed Calls - 1067

Schema Changes - 1067

Announcements - 1067

New Features - 1067

Changed Functionality - 1067

Documentation Changes and Errata - 1067

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

Index of Changed Calls - 1067

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 - 1067

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
OrderType.eBayCollectAndRemitTax Field New
TransactionType.eBayCollectAndRemitTax Field New
TransactionType.eBayCollectAndRemitTaxes Field New
TaxDescriptionCodeType.GST Enum New
TaxTypeCodeType.GST Enum New

Announcements - 1067

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 - 1067

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 - 1067.

New Tax Fields Added to OrderReport to Account for Australian Import Tax

New fields will be returned in OrderReport for orders that are subject to Australian import tax charged to the buyer. Australian import tax charged to the buyer is collected by eBay and remitted to the Australian government.

A Transaction.eBayCollectAndRemitTaxes container will be returned for any order line items subject to the import tax charged to the buyer, and the amount of this tax will be displayed in the TaxDetails.TaxAmount field under this container.

At this time, the Transaction.eBayCollectAndRemitTaxes container is only applicable to the Australia site and to the Australian import tax, but it is possible that this container may become applicable to other eBay sites and tax types in the future.

Changed Functionality - 1067

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 - 1067

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1067 and Changed Functionality - 1067.

None for this release.

Version 1039

Index of Changed Calls - 1039

Schema Changes - 1039

Announcements - 1039

New Features - 1039

Changed Functionality - 1039

Documentation Changes and Errata - 1039

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

Index of Changed Calls - 1039

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 - 1039

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 - 1039

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 - 1039

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 - 1039.

None for this release.

Changed Functionality - 1039

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 - 1039

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1039 and Changed Functionality - 1039.

None for this release.

Minor Edits and Cleanup for Numerous Type Files

A general documentation cleanup was performed for numerous type definitions.

Copyright © 2009–2018 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.