Trading API

Trading API Release Notes

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:

Q2 2018
Version Release Date
1067 2018-Jun-22
1065 2018-Jun-08
1063 Not Released
1061 2018-May-11
1059 Not Released
1057 2018-Apr-13
Q1 2018
Version Release Date
1055 2018-Mar-30
1053 Not Released
1051 Not Released
1049 2018-Feb-16
1047 2018-Feb-02
1045 2018-Jan-19
1043 Not Released
Q4 2017
Version Release Date
1041 Not Released
1039 2017-Oct-27
1037 Not Released
Q3 2017
Version Release Date
1035 2017-Sep-29
1033 2017-Sep-15
1031 2017-Sep-01
1029 2017-Aug-18
1027 2017-Aug-04
1025 2017-Jul-21
1023 Not Released

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.

Version 1067

Index of Changed Calls - 1067

Schema Changes - 1067

Announcements - 1067

New Features - 1067

Changed Functionality - 1067

Documentation Changes and Errata - 1067

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

Index of Changed Calls - 1067

These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1067

Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.

Name Part of Schema Type of Change
OrderType.eBayCollectAndRemitTax Field New
TransactionType.eBayCollectAndRemitTax Field New
TransactionType.eBayCollectAndRemitTaxes Field New
TaxDescriptionCodeType.GST Enum New
TaxTypeCodeType.GST Enum New

Announcements - 1067

Change Requests

See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.

New Features - 1067

This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.

For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1067.

New Tax Fields Added to Order Management Calls to Account for Australian Import Tax

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.

Changed Functionality - 1067

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

None for this release.

Documentation Changes and Errata - 1067

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

None for this release.

Version 1065

Index of Changed Calls - 1065

Schema Changes - 1065

Announcements - 1065

New Features - 1065

Changed Functionality - 1065

Documentation Changes and Errata - 1065

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

Index of Changed Calls - 1065

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

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

Announcements - 1065

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

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.

Changed Functionality - 1065

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.

Four Buyer Requirement Fields Removed from WSDL

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.

Documentation Changes and Errata - 1065

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.

Version 1061

Index of Changed Calls - 1061

Schema Changes - 1061

Announcements - 1061

New Features - 1061

Changed Functionality - 1061

Documentation Changes and Errata - 1061

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

Index of Changed Calls - 1061

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

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

Announcements - 1061

None for this release.

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

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.

International returns

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

Changed Functionality - 1061

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.

Deprecated functionality

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:

Simplified returns

Simplified returns changes the following functionality in this release:

FAQ

Documentation Changes and Errata - 1061

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.

Version 1057

Index of Changed Calls - 1057

Schema Changes - 1057

Announcements - 1057

New Features - 1057

Changed Functionality - 1057

Documentation Changes and Errata - 1057

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

Index of Changed Calls - 1057

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

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

Announcements - 1057

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

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.

Added Ability to Reference an ePID at Variation Level

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.

GetCategoryFeatures Call Updated with the ProductRequiredEnabled Feature

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>

GetCategorySpecifics Updated to Return Two New Fields for PBSE Categories/Brands

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.

Changed Functionality - 1057

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

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.

Version 1055

Index of Changed Calls - 1055

Schema Changes - 1055

Announcements - 1055

New Features - 1055

Changed Functionality - 1055

Documentation Changes and Errata - 1055

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

Index of Changed Calls - 1055

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

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

Announcements - 1055

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

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.

New Create/Revise/Manage Catalog Change Request URLs Returned in GeteBayDetails

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.

Changed Functionality - 1055

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

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.

Version 1049

Index of Changed Calls - 1049

Schema Changes - 1049

Announcements - 1049

New Features - 1049

Changed Functionality - 1049

Documentation Changes and Errata - 1049

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

Index of Changed Calls - 1049

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

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

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 Product-Based Shopping Experience Playbook

The Product-Based Shopping Experience Playbook has been updated, has been moved to the Selling Integration Guide.

ProductRequired Field in GetCategorySpecifics Wired On in Production

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.

2018 Spring Seller Update Now Available

The 2018 Spring Seller Update has been published. Please see this document for information on the following enhancements/changes:

New Features - 1049

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.

Changed Functionality - 1049

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.

'Click and Collect' Eligibility at Listing Level

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.

Documentation Changes and Errata - 1049

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.

'Click and Collect' Documentation Updated

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.

Version 1047

Index of Changed Calls - 1047

Schema Changes - 1047

Announcements - 1047

New Features - 1047

Changed Functionality - 1047

Documentation Changes and Errata - 1047

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

Index of Changed Calls - 1047

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

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

Announcements - 1047

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

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.

New ProductRequired Field Returned in GetCategorySpecifics

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.

Changed Functionality - 1047

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 in Behavior of the ProductListingDetails.IncludeeBayProductDetails Boolean

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.

Documentation Changes and Errata - 1047

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.

Note Added to PlaceOffer Documentation About Immediate Payment Limitation

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.

