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 2019
Version Release Date
1113 2019-Jun-21
1111 Not Released
1109 Not Released
1107 2019-May-10
1105 Not Released
1103 Not Released
Q1 2019
Version Release Date
1101 Not Released
1099 2019-Mar-15
1097 Not Released
1095 2019-Feb-15
1093 Not Released
1091 2019-Jan-18
Q4 2018
Version Release Date
1087 Skipped
1085 2018-Oct-26
1083 Skipped
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

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

Version 1113

Index of Changed Calls - 1113

Schema Changes - 1113

Announcements - 1113

New Features - 1113

Changed Functionality - 1113

Documentation Changes and Errata - 1113

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

Index of Changed Calls - 1113

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

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

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 Format for Order Identifiers Rolled Out

The new format for eBay orders has been implemented. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. This new format will now appear in the order details section of the View Order Details page, in Seller Hub, in reports, and in email correspondence. Both the old format and the new order ID format will be supported in all API calls. See the Changed Functionality section for current details on how order IDs will work with Trading/Merchant Data API calls.

New Features - 1113

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

None for this release.

Changed Functionality - 1113

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.

Using Old or New Order ID Format in API calls.

The new format for eBay orders has been implemented, and this new format will now appear in the order details section of the View Order Details page, in Seller Hub, in reports, and in email correspondence.

Whether the old or new format for Order IDs is returned in OrderID fields in call responses is determined by the WSDL version being used and on the X-EBAY-API-COMPATIBILITY-LEVEL request header value. See below for more details on version control:

Note: The new order ID format will not be enabled to be returned with the SoldReport call. So, developers using SoldReport may want to consider using OrderReport instead.

Regardless of the WSDL version number or the X-EBAY-API-COMPATIBILITY-LEVEL, both old and new order ID formats can be used to identify an order in all call requests. These calls include the following:

eBay will support the old identifier format in legacy APIs until at least Q1 2020, but it is a good idea that developers integrate with the new format as soon as possible just for ease of management of orders, as only the new order ID format will be showing up elsewhere - Order Details, Seller Hub, email correspondence, etc.

If a user is using Version 1113 (or using an older version with the X-EBAY-API-COMPATIBILITY-LEVEL value set to '1113', the new order ID format will be seen in the OrderID field for the following call responses:

For the ExtendedOrderID field (returned in OrderReport), the new order ID format will be returned, regardless of the WSDL version number or compatibility level. The ExtendedOrderID was previously created to distinguish between legacy and REST API-based order identifiers. Now, with the rollout of the new order ID format, the same order identifiers will be used for both legacy and REST-based APIs, although the legacy APIs will support both the old and the new formats until 2020.

Documentation Changes and Errata - 1113

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

Max Length Added for OrderID and ExtendedOrderID Fields

The maximum length has been published for all occurrences of OrderID and ExtendedOrderID fields. The maximum length is 40 characters. Previously, the maximum length value was not stated in the API documentation. This maximum length value applies to both the old and the new order ID format.

Version 1107

Index of Changed Calls - 1107

Schema Changes - 1107

Announcements - 1107

New Features - 1107

Changed Functionality - 1107

Documentation Changes and Errata - 1107

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

Index of Changed Calls - 1107

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

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.OrderLineItemCount Field New

Announcements - 1107

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

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

None for this release.

Changed Functionality - 1107

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.

Format Change Coming to Order IDs

Starting in June 2019, eBay will start changing the format of order identifier values. The new format will be a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.

During the transition period, developers/sellers will use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in all Trading API call response payloads. The compatibility version is expected to be Version 1113. During the transition period and even after, the new and old OrderID formats will still be supported in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.

You can read more about this change in the Spring 2019 Seller Updates.

Change to 'GTC' Automatic Renewal Schedule

Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). You can read more about this change in the Spring 2019 Seller Updates.

Documentation Changes and Errata - 1107

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

Corrected the Occurrence Value of CityName Field

The occurrence value of the CityName field of AddressType was incorrectly stated as 'Always' being returned. This was not correct, and the occurrence value was changed to 'Conditionally' returned instead. Although most addresses include a city name, some do not. For example, Singapore is an island city-state, and the CityName field would not be applicable to any address in Singapore.

Added Note About Buyer's Email Address Being Masked After Two Weeks

