Trading API
The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues.
If you are getting started with the API, the following locations have information about joining the eBay Developers Program, creating test users, and other steps to getting your application certified to go live against the eBay production servers:
|
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
The lowest supported version is 941.
To learn how versioning works in the Trading API, see eBay's Schema Versioning Strategy.
Documentation Changes and Errata - 1077
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 |
|---|---|---|
| Return Policy Updates | ||
Category.DomesticReturnsAcceptedValues |
Field | New |
Category.DomesticReturnsDurationValues |
Field | New |
Category.DomesticReturnsShipmentPayeeValues |
Field | New |
Category.DomesticRefundMethodValues |
Field | New |
Category.InternationalReturnsAcceptedValues |
Field | New |
Category.InternationalReturnsDurationValues |
Field | New |
Category.InternationalReturnsShipmentPayeeValues |
Field | New |
Category.InternationalRefundMethodValues |
Field | New |
Category.ReturnPolicyDescriptionEnabled |
Field | New |
FeatureDefinitions.DomesticReturnsAcceptedValues |
Field | New |
FeatureDefinitions.DomesticReturnsDurationValues |
Field | New |
FeatureDefinitions.DomesticReturnsShipmentPayeeValues |
Field | New |
FeatureDefinitions.DomesticRefundMethodValues |
Field | New |
FeatureDefinitions.InternationalReturnsAcceptedValues |
Field | New |
FeatureDefinitions.InternationalReturnsDurationValues |
Field | New |
FeatureDefinitions.InternationalReturnsShipmentPayeeValues |
Field | New |
FeatureDefinitions.InternationalRefundMethodValues |
Field | New |
FeatureDefinitions.ReturnPolicyDescriptionEnabled |
Field | New |
SiteDefaults.DomesticReturnsAcceptedValues |
Field | New |
SiteDefaults.DomesticReturnsDurationValues |
Field | New |
SiteDefaults.DomesticReturnsShipmentPayeeValues |
Field | New |
SiteDefaults.DomesticRefundMethodValues |
Field | New |
SiteDefaults.InternationalReturnsAcceptedValues |
Field | New |
SiteDefaults.InternationalReturnsDurationValues |
Field | New |
SiteDefaults.InternationalReturnsShipmentPayeeValues |
Field | New |
SiteDefaults.InternationalRefundMethodValues |
Field | New |
SiteDefaults.ReturnPolicyDescriptionEnabled |
Field | New |
CategoryFeatureType |
Type | Updated |
FeatureIDCodeType |
Type | Updated |
SiteDefaultsTypeSiteDefaultsType |
Type | Updated |
ReturnsDurationCodeType |
Type | New |
ReturnsRefundMethodCodeType |
Type | New |
DomesticReturnsShipmentPayeeCodeType |
Type | New |
ReturnsAcceptedCodeType |
Type | New |
ReturnsShipmentPayeeCodeType |
Type | New |
DomesticRefundMethodCodeType |
Type | New |
InternationalRefundMethodCodeType |
Type | New |
DomesticReturnsAcceptedCodeType |
Type | New |
DomesticReturnsDurationCodeType |
Type | New |
InternationalReturnsShipmentPayeeCodeType |
Type | New |
InternationalReturnsDurationCodeType |
Type | New |
InternationalReturnsAcceptedCodeType |
Type | New |
ReturnPolicyDescriptionEnabledDefinitionType |
Type | New |
InternationalReturnsShipmentPayeeDefinitionType |
Type | New |
InternationalReturnsDurationDefinitionType |
Type | New |
InternationalReturnsAcceptedDefinitionType |
Type | New |
InternationalRefundMethodDefinitionType |
Type | New |
DomesticReturnsShipmentPayeeDefinitionType |
Type | New |
DomesticReturnsDurationDefinitionType |
Type | New |
DomesticReturnsAcceptedDefinitionType |
Type | New |
DomesticRefundMethodDefinitionType |
Type | New |
DetailNameCodeType |
Type | New |
FeatureDefinitionsType |
Type | New |
Note on return policies: In GetCategoryFeatures, the response values for the return policies differ from the values returned for the other features in that the SiteDefaults and Category containers list the allowable site and category values, and not the actual "default" values for these settings. With this, the SiteDefaults container lists all the return policy values that are supported at the root node of the specified marketplace and the Category container lists the allowed return policy values if (1) the allowable values for the category differ from the values allowed at the root node of the marketplace (in the case of any category IDs supplied in the request) or (2) if the allowable values for the category differ from those of their parent category. This exception pertains to the following domestic and international return policy flags: ReturnsDurationValues, ReturnsAcceptedValues, ReturnsShipmentPayeeValues, and RefundMethodValues. In addition, the FeatureDefinitions container is not currently populated for the return policy values.
| Name | Part of Schema | Type of Change |
|---|---|---|
| GetAccount Updates | ||
AccountDetailEntryCodeType.PaymentIntermediationFee |
Enum | New |
AccountDetailEntryCodeType.FeePaymentIntermediationRVI |
Enum | New |
AccountDetailEntryCodeType.FeePaymentIntermediationChargeback |
Enum | New |
AccountDetailEntryCodeType.FeePaymentIntermediationChargebackRVI |
Enum | New |
| EndItem Updates | ||
EndReasonCodeType.ProductDeleted |
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.
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.
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.
The following four enumeration values were added to AccountDetailEntryCodeType, and will be returned (when applicable) in the GetAccount call.
PaymentIntermediationFeeFeePaymentIntermediationRVIFeePaymentIntermediationChargebackFeePaymentIntermediationChargebackRVIA 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.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Previously, 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>
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 the RestrictedToBusiness field description to include UK as another country that supports Business-to-Business listings.
Documentation Changes and Errata - 1073
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.
Currently, the GeteBayDetails call is used to retrieve site-level, return policy metadata. Starting in September 2018, the GetCategoryFeatures call 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.
The 2018 Fall Seller Update is now available. Below are just a few updates that are available in the Seller Update:
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.
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.
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 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 use this value in the ReturnPolicy.InternationalReturnsWithinOption or ReturnPolicy.ReturnsWithinOption fields. The Months_1 value is being sunset beginning late August 2018, and after 18 months you will receive a blocking error if you attempt to use this value. Use Days_30 instead.
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)
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.
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 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.
Although the ProductListingDetails.ProductReferenceID field was already being returned in the GetItem call, it was missing in the Call Reference documentation.
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 GetOrders (and other order management calls) and GetMyeBaySelling.
Documentation Changes and Errata - 1067
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 |
|---|---|---|
OrderType.eBayCollectAndRemitTax |
Field | New |
TransactionType.eBayCollectAndRemitTax |
Field | New |
TransactionType.eBayCollectAndRemitTaxes |
Field | New |
TaxDescriptionCodeType.GST |
Enum | New |
TaxTypeCodeType.GST |
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 - 1067.
New fields will be returned in the order management calls (GetOrders, GetSellerTransactions, GetOrderTransactions, and GetItemTransactions) 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.
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 - 1067 and Changed Functionality - 1067.
None for this release.
Documentation Changes and Errata - 1065
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 |
|---|---|---|
MaximumBuyerPolicyViolationsType |
Type | Deprecated |
VerifiedUserRequirementsType |
Type | Deprecated |
BuyerRequirementDetails.LinkedPayPalAccount |
Field | Deprecated |
BuyerRequirementDetails.MaximumBuyerPolicyViolations |
Field | Deprecated |
BuyerRequirementDetails.MinimumFeedbackScore |
Field | Deprecated |
BuyerRequirementDetails.VerifiedUserRequirements |
Field | Deprecated |
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 - 1065.
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 four BuyerRequirementDetailsType fields were removed from the WSDL with Version 1065:
These four fields should no longer be set in Add/Revise/Relist/Verify calls, as they will have no functional effect if they are included.
VerifiedUserRequirementsType and MaximumBuyerPolicyViolationsType were also removed from the WSDL with Version 1065, as these types were only used by two of the fields that are being deprecated.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1065 and Changed Functionality - 1065.
None for this release.
Documentation Changes and Errata - 1061
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 |
|---|---|---|
ReturnPolicy.InternationalReturnsAcceptedOption |
Field | New |
ReturnPolicy.InternationalReturnsWithinOption |
Field | New |
ReturnPolicy.InternationalShippingCostPaidByOption |
Field | New |
ReturnPolicy.InternationalRefundOption |
Field | New |
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 - 1061.
Several International fields were added to the ReturnPolicy container. These fields let sellers specify international return policies that differ from their domestic return policies (international returns are those that are shipped using an international shipping service).
Before this release, the single set of return policy fields represented the seller's return policies for both domestic and international returns. The preexisting return policy fields now define a seller's domestic return policy and the new international fields enable sellers to also define specific international return policies. (If a seller does not define specific international return policies, then any international returns will inherit the seller's domestic return policies).
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.
This release launches a reorganization to eBay's return policies. To streamline the number of return variations, several fields were deprecated and others were added to make return policies simple to create and easy to maintain. For details on this roll out, see the Spring 2018 Seller Announcement, Simplified Returns.
Before this release, the single set of return policy fields represented the seller's return policies for both domestic and international returns. The preexisting return policy fields now define a seller's domestic return policy and the new international fields enable sellers to also define specific international return policies. (If a seller does not define specific international return policies, then any international returns will inherit the seller's domestic return policies).
Starting with this release, sellers can no longer specify warranty information, restocking fees, or hours for extended holiday returns with their return policies. With this, the following ReturnPolicy fields are deprecated with this release; any values supplied to these fields will not be evaluated, stored, or returned:
ReturnPolicy.ExtendedHolidayReturnsReturnPolicy.RestockingFeeValueOptionReturnPolicy.WarrantyDurationOptionReturnPolicy.WarrantyOfferedOptionReturnPolicy.WarrantyTypeOptionSimplified returns changes the following functionality in this release:
MoneyBack and MoneyBackOrReplacement. While the MoneyBackOrExchange will be accepted as input, this value now equals MoneyBackOrReplacement, which is now returned if you supply the obsolete value. For marketplaces other than the US, this field new defaults to MoneyBack.Days_30 and Days_60 values. The Days_3 and Days_7 options have been removed from the AU marketplace and the Days_14 option has been removed from most categories. ReturnPolicyDetails to review which categories allow a Days_14 return period (GetCategoryFeatures will be updated in mid-August 2018 with the proper return period information).Buyer and Seller.FAQ
ReturnsNotAccepted.Months_1 as a value for ReturnsWithinOption; will either Days_30 or Months_1 be accepted?
Months_1 will continue to be accepted for the next 18 months. If this value is specified, it is stored as Days_30. After 18 months, a value of Months_1 will throw a blocking error.This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1061 and Changed Functionality - 1061.
None for this release.
Documentation Changes and Errata - 1057
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 |
|---|---|---|
AspectUsageCodeType |
Type | New |
ProductRequiredEnabledCodeType |
Type | New |
ProductRequiredEnabledDefinitionType |
Type | New |
CategoryFeatureType.ProductRequiredEnabled |
Field | New |
FeatureDefinitionsType.ProductRequiredEnabled |
Field | New |
RecommendationValidationRulesType.AspectUsage |
Field | New |
RecommendationValidationRulesType.MaxValueLength |
Field | New |
SiteDefaultsType.ProductRequiredEnabled |
Field | New |
VariationProductListingDetailsType.ProductReferenceID |
Field | New |
FeatureIDCodeType.ProductRequiredEnabled |
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 - 1057.
A ProductReferenceID field was added to VariationProductListingDetailsType, and this allows the seller to identify each product variation within a multiple-variation listing by an eBay Product ID (ePID). An ePID is a unique identifier of an eBay Catalog product. The seller can use the GetCategoryFeatures or GetCategorySpecifics calls to see if an ePID is supported/required for a category.
Currently, this field can only be used in the Sandbox environment to specify an ePID for an eBay Catalog product that is part of the Product-Based Shopping Experience mandate. For more information about PBSE, see the Product-Based Shopping Experience page.
This change affects the following Trading API calls:
It will be added to 'Get' calls that return the VariationProductListingDetails container at a later date.
The GetCategoryFeatures call was updated to show sellers if a particular eBay category requires that listings be associated with an eBay Catalog product. For Phase 2 of the Product-Based Shopping Experience (PBSE), entire eBay leaf categories will start requiring that listings be associated with an eBay Catalog product. Phase 2 of PBSE is scheduled to launch on the US, UK, Australia, and Canada (English) sites in August 2018. For more information on PBSE, see the Product-Based Shopping Experience landing page.
If you wanted to use GetCategoryFeatures only to check if a category required that all listings be associated with an eBay Catalog product, you could run the following call:
<?xml version="1.0" encoding="utf-8"?>
<GetCategoryFeaturesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>AgAAAA**.../96cN</eBayAuthToken>
</RequesterCredentials>
<ErrorLanguage>en_US</ErrorLanguage>
<WarningLevel>High</WarningLevel>
<CategoryID>9355</CategoryID>
<FeatureID>ProductRequiredEnabled</FeatureID>
<DetailLevel>ReturnAll</DetailLevel>
</GetCategoryFeaturesRequest>The GetCategorySpecifics call was updated to return two new fields - AspectUsage and MaxValueLength. These two new fields will be returned under the ValidationRules containers for Product-Based Shopping Experience mandated categories/brands. The AspectUsage field will indicate if a category aspect is a product-level aspect, or if it is an aspect that is typically unique to a particular instance of a product in that category, and the MaxValueLength field will state the maximum length of the aspect's value. The seller must make sure not to exceed this value when setting instance aspects on a listing in this category.
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 - 1057 and Changed Functionality - 1057.
None for this release.
Documentation Changes and Errata - 1055
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 |
|---|---|---|
URLTypeCodeType.CreateProductUrl |
Enum | New |
URLTypeCodeType.AppealProductUrl |
Enum | New |
URLTypeCodeType.ManageProductUrl |
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 - 1055.
The following three new enumeration types were added to URLTypeCodeType: CreateProductUrl, AppealProductUrl, and CreateProductUrl. These URLs will be returned under the URLDetails container of the GeteBayDetails response if one of the DetailName values in the GeteBayDetails request is URLDetails, or if no DetailName values are specified.
Different base URLs will be returned depending on whether you call GeteBayDetails in Sandbox or Production environment. As of April 2018, these URLs and the create/revise/manage catalog change request flows are only available in the Sandbox environment. These URLs and the create/revise/manage catalog change request flows will become available in the Production environment in August 2018 with the launch of Product-Based Shopping Experience Phase 2. See the URLTypeCodeType definition for more information on these three URLs, and see the Product-Based Shopping Experience landing page for more information on Product-Based Shopping Experience Phase 2.
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 - 1055 and Changed Functionality - 1055.
None for this release.
Documentation Changes and Errata - 1049
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.
The Product-Based Shopping Experience Playbook has been updated, has been moved to the Selling Integration Guide.
The ProductRequired field in the GetCategorySpecifics response will start getting returned in the Production environment for categories/brands that will require an association with an eBay catalog product. This field is only returned for the 'Brand' NameRecommendation container. Previously, this field was only wired on in the Sandbox environment.
If a product brand within an eBay category requires an eBay catalog product, the seller will have to associate the listing with an eBay catalog product when creating/revising a listing. To do this, an eBay Product ID (ePID) is passed into the ProductListingDetails.ProductReferenceID field when using the Add/Revise calls of the Trading API, or an ePID must be passed into the product.epid field when using the createOrReplaceInventoryItem call of the Inventory API.
Through 'Phase 1' of the Product-Based Shopping Experience requirement, scheduled to start being enforced in May 2018, this field will only be returned if Enabled for the product brand. However, with 'Phase 2' of the Product-Based Shopping Experience requirement, scheduled to start being enforced in August 2018, this field will get returned (whether it is Enabled or Disabled) for all product brands if the requirement applies to the eBay category. In 'Phase 2', the seller will have to call GetCategoryFeatures first to see if the requirement applies to the category, and if it does, then the seller will have to call GetCategorySpecifics to see if the requirement applies to the product brand within the category. For more information about Product-Based Shopping Experience requirements, see the Product-Based Shopping Experience Playbook.
The 2018 Spring Seller Update has been published. Please see this document for information on the following enhancements/changes:
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 - 1049.
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.
For sellers who are eligible and opted in to the 'Click and Collect' program, this feature can only be set at the seller's account level, and cannot be set at the listing level. If this option is turned on at the account level, each individual listing must be evaluated for 'Click and Collect' eligibility. This feature is only available to sellers on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
This means that the the EligibleForPickupDropOff field in the PickupInStoreDetails container should no longer be set in an Add/Revise/Relist/Verify listing call, and if this field is included, it will have no functional affect on the listing.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1049 and Changed Functionality - 1049.
For all 'Click and Collect' related fields in the Trading API, a note was added about sellers only being able to enable the Click and Collect feature at the account level, and then each individual listing within a Click and Collect-enabled category must be evaluated for eligibility.
Documentation Changes and Errata - 1047
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 |
|---|---|---|
ProductRequiredCodeType |
Type | New |
RecommendationValidationRulesType.ProductRequired |
Element | 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 - 1047.
A new ProductRequired field will start getting returned in GetCategorySpecifics. This field will only returned for the 'Brand' NameRecommendation container, and only for eBay categories where the Product-Based Commerce mandate applies. Currently, this field is only wired on in the Sandbox environment, but it will be wired on in Production later in March 2018.
If a product brand within an eBay category requires an eBay catalog product, the seller will have to associate the listing with an eBay catalog product when creating/revising a listing. To do this, an eBay Product ID (ePID) is passed into the ProductListingDetails.ProductReferenceID field when using the Add/Revise calls of the Trading API, or an ePID must be passed into the product.epid field when using the createOrReplaceInventoryItem call of the Inventory API.
Through 'Wave 1' of the Product-Based Commerce mandate, scheduled to start being enforced in May 2018, this field will only be returned if Enabled for the product brand. However, with 'Phase 2' of the Product-Based Commerce mandate, scheduled to start being enforced in August 2018, this field will get returned (whether it is Enabled or Disabled) for all product brands if the mandate applies to the eBay category. In 'Phase 2', the seller will have to call GetCategoryFeatures first to see if the mandate applies to the category, and if it does, then the seller will have to call GetCategorySpecifics to see if the mandate applies to the product brand within the category. For more information about Product-Based Shopping Experience requirments, see the Product-Based Shopping Experience Playbook.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
A note was added to the ProductListingDetails.IncludeeBayProductDetails field description that states that this boolean field cannot be set to false if the eBay category and product is part of Product-Based Commerce mandate. If the eBay category and product is part of the mandate and this field is included and set to false, an Add/Revise/Relist/Verify call will fail.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1047 and Changed Functionality - 1047.
A note was added to the PlaceOffer documentation about the call not supporting the purchase of items where the immediate payment option is set on the listing.
Documentation Changes and Errata - 1045
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 |
|---|---|---|
ItemType.PrivateListing |
Element | Removed |
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.
A new Product-Based Shopping Experience Playbook is now available. This playbook discusses the eBay categories and product brands that will start requiring an eBay catalog product when listing/revising a product. It also discusses what developers/sellers need to do to prepare/integrate with this mandate in 2018. In 2018, this mandate will only apply to US, UK, AU, and CA (English) sites, but this mandate will start rolling out to other sites in 2019 and beyond.
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 - 1045.
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 PrivateListing field has been deprecated and removed from the WSDL with Version 1045. It should no longer be used in Add/Revise/Relist/Verify calls. This field will still get returned in 'Get' calls until it is fully wired off around July 2019.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1045 and Changed Functionality - 1045.
The ProductListingDetails.NameValueList container used in Add/Revise/Relist calls has been removed from the Call Reference docs. Although this container was added in Version 997, it was never wired on. This container should not be used.
The Recommendations.ProductIdentifiers container has been removed from the Call Reference docs. Although this container was added in Version 997, it was never wired on and never returned in the GetCategorySpecifics. This container should not be used.
Documentation Changes and Errata - 1039
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 |
|---|---|---|
ItemType.IsSecureDescription |
Element | New |
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 - 1039.
A new boolean field named IsSecureDescription was added to ItemType. This boolean field is returned in GetItem and other 'Get' calls to indicate whether or not the listing description for an eBay listing is HTTPS secure/compliant. To be HTTPS secure/compliant, the listing description field may not contain any links to site pages that use the HTTP (and not HTTPS) protocol.
This field will be returned for the following calls:
If an eBay listing is not HTTPS compliant, the seller may want to revise the listing, removing any and all links to HTTP pages. For more information about why eBay made this change, please see the Policy Updates page of the Fall 2017 Seller Updates page.
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.
Once a seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId fields of the RateTableDetails container in an Add/Revise/Relist call, and the DomesticRateTable and InternationalRateTable tags will no longer work. The unique identifiers for all shipping rate tables defined for a seller's account can be retrieved with the getRateTables method of the Account API.
The seller can also apply domestic and international to a shipping business policy and then apply this business policy to the listing through the SellerProfiles.SellerShippingProfile container. Shipping business policies can be created and managed with the Account API.
Shipping rate tables are currently only available for US, Australia, UK, and Germany sites.
For US and Canada sellers charging a restocking fee for non-SNAD returns, the seller can now use the Percent_20 value in the ReturnPolicy.RestockingFeeValueOption to reserve the right to charge a restocking fee percentage for returned items of up to 20 percent (of sale price), but at the seller's discretion, they can also charge less than 20 percent.
The seller can also set a restocking fee in a return business policy and then apply this business policy to the listing through the SellerProfiles.SellerReturnProfile container. Business policies can be created and managed with the Account API.
The maximum number of Item Specifics returned in the response of the GetCategorySpecifics call has been increased from 15 to 25. The caller can control how many Item Specifics are returned by setting the MaxNames value in the GetCategorySpecifics call request. If the MaxNames field is omitted, its value defaults to 25, and up to 25 Item Specifics are returned for that category.
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.
A general documentation cleanup was performed for numerous Trading type definitions.
Copyright © 2005–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.