Version 1045

Index of Changed Calls - 1045

Schema Changes - 1045

Announcements - 1045

New Features - 1045

Changed Functionality - 1045

Documentation Changes and Errata - 1045

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

Index of Changed Calls - 1045

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

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

Announcements - 1045

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.

Product-Based Commerce Playbook Available

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.

New Features - 1045

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.

Changed Functionality - 1045

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.

PrivateListing Field in ItemType Deprecated

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.

Documentation Changes and Errata - 1045

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.

ProductListingDetails.NameValueList Container Removed from Docs

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.

Recommendations.ProductIdentifiers Container Removed from Docs

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.

Version 1039

Index of Changed Calls - 1039

Schema Changes - 1039

Announcements - 1039

New Features - 1039

Changed Functionality - 1039

Documentation Changes and Errata - 1039

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

Index of Changed Calls - 1039

These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1039

Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.

Name Part of Schema Type of Change
ItemType.IsSecureDescription Element New

Announcements - 1039

None for this release.

Change Requests

See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.

New Features - 1039

This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.

For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1039.

IsSecureDescription Boolean Field Added

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.

Changed Functionality - 1039

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

Change to Shipping Rate Table Functionality

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.

Change to Restocking Fee Functionality

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.

GetCategorySpecifics Call Returns More Item Specifics

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.

Documentation Changes and Errata - 1039

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

Minor Edits and Cleanup for Numerous Trading Type Files

A general documentation cleanup was performed for numerous Trading type definitions.

Version 1035

Index of Changed Calls - 1035

Schema Changes - 1035

Announcements - 1035

New Features - 1035

Changed Functionality - 1035

Documentation Changes and Errata - 1035

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

Index of Changed Calls - 1035

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

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

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.

eBay Guaranteed Delivery Now Available on US Site

The eBay Guaranteed Delivery feature has rolled out to the US site. Eligible sellers must opt in to this program. This feature will allow buyers to select items that are guaranteed to be delivered in 1 day, 2 days, 3 days, or 4 days. For general information about this feature, see the Fall 2017 Seller Update. For sellers looking for more technical information on how to integrate with and enabled eBay Guaranteed Delivery through eBay APIs, see the API Integration Playbook for eBay Guaranteed Delivery document.

New Features - 1035

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

None for this release.

Changed Functionality - 1035

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 Amount of Shipping Rate Tables Increased to 40

With the rollout of eBay Guaranteed Delivery, the maximun number of combined domestic and international shipping rate tables has increased from 20 to 40. Shipping rate tables are required for sellers using the Door-to-Door Option of eBay Guaranteed Delivery, and these tables are used to define shipping cost and delivery times for specific regions and for the different shipping speed categories (Overnight, Expedited, Standard, Economy).

Documentation Changes and Errata - 1035

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

PrivateNotes Field was Erroneously Appearing in GetOrders Call Reference

Although it is not returned in GetOrders, the PrivateNotes field was erroneously appearing in the GetOrders Call Reference documentation. It has been removed in the 1035 Version of the document.

PaymentProfileID Field was Missing from GetMyeBaySelling Call Reference

Although it is returned in GetMyeBaySelling, the PaymentProfileID field was erroneously missing from the GetMyeBaySelling Call Reference documentation. It has been added in the 1035 Version of the document.

General Cleanup of Numerous Trading Complex and Enumeration Type Docs

A general documentation cleanup was performed for several calls and type docs.

Version 1033

Index of Changed Calls - 1033

Schema Changes - 1033

Announcements - 1033

New Features - 1033

Changed Functionality - 1033

Documentation Changes and Errata - 1033

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

Index of Changed Calls - 1033

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

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

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.

eBay Guaranteed Delivery Set to Roll Out

The eBay Guaranteed Delivery feature is set to roll out in October 2017. Eligible sellers must opt in to this program. This feature will allow buyers to select items that are guaranteed to be delivered in 1 day, 2 days, 3 days, or 4 days. For general information about this feature, see the Fall 2017 Seller Update. For sellers looking for more technical information on how to integrate with and enabled eBay Guaranteed Delivery through eBay APIs, see the API Integration Playbook for eBay Guaranteed Delivery document.

New Features - 1033

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

None for this release.

Changed Functionality - 1033

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

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

None for this release.

Version 1031

Index of Changed Calls - 1031

Schema Changes - 1031

Announcements - 1031

New Features - 1031

Changed Functionality - 1031

Documentation Changes and Errata - 1031

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

Index of Changed Calls - 1031

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

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

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.

2017 Fall Seller Update Released

See the 2017 Fall Seller Update for information about upcoming selling changes, including the eBay Guaranteed Delivery feature, integration of Markdown Manager into Seller Hub, new Q&A feature on product pages, information on eBay policy updates, and updates to Returns.

New Features - 1031

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

None for this release.

Changed Functionality - 1031

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.