For OrderReport, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. The Buyer.Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Version 1099

Index of Changed Calls - 1099

Schema Changes - 1099

Announcements - 1099

New Features - 1099

Changed Functionality - 1099

Documentation Changes and Errata - 1099

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

Index of Changed Calls - 1099

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

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

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.

All Fixed-Priced Listings to Become Good 'Til Cancelled

Beginning on March 18, 2019 on North American (US and Canada) and all Asian eBay sites, and followed shortly after (around April 1) on all European sites, the only supported listing duration for all new fixed-price listings will be Good 'Til Cancelled (GTC). Existing fixed-price listings with non-GTC durations will not be affected until it becomes time for the seller to relist that item, in which case the seller will have to relist it with the GTC listing duration.

As soon as this change rolls out, only the GTC enumeration value will be accepted in the Item.ListingDuration field of an Add/Revise/Relist/Verify listing call. Any other value that is passed into this field will be ignored, and the listing duration will be set to GTC automatically. The metadata in the GetCategoryFeatures call response will be updated to reflect this change. When using GetCategoryFeatures to retrieve supported listing durations for different listing types and categories for a particular eBay site, the seller includes the FeatureID field in the response and sets its value to ListingDurations.

IMCC Payments Will No Longer Be Accepted

Beginning May 1, 2019, eBay will no longer support electronic payments through a seller's Integrated Merchant Credit Card account. To accept online credit card payments from buyers, a seller must either specify PayPal as an accepted payment method, or opt in to the eBay Managed Payments program (currently only available to sellers in US).

Once this change takes affect, if IMCC is passed in as a value in an Item.PaymentMethods field of an Add/Revise/Relist call, this value will be ignored and dropped (and listing will possibly get blocked if IMCC is the only specified payment method). Once a seller is opted in to eBay Managed Payments, no Item.PaymentMethods values will need to be specified as eBay controls the accepted payment methods for each marketplace.

New Features - 1099

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

None for this release.

Changed Functionality - 1099

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.

Maximum Number of Item Specifics Increased

The maximum number of item specifics that may be defined for a listing has increased from 30 to 45. In Add/Revise/Relist calls, item specific name-value pairs are specified through the ItemSpecifics.NameValueList container.

Documentation Changes and Errata - 1099

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

Numerous Doc Improvements

Numerous documentation improvements were made for this release.

Version 1095

Index of Changed Calls - 1095

Schema Changes - 1095

Announcements - 1095

New Features - 1095

Changed Functionality - 1095

Documentation Changes and Errata - 1095

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

Index of Changed Calls - 1095

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

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

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.

All Fixed-Priced Listings to Become Good 'Til Cancelled

Starting in mid-March 2019 on North American (US and Canada) and all Asian eBay sites, and followed shortly after (around April 1) on all European sites, the only supported listing duration for all new fixed-price listings will be Good 'Til Cancelled (GTC). Existing fixed-price listings with non-GTC durations will not be affected until it becomes time for the seller to relist that item, in which case the seller will have to relist it with the GTC listing duration.

GTC listings renew automatically every 30 days as long as the listing is showing quantity available (1 or more), an insertion fee may be charged for each 30-day period in which the listing is renewed. With GTC listings, it may also be a good idea to take advantage of the out-of-stock feature. With the out-of-stock feature, your fixed-price listing will retain its purchase and search history, but will display to potential buyers as being 'out of stock' if the quantity reaches 0. Then, the seller will just have to revise their listing with more inventory to make purchases possible again. The out-of-stock feature is set in My eBay Selling Preferences.

As soon as this change rolls out, only the GTC enumeration value will be accepted in the Item.ListingDuration field of an Add/Revise/Relist/Verify listing call. Any other value that is passed into this field will be ignored, and the listing duration will be set to GTC automatically. The metadata in the GetCategoryFeatures call response will be updated to reflect this change. When using GetCategoryFeatures to retrieve supported listing durations for different listing types and categories for a particular eBay site, the seller includes the FeatureID field in the response and sets its value to ListingDurations.

IMCC Payments Will No Longer Be Accepted

Beginning May 1, 2019, eBay will no longer support electronic payments through a seller's Integrated Merchant Credit Card account. To accept online credit card payments from buyers, a seller must either specify PayPal as an accepted payment method, or opt in to the eBay Managed Payments program (currently only available to sellers in US).

