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 - 1225
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 |
|---|---|---|
ServiceCostType |
Type | New |
AuthenticityVerification.ServiceCost |
Field | New |
TaxTypeCodeType.ImportVAT |
Enum | New |
TaxTypeCodeType.VAT |
Enum | 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 - 1225.
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.
When VAT is applicable to an order, a buyer's VAT Identifier Number (VATIN) will be returned at the order level, and eBay's VAT tax ID will be returned at the line item level for all OrderReport. With Version 1225, France VAT IDs will start being returned.
A new value, VAT_ID, will be returned as the name attribute in the Transaction.eBayCollectAndRemitTaxes.eBayReference field, and this value will indicate that the VAT ID is for eBay France. The Order.BuyerTaxIdentifier.ID field will show the VATIN for the buyer.
|
Note: The eBay and buyer VAT IDs for France are scheduled to start getting returned on September 30, 2021. Going forward after September 30, developers will need to use a Trading WSDL with a version number of 1225 (or newer) for the VAT ID/VATIN values to be returned in the new fields. Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using an older version than 1225, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1225 or higher. On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level. |
Two new enumeration values were added to TaxTypeCodeType. The values in this type are returned in the TaxDetails.Imposition field in OrderReport. Below are the two new values:
A new ServiceCost container will get returned for items going through the Authenticity Guarantee process. The cost shown in this container is the service cost charged to the buyer for an item that will go through the Authenticity Guarantee process.
Authenticity Guarantee service is only applicable to luxury watches, handbags, and sneakers categories.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1225 and Changed Functionality - 1225.
None for this release.
Documentation Changes and Errata - 1221
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.
None for 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 - 1221.
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.
Condition ID 2500 ('Seller Refurbished') can no longer be used in the Cell Phones & Smartphones category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. In lieu of the 'Seller Refurbished' item condition in category 9355, sellers will have to get pre-qualified for and start using one of the following refurbished item conditions: condition ID 2010 ('Excellent - Refurbished'), condition ID 2020 ('Very Good - Refurbished'), and condition ID 2030 ('Good - Refurbished'). Any seller who is not eligible to use these new refurbished item conditions in category 9355 will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Any active listings in category 9355 that had condition ID 2500 ('Seller Refurbished') as the item condition should have been administratively ended by eBay. Sellers will have to relist these items, and unless they are eligible to list with the new refurbished item conditions, they will need to use another item condition supported in category 9355, such as condition ID 3000 ('Used').
The text of the following existing error code was updated. The long version of message is used below.
12320: The deposit amount must be replaceable_value or less.Below is the list of the new error messages that rolled out with the 1221 release. All of these messages are related to using refurbished item conditions. The long version of each message is used below.
21920311: Seller is not eligible to use Refurbished Item Condition in this Category.21920312: Seller is not eligible to use Refurbished Item Condition for the selected Brand.21920313: When listing an item with Refurbished condition, replaceable_value cannot be used in the Title.21920314: When listing an item with Refurbished condition, replaceable_value cannot be used in the Subtitle.21920315: When listing an item with Refurbished condition, at least replaceable_value image(s) must be provided.21920316: When listing an item with Refurbished condition, maximum handling time must be replaceable_value business day(s).21920317: When listing an item with Refurbished condition, free shipping must be provided.21920318: When listing an item with Refurbished condition, returns must be accepted.21920319: When listing an item with Refurbished condition, refund must be provided as Money Back.21920320: When listing an item with Refurbished condition, the minimum time you'll accept returns must be replaceable_value days.21920321: When listing an item with Refurbished condition, seller must pay the cost for return shipping.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 - 1221 and Changed Functionality - 1221.
Updated the Item.ReservePrice field description (used by Add/Revise/Relist calls) to make it more clear about the fee structure and policy used for the reserve price feature.
Made numerous updates to Add/Revise/Relist/Verify call samples in the reference docs. Two high-level updates included adding the required item specifics for the specified category, and also removing PayPal and payment-related fields that are no longer needed for sellers onboarded for managed payments.
Documentation Changes and Errata - 1217
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.
None for 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 - 1217.
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.
Below is the list of new error messages that rolled out with the 1217 release:
21920308: Unable to create Business Policies for this listing. The call to underlying service did not succeed.21920310: Lot Size is not applicable for Multi-SKU listings.Below is an existing error message whose text was revised with the 1217 release:
21920306: Seller is not eligible to use replaceable_value condition either for this site or for the category selectedThese 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 - 1217 and Changed Functionality - 1217.
None for this release.
A note was added to the ShipmentTrackingDetails.ShipmentTrackingNumber field description informing users that the Trading API only supports alphanumeric characters in shipment tracking numbers.
Updated the notes in numerous payment method-related fields to make it clear that offline payment methods will need to be provided by managed payments sellers for listings that require or support offline payment methods. An example of this would be a motor vehicle listing. Generally, the full payment of a motor vehicle happens offline between the buyer and seller, so the seller has to provide the available offline payment methods such as Money Order, Cashier's Check, Loan Check, etc.
Sellers have not been allowed to use Integrated Merchant Credit Card (aka iMCC) payment gateway accounts to handle buyer payments since May 2019. Many iMCC fields had notes explaining that these payment gateway accounts were no longer supported, but these notes have been removed and these fields have been marked as no longer applicable.
Some Charity-related field descriptions said that PayPal had to be used to purchase items in charitable listings, but this is not correct. Any form of electronic payment available to the buyer can be used to purchase these items, and the charitable donation will still go through.
Documentation Changes and Errata - 1209
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
eBayTaxReferenceValue |
Type | New |
TaxesType.eBayReference |
Field | New |
ValueTypeCodeType.VATIN |
Enum | 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 - 1209.
When VAT is applicable to an order, a buyer's VAT Identifier Number (VATIN) will be returned at the order level, and eBay's VAT tax ID will be returned at the line item level for all order management calls. This VAT information will be returned in the following locations:
IOSS, OSS, or ABN. The eBayTaxReferenceValue type was added to support this new field and associated attribute.VATIN value, which was added to the existing ValueTypeCodeType.|
Note: The eBay VAT ID and buyer VATIN fields will not start getting returned until June 30, 2021. Going forward after June 30, developers will need to use a Trading WSDL with a version number of 1211 (or newer) for the VAT ID/VATIN values to be returned in the new fields. Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using an older version than 1211, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or higher. On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level. |
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.
Sellers no longer have the option of choosing to have applicable Listing Recommendations returned in the responses of Add/Revise/Relist/Verify calls. The IncludeRecommendations boolean field has been removed from ItemType, and all ListingRecommendations containers have been removed from the response types of the Add/Revise/Relist/Verify calls.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1209 and Changed Functionality - 1209.
None for this release.
Documentation Changes and Errata - 1207
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 |
|---|---|---|
OrderArray.Errors |
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 - 1207.
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 float value input for the VATDetails.VATPercent field in an Add/Revise/Relist call can only have one digit beyond the decimal point (e.g. 12.3). Previously, three digits after the decimal point were allowed.
The maximum VAT percentage allowed has also been reduced from 30 percent to 27 percent. To account for this change, the existing 21916387 Error Code has been revised to say: The VAT rate needs to be between 0% and 27% with at most one decimal digit. (instead of 0% and 30%).
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1207 and Changed Functionality - 1207.
Although an Errors container has always been returned for OrderReport if errors and/or warnings are triggered at the order level (as opposed to call level), this container was previously missing from the merchantdataservice.xsd file and OrderReport reference docs. It was added in the 1207 version.
Documentation Changes and Errata - 1203
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
VideoDetailsType |
Type | New |
Item.VideoDetails |
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 - 1203.
eBay has added the capability to add videos to listings. At this time, only one video can be added per listing, and the video must be uploaded to eBay via the Media API.
The VideoDetails container has been added to all Add/Revise/Relist/Verify calls, and passing in the ID for the video will add the video to the listing. eBay will perform a validation check on each specified VideoID value to verify that the video belongs to, and was uploaded by the seller.
At present, videos can be attached to listings on the eBay US marketplace and can be viewed through the native apps (iOS and Android) only. Additional sites and platforms will be supported in the near future.
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 - 1203 and Changed Functionality - 1203.
None for this release.
Documentation Changes and Errata - 1201
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.
None for 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 - 1201.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The following new error messages that rolled out with the 1201 release:
21920297: Store Fixed Price format is no longer supported. The listing format has changed from Store Fixed Price to Basic Fixed Price.This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1201 and Changed Functionality - 1201.
Althougth the max length constraint value has always existed for the VariationTitle field, it was not documented until now. The maximum character length for this field is 120 characters. This field is returned in the OrderReport response for multiple-variation listings.
Documentation Changes and Errata - 1197
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.
None for this release.
None for 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 - 1197.
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.
Below is the list of the new error messages that rolled out with the 1197 release:
21920269: Ignored duplicate Video Id(s).21920271: A listing can have maximum replaceable_value video(s).21920275: replaceable_value cannot be revised if the item has a bid or a best offer or is ending within 12 hours.21920276: replaceable_value cannot be revised if the item has a bid or a best Offer and is ending within 12 hours.21920298: VideoID(s) must contain only alphanumeric characters of length replaceable_value.21920299: VideoID(s) are not owned by the seller account.21920300: No Offline Payments selected for the site you are listing on or for the category selected.21920301: Offline payment must be selected for items that are priced at or higher than replaceable_value.21920304: You cannot publish this listing since your charity information is still being verified. This may take around 2-3 business days.21920305: Seller is not eligible to use Certified Refurbished condition either for this site or for the category selected.21920306: Certified Refurbished condition has been dropped from the item.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 - 1197 and Changed Functionality - 1197.
None for this release.
Documentation Changes and Errata - 1193
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
FulfillmentType |
Type | New |
Program.Fulfillment |
Field | New |
ShippingServiceCostOverride.ShippingSurcharge |
Field | Removed |
The SoldReport call has been decommissioned. eBay recommends that large sellers and developers migrate to the Sell Feed API order_task methods, or OrderReport of LMS.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1193.
A new Fulfillment container will be returned in OrderReport for paid orders being fulfilled by eBay or an eBay fulfillment partner.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
In all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Condition ID 2500, 'Seller Refurbished' is the other option for sellers.
Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center.
The capability for sellers to create and maintain multiple domestic and international shipping rate tables has rolled out to the UK and Germany marketplaces. Prior to this, these sellers only had one 'default' domestic shipping rate table and one 'default' international shipping rate table.
In Add/Revise/Relist calls, a seller specifies the domestic and/or international shipping rate table to use for the listing through the ShippingDetails.RateTableDetails container.
Multiple shipping rate tables are now supported in the following marketplaces: US, Australia, Canada (English and French), Italy, UK, and Germany.
The ShippingServiceCostOverride.ShippingSurcharge has been removed from WSDL. This field was already not usable and was marked as deprecated. Sellers can only apply shipping surcharges to shipping service options through the Shipping rate tables tool in My eBay.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1193 and Changed Functionality - 1193.
None for this release.
Documentation Changes and Errata - 1189
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
None for this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1189.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The following warning message was added:
21920296: PayPal email address, PayPal payment method and Item.PaymentDetails container have been removed from this Classified listing.
The existing 21916605 error message was updated to: Only single item quantity is permitted when the listing is in auction-style or under selected categories in FixedPrice format. Before the update, this error message text was not covering the fixed-price use case.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1189 and Changed Functionality - 1189.
The ShippingSurcharge field in ShippingServiceCostOverrideType marked as deprecated. Sellers can no longer directly apply shipping surcharges to listings through Add/Revise calls or through shipping business policies. Shipping surcharges can only be applied to shipping service options through the Shipping rate tables tool in My eBay.
Added a note to Item.eBayPlus field description about the field not being supported for Australian sellers. In Australia, eBay will evaluate/determine whether a listing is eligible for eBay Plus, and the seller has no control over setting the feature for a listing.
Documentation Changes and Errata - 1179
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1179.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1179 and Changed Functionality - 1179.
Some minor documentation updates were made to various type files.
Documentation Changes and Errata - 1177
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1177.
New enumeration values were added to AuthenticityVerificationType. Values now account for order line items that fail authentication and are not able to be returned to the seller because of legal constraints, and for order line items that are passed with exception.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Below is the list of updated error messages that rolled out with the 1177 release:
10122: Picture URL cannot contain semicolon.21920282: New Payment Terms of Use will soon be in effect. Please go to replaceable_value to accept the agreement.21920283: You need to accept the new Payment Terms of Use before you can create or revise listings. Please go to replaceable_value to accept the agreement.These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1177 and Changed Functionality - 1177.
None for this release.
Copyright © 2009–2021 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.