InsuranceDetailsType Removed from WSDL

With Trading WSDL Version 1031, the InsuranceDetailsType has been removed. This type was used by the InsuranceDetails and InternationalInsuranceDetails containers in Add/Revise/Relist/Verify calls for sellers to offer shipping insurance to buyers on any eBay site. This feature is no longer applicable/supported on any eBay sites.

Documentation Changes and Errata - 1031

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

SellerProfiles Container Added to Numerous 'Get' Calls

Although the SellerProfiles container has always been returned by 'Get' calls like GetItem since Business Policies have been supported by the Trading API, this container was missing in the Call Reference pages for the 'Get' calls. This container now appears in the Call Reference pages for the following calls:

Improved ShippingTimeMax and ShippingTimeMin Descriptions

In the ShippingTimeMax and ShippingTimeMin fields of ShippingServiceDetails, ShippingServiceOptionsType, and MultiLegShipmentType, it was clarified that the shipping times are based on business days only. For ShippingServiceDetails (returned in the GeteBayDetails call), it was also stated that the seller should look at the ShippingTimeMax value for a shipping service when setting up a listing for eBay Guaranteed Delivery. With eBay Guaranteed Delivery, becoming available in October 2017, the seller's handling time and the shipping time must be four days or less.

Version 1029

Index of Changed Calls - 1029

Schema Changes - 1029

Announcements - 1029

New Features - 1029

Changed Functionality - 1029

Documentation Changes and Errata - 1029

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

Index of Changed Calls - 1029

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

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

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.

End of Life for Half.com Site

Starting on September 1, 2017, sellers will no longer be able to list and buyers will no longer be able to buy on Half.com. Beginnning on this date, Half.com will redirect to eBay.com. Returns and refunds for Half.com listings will continue to be processed until October 31, 2017. Half.com users will still have access to their My Account Page until November 30, 2017. For more information on this change, please see the Half.com Closing FAQ page.

New Features - 1029

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

None for this release.

Changed Functionality - 1029

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.

Gift Services and the Gift Icon No Longer Supported

Gift Services and the Gift Icon (in listings) are no longer supported on any eBay Marketplace sites. This means that the Item.GiftServices and Item.GiftIcon fields should no longer be used in Add/Revise/Relist/Verify calls.

Some Listing Enhancements No Longer Supported

The following listing enhancements are no longer supported on any eBay Marketplace sites. This means that the enumeration values associated with this listing enhancements should no longer be passed in through the Item.ListingEnhancement field. Here are the deprecated listing enhancements along with their associated enumeration values:

Documentation Changes and Errata - 1029

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

None for this release.

Version 1027

Index of Changed Calls - 1027

Schema Changes - 1027

Announcements - 1027

New Features - 1027

Changed Functionality - 1027

Documentation Changes and Errata - 1027

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

Index of Changed Calls - 1027

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

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

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.

API Support for Half.com Listings is Getting Deprecated

Beginning on August 31, 2017, API support for Half.com listings is being fully deprecated. For a full list of API calls, types, fields, and enumeration values affected by this change, see the Documentation Changes and Errata section.

New Features - 1027

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

Best Offer Feature Enabled for Auction Listings

Beginning with Version 1027, sellers on the US, UK, and DE sites can offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.

Changed Functionality - 1027

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

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

API Calls, Types, Fields, and Enumeration Values Affected by Half.com Deprecation

Beginning on August 31, 2017, API support for Half.com listings is being fully deprecated. This section will discuss the full list of API calls, types, fields, and enumeration values affected by this change.

The following Trading API calls are exclusively for Half.com listings, and these calls will no longer function beyond August 31:

The following Trading API types are exclusively for Half.com listings, and these types will no longer be applicable beyond August 31:

The following Trading API fields and enumeration values are exclusively for Half.com listings, and these fields/values will no longer be applicable beyond August 31:

Version 1025

Index of Changed Calls - 1025

Schema Changes - 1025

Announcements - 1025

New Features - 1025

Changed Functionality - 1025

Documentation Changes and Errata - 1025

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

Index of Changed Calls - 1025

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

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
MembershipDetailsType Type New
MembershipDetailType Type New
UserType.Membership Element New

Announcements - 1025

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.

Best Offer Feature Enabled for Auction Listings

Beginning with Version 1027, sellers on the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. Once this new capability rolls out, the seller can offer Buy It Now or Best Offer in an auction listing, but not both.

New Features - 1025

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

Membership Details to be Returned in GetUser Call

If a seller is enrolled in one or more membership programs, such as eBay Plus, a Membership container will be returned in the GetUser call. This Membership container will provide details about the seller's membership, including the applicable eBay site and the membership expiration date.

Changed Functionality - 1025

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

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

Best Offer Documentation Updated

All applicable Best Offer calls, fields, and feature guide documentation was updated to reflect the fact that Best Offers will soon be available for auction listings on the US, UK, and DE sites.

Copyright © 2005–2017 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.