Once this change takes affect, if IMCC is passed in as a value in an Item.PaymentMethods field of an Add/Revise/Relist call, this value will be ignored and dropped (and listing will possibly get blocked if IMCC is the only specified payment method). Once a seller is opted in to eBay Managed Payments, no Item.PaymentMethods values will need to be specified as eBay controls the accepted payment methods for each marketplace.

2019 Early Seller Update Now Available

The 2019 Early Seller Update is now available. Seller updates generally affect all or most sellers, but generally aren't specific to sellers and developers using the public APIs. This update covers the following topics:

New Features - 1095

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

None for this release.

Changed Functionality - 1095

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.

Only 'GTC' Supported for Fixed-Priced Listings in Australia

The only supported listing duration for all new fixed-price listings on the eBay Australia site is Good 'Til Cancelled (GTC). Existing fixed-price listings with non-GTC durations will not be affected until it becomes time for the seller to relist that item, in which case the seller will have to relist it with the GTC listing duration.

With this change, only the GTC enumeration value will be accepted in the Item.ListingDuration field of an Add/Revise/Relist/Verify listing call. Any other value that is passed into this field will be ignored, and the listing duration will be set to GTC automatically. The metadata in the GetCategoryFeatures call response has been updated to reflect this change to fixed-price listings.

Documentation Changes and Errata - 1095

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

Added Note About 500 Pixels Requirement for Listing Photos

Added a note in the PictureDetails.PictureURL field about the 500 pixels requirement for all listing photos. With this requirement, all photos being added to a listing must be at least 500 pixels on its longest side. Any photos that do not meet this requirement will not be published to the listing.

Version 1091

Index of Changed Calls - 1091

Schema Changes - 1091

Announcements - 1091

New Features - 1091

Changed Functionality - 1091

Documentation Changes and Errata - 1091

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

Index of Changed Calls - 1091

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

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
Item.MotorsGermanySearchable Field Deprecated
Item.ShippingTermsInDescription Field Deprecated
Seller.MotorsDealer Field Deprecated
SellerContactDetails.Phone2CountryCode Field Deprecated
SellerContactDetails.Phone2CountryPrefix Field Deprecated
SellerContactDetails.Phone2AreaOrCityCode Field Deprecated
SellerContactDetails.Phone2LocalNumber Field Deprecated

Announcements - 1091

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

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

Best Offer Feature Enabled for Auction Listings on More Sites

Previously, beginning with Version 1027, sellers on the US, UK, and DE sites gained the capability to accept Best Offers on auction listings. This capability is now also available to sellers on Canada sites (English and French), and to the eBay marketplaces in Australia, France, Italy, and Spain.

Sellers using auctions must choose between using the Best Offer or Buy It Now feature, as both features cannot be enabled on the same auction listing. If an auction listing is enabled with Best Offer, this feature will no longer be applicable once the listing receives its first qualifying bid.

Changed Functionality - 1091

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.

Change to Minimum Best Offer Price Threshold in Auction Listings

Sellers accepting Best Offers for an auction listing can now set the Best Offer Auto Reject threshold price (Item.ListingDetails.MinimumBestOfferPrice) to a dollar value higher than the auction starting price (Item.StartPrice).

Best Offers in auction listings are available to sellers on the US, Canada, UK, Germany, Australia, France, Italy, and Spain sites. Note that the Best Offer feature in auction listings is no longer applicable once the listing receives its first qualifying bid.

New Category Mapping Now Done by Default

Previously, sellers using the Add/Revise/Relist calls had to include the CategoryMappingAllowed field and set its value to true. Now, eBay will do category mapping automatically (CategoryMappingAllowed field defaults to true instead of false, so sellers can now just omit the CategoryMappingAllowed field in an Add/Revise/Relist call.

With category mapping, eBay will automatically 'map' or 're-route' and outdated/deprecated Category ID to the updated/correct Category ID. The primary Category ID is specified in Add/Revise/Relist calls in the PrimaryCategory.CategoryID field, and the secondary listing category (if used) is specified in Add/Revise/Relist calls in the SecondaryCategory.CategoryID field. And if eBay does category mapping, the new Category IDs will appear in the response of a successful Add/Revise/Relist call.

Secondary Phone Numbers No Longer Supported in Classified Ad Listings

The following fields under the SellerContactDetails container in an Add/Revise/Relist call have been deprecated since adding a secondary contact number is no longer supported for Classified Ad listings. If any of these fields are included in an Add/Revise/Relist call, they will be ignored:

Two eBay Motors-related Fields Deprecated

The following two eBay Motors-related fields were deprecated. Previously, both of these boolean fields were set through an Add/Revise/Relist call.

ShippingTermsInDescription Field Deprecated

The Item.ShippingTermsInDescription field used in Add/Revise/Relist calls is deprecated. If this field is included in an Add/Revise/Relist call, it will be ignored.

Documentation Changes and Errata - 1091

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

None for this release.

Back to top

Version 1085

Index of Changed Calls - 1085

Schema Changes - 1085

Announcements - 1085

New Features - 1085

Changed Functionality - 1085

Documentation Changes and Errata - 1085

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

Index of Changed Calls - 1085

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

None for this release.

Announcements - 1085

Change Requests

See the Site Status Updates for bug fixes related to this release.

Payment Changes for Sellers in eBay Managed Payments Program

For sellers enrolled in the new eBay Managed Payments program, a specified payment method is not necessary. If a payment method is specified in the API call itself, or through an associated Payment Business Policy, it will be dropped from the listing and the seller will get a warning message when the call is run.

Sellers in the new eBay Managed Payments program can also enable the immediate payment feature by including the Item.AutoPay field in an Add/Revise/Relist call and setting its value to true.

New Features - 1085

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

None for this release.

Changed Functionality - 1085

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

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

Doc Updates to 'eBay Collect and Remit Tax' Fields

Provided a little more detail to the 'eBay Collect and Remit Tax' field descriptions in OrderReport, and added links to the Australian 'Good and Service Tax' and US Sales Tax Collection help topics. Currently, there are eight US states that will start collecting sales tax from buyers (through eBay) in 2019, starting with Minnesota and Washington as of January 1, 2019. See the eBay sales tax collection help topic for more information.

Doc Updates to SalesTax Container

Provided a note in the SalesTax container fields (in listing calls) about sales tax settings being ignored by eBay if an item is sold to a buyer in a US state that is applicable to the 'eBay Collect and Remit Tax' feature. Currently, there are eight US states that will start collecting sales tax from buyers (through eBay) in 2019, starting with Minnesota and Washington as of January 1, 2019. See the eBay sales tax collection help topic for more information.

Using EAN and UPC Values in Listing Calls

Highlighted the fact that a seller selling a product with a UPC value on a European eBay site should pass this UPC value into the ProductListingDetails.EAN or VariationProductListingDetails.EAN field, and a seller selling a product with an EAN value on the US eBay site should pass this EAN value into the ProductListingDetails.EAN or VariationProductListingDetails.EAN field.

Clarified How Package Weight is Specified in ShippingPackageDetails

Updated field description to tell users to use whole numbers (and not decimals) in the WeightMajor and WeightMinor fields to specify shipping package weight. Also provided samples in these two fields to show how different weight should be specified. So, if a package weighed 2 pounds, and 4.7 ounces, the ounces should be rounded up to '5', so it would be expressed as follows:

<WeightMajor>2</WeightMajor>
<WeightMinor>5</WeightMinor>

Made it More Clear How OrderStatus Values are Used

Cleaned up the enumerated type documentation in OrderStatusCodeType to indicate which enumeration values are only applicable to the response of OrderReport.

Enhanced ExtendedOrderID Field Description in OrderReport

Provided an example of an actual ExtendedOrderID value and added note that these values are used in the Post-Order and Fulfillment APIs to retrieve orders.

Shipment Tracking Information Removed from OrderReport Documentation

Fields providing shipment tracking or shipping status information were removed from OrderReport documentation, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. Below are the fields affected:

  • ShippingDetails.ShipmentTrackingDetails (whole container)
  • ShippingPackageInfo.ActualDeliveryTime (individual field)
  • ShippingPackageInfo.ScheduledDeliveryTimeMax (individual field)
  • ShippingPackageInfo.ScheduledDeliveryTimeMin (individual field)

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:

  • Updates to secure HTTPS content
  • Updates on listing fees
  • The latest on Product-Based Shopping Experience
  • What's new in shipping

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.

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