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. For older release notes, see the Release Notes Archive.
Release Version | Release Date | Description of Release |
---|---|---|
1331 | 2023-October-23 | New ListingOnHold field added to GetItem; New error codes for 1331; Logic and behavior changes to support on-hold listings; New enum values added to AccountDetailEntryCodeType |
1327 | 2023-September-18 | GetCharities Call Decommissioned |
1325 | 2023-August-29 | All DSA-related fields are available on all eBay marketplaces |
1323 | 2023-August-25 | New Fee and Credit added to GetAccount; Extended Producer Responsibility IDs set at account level; Several enumerated values deprecated in NotificationEventTypeCodeType; Four fields deprecated in GetMyeBaySelling call; TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls; Czechia and Cyprus added to SiteCodeType; UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call; OriginatingPostalCode field deprecated |
1321 | 2023-July-17 | GetMyeBayReminders Call Decommisioned; CODCost field removed |
1319 | 2023-Jun-26 | Added condition grading support for the United Kingdom (GB) |
1315 | 2023-Jun-16 | Deprecated CODCost fields and the enumerated value BuyerPaymentMethodCodeType.COD |
1313 | 2023-Jun-2 | AddTransactionConfirmationItem and GetContextualKeywords Decommissioned; Logic Change for RefundAmount Field in MonetaryDetails; Logic Change for Modified Line Items in GST and GIT |
1311 | 2023-May-19 | Regulatory changes; Numerous fields scheduled for decommission in order management calls; Logic change for Total and AmountPaid fields in GetOrders |
1305 | 2023-Apr-7 | Vault in-hand submission shipping address returned; New status for AuthenticityVerificationType |
1303 | 2023-Mar-24 | Added Support for Linking Separate Orders; SubscriptionLevel field removed from GetStore |
1301 | 2023-Mar-10 | Buyers in the EU must be allowed to return an item within 14 days or more; GetApiAccessRules Call Decommisioned |
1299 | 2023-Feb-24 | New Schema Added to Support VeRO Violation Reporting |
1295 | 2023-Jan-27 | Six Dispute Calls Decommissioned; GetOrderTransactions Call Deprecated |
1291 | 2022-Dec-30 | New Schema Added to Support Hazardous Material Label Related Information and Repair Score; New Error Codes for 1291 |
Version 1331
Changed Calls - 1331 | Schema Changes - 1331 | Announcements - 1331 | ||
New Features - 1331 | Changed Functionality - 1331 | Document Changes and Errata - 1331 |
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1331
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 - 1331
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 |
---|---|---|
SellingStatusType
|
Type | Modified |
Item.SellingStatus.ListingOnHold
|
Field | Added |
AccountDetailEntryCodeType
|
Type | Modified |
AccountDetailEntryCodeType.HermesReturnLblSellerPaidShpFee
|
Enum | Added |
AccountDetailEntryCodeType.HermesReturnLblSellerPaidShpFeeCr
|
Enum | Added |
AccountDetailEntryCodeType.DHLReturnLblShippingFee
|
Enum | Added |
AccountDetailEntryCodeType.DHLReturnLblShippingFeeCredit
|
Enum | Added |
Announcements - 1331
By January 22nd, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable ConditionDescriptors name-value pairs.
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1331
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 - 1331.
New ListingOnHold field added to GetItem
The ListingOnHold field has been added to SellingStatusType and will be returned in GetItem as applicable. See SellingStatusType for details on this new field.
Changed Functionality - 1331
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.
New error codes for 1331
Below is a list of the new error messages that rolled out with the 1331 release. All of these messages are related to on-hold listings. The long version of each message is used below:
-
(warning) 21920396: This listing has a policy violation.
-
(error) 21920397: This listing has been removed for a policy violation.
-
(error) 21920398: This listing has a policy violation.
replaceable_value
is not possible.
These error and warning messages can be viewed in the Errors by Number page.
Logic and behavior changes to support on-hold listings
Various logic/behavior changes have been made to several Trading calls that return listing data to indicate if a listing is currently on hold due to an eBay policy violation. These changes are covered in the list below:
- GetItemTransactions: If the item ID passed into the ItemID field is for a listing that is on hold, existing error code 17 ("This item cannot be accessed because the listing has been deleted or you are not the seller.") will be triggered.
- GetOrders: If the Order ID passed into the OrderID field is for a single line item ordered spawned from a listing that is on hold, existing error code 21917182 ("OrderLineItemIDs replaceable_value could not be found. Associated Items may have been deleted or removed.") will be triggered.
- GetOrderTransactions: If the Order ID passed in the OrderID field is for a single line item order spawned from a listing that is on hold, or if the ItemID, SKU, or OrderLineItemID (or ItemID/TransactionID combo specified through the TransactionID container) involves an order line item spawned from a listing that is on hold, existing error code 21917182 ("OrderLineItemIDs replaceable_value could not be found. Associated Items may have been deleted or removed.") will be triggered.
- GetSellerList: When making a GetSellerList call, items that are on-hold due to an eBay policy violation will not be returned in the response.
-
GetSellerEvents: When making a GetSellerEvents call, the item.Title field will be returned masked as
*****************
for listings on hold due to a policy violation. - GetSellerTransactions: When making a GetSellerTransactions call, the ItemId value of the listing will be returned in the item.Title field, in place of the item title, to indicate that the listing is on hold due to a policy violation.
- GetMyeBaySelling: When making a GetMyeBaySelling call, the ItemId value of the listing will be returned in the item.Title field, in place of the item title, to indicate that the listing is on hold due to a policy violation.
New enum values added to AccountDetailEntryCodeType
HermesReturnLblSellerPaidShpFee
, HermesReturnLblSellerPaidShpFeeCr
, DHLReturnLblShippingFee
, and DHLReturnLblShippingFeeCredit
have been added to AccountDetailEntryCodeType as enum values and will be returned by GetAccount as applicable.
Documentation Changes and Errata - 1331
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1331 and Changed Functionality - 1331.
None for this release.
Version 1327
Changed Calls - 1327 | Schema Changes - 1327 | Announcements - 1327 | ||
New Features - 1327 | Changed Functionality - 1327 | Document Changes and Errata - 1327 |
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1327
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 - 1327
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 |
---|---|---|
CharityInfoType
|
Type | Removed |
StringMatchCodeType
|
Type | Removed |
GetCharitiesRequestType
|
Type | Removed |
GetCharitiesResponseType
|
Type | Removed |
NonProfitAddressType
|
Type | Modified |
Announcements - 1327
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1327
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 - 1327.
None for this release.
Changed Functionality - 1327
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.
GetCharities Call Decommissioned
The GetCharities call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by GetCharities have been removed from the Trading WSDL. You can see the full list of removed types in the Schema Changes - 1327
Documentation Changes and Errata - 1327
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1327 and Changed Functionality - 1327.
None for this release.
Version 1325
Changed Calls - 1325 | Schema Changes - 1325 | Announcements - 1325 | ||
New Features - 1325 | Changed Functionality - 1325 | Document Changes and Errata - 1325 |
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1325
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 - 1325
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 - 1325
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1325
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 - 1325.
None for this release.
Changed Functionality - 1325
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.
All DSA-related fields are available on all eBay marketplaces
All DSA-related fields are now available on all eBay marketplaces (no longer restricted to specific marketplaces). The Trading API now supports the following features:
- Energy Efficiency Labels
- Hazmat
- Regional Product Compliance Policies
- Regional Take-back Policies
- Repair Score
- Eco-Participation Fee
Documentation Changes and Errata - 1325
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1325 and Changed Functionality - 1325.
None for this release.
Version 1323
Changed Calls - 1323 | Schema Changes - 1323 | Announcements - 1323 | ||
New Features - 1323 | Changed Functionality - 1323 | Document Changes and Errata - 1323 |
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
Index of Changed Calls - 1323
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
- AddFixedPriceItem
- AddItem
- AddItems
- GetAccount
- GetAllBidders
- GetBidderList
- GeteBayDetails
- GetItem
- GetItemShipping
- GetItemTransactions
- GetMyeBayBuying
- GetMyeBaySelling
- GetNotificationPreferences
- GetNotificationsUsage
- GetOrders
- GetOrderTransactions
- GetSellerDashboard
- GetSellerEvents
- GetSellerList
- GetSellerTransactions
- GetUser
- GetVeROReasonCodeDetails
- RelistFixedPriceItem
- RelistItem
- ReviseFixedPriceItem
- ReviseItem
- SetNotificationPreferences
- VerifyAddFixedPriceItem
- VerifyAddItem
- VerifyRelistItem
Schema Changes - 1323
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 |
---|---|---|
AccountDetailEntryCodeType
|
Type | Modified |
AccountDetailEntryCodeType.ExpressPayoutFee
|
Enum | Added |
AccountDetailEntryCodeType.ExpressPayoutFeeCredit
|
Enum | Added |
ExtendedProducerResponsibilityType.ProducerProductID
|
Field | Removed |
ExtendedProducerResponsibilityType.ProductPackageID
|
Field | Removed |
ExtendedProducerResponsibilityType.ShipmentPackageID
|
Field | Removed |
ExtendedProducerResponsibilityType.ProductDocumentationID
|
Field | Removed |
NotificationEventTypeCodeType.OrderInquiryClosed
|
Enum | Deprecated |
NotificationEventTypeCodeType.OrderInquiryOpened
|
Enum | Deprecated |
NotificationEventTypeCodeType.INRBuyerOpenedDispute
|
Enum | Deprecated |
NotificationEventTypeCodeType.OrderInquiryProvideShipmentInformation
|
Enum | Deprecated |
NotificationEventTypeCodeType.OrderInquiryEscalatedToCase
|
Enum | Deprecated |
NotificationEventTypeCodeType.INRBuyerClosedDispute
|
Enum | Deprecated |
NotificationEventTypeCodeType.INRSellerRespondedToDispute
|
Enum | Deprecated |
Summary.AuctionBidCount
|
Field | Deprecated |
Summary.ClassifiedAdOfferCount
|
Field | Deprecated |
Summary.TotalLeadCount
|
Field | Deprecated |
SellingSummary.AuctionBidCount
|
Field | Deprecated |
TicketListingDetailsType
|
Type | Deprecated |
TicketListingDetailsType.EventTitle
|
Field | Deprecated |
TicketListingDetailsType.PrintedDate
|
Field | Deprecated |
TicketListingDetailsType.PrintedTime
|
Field | Deprecated |
TicketListingDetailsType.Venue
|
Field | Deprecated |
SiteCodeType
|
Type | Modified |
SiteCodeType.Czechia
|
Enum | Added |
SiteCodeType.Cyprus
|
Enum | Added |
UpdateReturnPolicy
|
Field | Deprecated |
UpdateSellerInfo
|
Field | Deprecated |
OriginatingPostalCode
|
Field | Deprecated |
QuantityInfo
|
Field | Deprecated |
Announcements - 1323
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1323
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 - 1323.
New Fee and Credit added to GetAccount
The following new fee and credit fields were added to AccountDetailEntryCodeType, and will be returned in GetAccount as applicable. See AccountDetailEntryCodeType for details on this new fee and credit.
ExpressPayoutFee
ExpressPayoutFeeCredit
Changed Functionality - 1323
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.
Extended Producer Responsibility IDs set at account level
For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level and have been removed from the Trading WSDL. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings.*/epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. The ExtendedProducerResponsibilityType fields removed were: ProducerProductID
, ProductPackageID
, ShipmentPackageID
, and ProductDocumentationID
. These fields are no longer usable; if used, the user will get a warning about the fields no longer being supported.
Several enumerated values deprecated in NotificationEventTypeCodeType
Because some of the order inquiry series events have been deprecated, the following enumerated values in NotificationEventTypeCodeType (used in the GetNotificationPreferences, GetNotificationsUsage, and SetNotificationPreferences methods) were also deprecated:
- OrderInquiryClosed
- OrderInquiryOpened
- INRBuyerOpenedDispute
- OrderInquiryProvideShipmentInformation
- OrderInquiryEscalatedToCase
- INRBuyerClosedDispute
- INRSellerRespondedToDispute
Four fields deprecated in GetMyeBaySelling call
Because the data is no longer being actively maintained by eBay, the following four fields in GetMyeBaySelling have been deprecated and scheduled for decommission on 02-06-2024: Summary.AuctionBidCount, Summary.ClassifiedAdOfferCount, Summary.TotalLeadCount, and SellingSummary.AuctionBidCount.
TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls
The TicketListingDetails and QuantityInfo container fields in Add/Revise/Relist/Verify and related calls have been deprecated and are not usable. They will be ignored if sent.
Added Czechia and Cyprus to SiteCodeType
Czechia
and Cyprus
have been added to SiteCodeType as enumeration values.
UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call
The UpdateReturnPolicy and UpdateSellerInfofields fields in the ReviseItem call have been deprecated and are not usable. They will be ignored if sent.
OriginatingPostalCode field deprecated
The OriginatingPostalCode was deprecated in Add/Revise/Relist/Verify family, GetItem family, GetSeller family, and GetOrders calls. To specify the postal code of the item's location, using the Item.PostalCode field in the request. For example, in the AddItem call specify the item's location using the Item.PostalCode field.
Documentation Changes and Errata - 1323
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1323 and Changed Functionality - 1323.
None for this release.
Version 1321
Documentation Changes and Errata - 1321
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1321
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
- AddFixedPriceItem
- AddItem
- AddItems
- AddOrder
- GetItem
- GetItemShipping
- GetItemTransactions
- GetOrders
- GetOrderTransactions
- GetSellerTransactions
- RelistFixedPriceItem
- RelistItem
- ReviseFixedPriceItem
- ReviseItem
- SendInvoice
- VerifyAddFixedPriceItem
- VerifyAddItem
- VerifyRelistItem
Schema Changes - 1321
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 |
---|---|---|
ReminderCustomizationType
|
Type | Removed |
RemindersType
|
Type | Removed |
ShippingDetailsType.CODCost
|
Field | Removed |
SendInvoiceRequest.CODCost
|
Field | Removed |
Announcements - 1321
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1321
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 - 1321.
None for this release.
Changed Functionality - 1321
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.
GetMyeBayReminders Call Decommisioned
The GetMyeBayReminders call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by GetMyeBayReminders have been removed from the Trading WSDL. You can see the full list of removed types in the Schema Changes - 1301 section.
Instead of this API, buyers and sellers can go to My eBay to see all of their selling/buying reminders.
CODCost field removed
The deprecated CODCost fields in Add/Revise/Relist/Verify calls and related calls such as SendInvoice have been removed. This field is no longer returned in GetItem/GetOrder/GetSeller responses.
Documentation Changes and Errata - 1321
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1321 and Changed Functionality - 1321.
None for this release.
Version 1319
Documentation Changes and Errata - 1319
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1319
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
- AddFixedPriceItem
- AddItem
- AddItems
- GetItem
- RelistFixedPriceItem
- RelistItem
- ReviseFixedPriceItem
- ReviseItem
- VerifyAddFixedPriceItem
- VerifyAddItem
- VerifyRelistItem
Schema Changes - 1319
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.
Changed Schema
Name | Part of Schema | Type of Change |
---|---|---|
ConditionDescriptorsType
|
Type | New |
Item.ConditionDescriptors
|
Field | New |
ConditionDescriptorType
|
Type | New |
ConditionDescriptors.AdditionalInfo
|
Field | New |
ConditionDescriptors.Name
|
Field | New |
ConditionDescriptors.Value
|
Field | New |
Announcements - 1319
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1319
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 - 1319.
Condition grading
Note: The ConditionDescriptors and the ConditionDescriptor containers are currently available only in the United Kingdom (GB), with rollout to other markets in early July 2023.
To provide support for condition grading, the ConditionDescriptors container, and the ConditionDescriptor container and its child fields AdditionalInfo, Name, and Value, can be used by the seller to provide information about the specific condition of an item. This information is passed in using the Add/Revise/Relist/Verify calls and returned by calling GetItem.
Changed Functionality - 1319
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 - 1319
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1319 and Changed Functionality - 1319.
None for this release.
Version 1315
Documentation Changes and Errata - 1315
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1315
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
- AddFixedPriceItem
- AddItem
- AddItems
- AddOrder
- GetItem
- GetItemShipping
- GetItemTransactions
- GetOrders
- GetOrderTransactions
- GetSellerTransactions
- RelistFixedPriceItem
- RelistItem
- ReviseFixedPriceItem
- ReviseItem
- SendInvoice
- VerifyAddFixedPriceItem
- VerifyAddItem
- VerifyRelistItem
Schema Changes - 1315
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 |
---|---|---|
ShippingDetailsType.CODCost |
Field | Deprecated |
SendInvoiceRequest.CODCost |
Field | Deprecated |
BuyerPaymentMethodCodeType.COD |
Enum | Deprecated |
Announcements - 1315
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1315
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 - 1315.
None for this release.
Changed Functionality - 1315
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.
ShippingDetailsType.CODCost and SendInvoiceRequest.CODCost fields were deprecated
The ShippingDetailsType.CODCost and SendInvoiceRequest.CODCost fields, and the enumerated value BuyerPaymentMethodCodeType.COD was deprecated, as COD is no longer a supported payment method on any marketplace. See Index of Changed Calls - 1315 for affected methods.
Documentation Changes and Errata - 1315
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1315 and Changed Functionality - 1315.
None for this release.
Version 1313
Documentation Changes and Errata - 1313
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1313
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 - 1313
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 - 1313
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
AddTransactionConfirmationItem and GetContextualKeywords Decommissioned
The AddTransactionConfirmationItem and GetContextualKeywords calls have been decommissioned and removed from the Trading WSDL and documentation.
New Features - 1313
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 - 1313.
New Fees and Credits Added to GetAccount
The following new fees and credits were added to AccountDetailEntryCodeType, and will be returned in GetAccount as applicable. See AccountDetailEntryCodeType for details on these new fees and credits.
- PromotedDisplayFee
- PromotedDisplayFeeCredit
- USWHTFederal
- USWHTFederalCredit
- USWHTState
- USWHTStateCredit
- EPRFee
- EPRFeeCredit
- CAPostReturnLabelFee
- CAPostReturnLabelFeeCredit
- HermesReturnLabelFee
- HermesReturnLabelFeeCredit
- BankPayoutFee
- BankPayoutFeeCredit
- CharityDonation
- CharityDonationCredit
Changed Functionality - 1313
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.
Logic Change for RefundAmount Field in MonetaryDetails
For GetOrders call, there has been a logic change for the RefundAmount field under MonetaryDetails container. Previously, the final value fee amount deducted from the seller's payout funds for the sale was not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The GetOrders call will be updated to include the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrdersresponses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.
Logic Change for Modified Line Items in GST and GIT
For GetSellerTransactions and GetItemTransactions calls, please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned.
Documentation Changes and Errata - 1313
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1313 and Changed Functionality - 1313.
None for this release.
Version 1311
Documentation Changes and Errata - 1311
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1311
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
- AddFixedPriceItem
- AddItem
- AddItems
- GetItem
- RelistFixedPriceItem
- RelistItem
- ReviseFixedPriceItem
- VerifyAddFixedPriceItem
- VerifyAddItem
- VerifyRelistItem
Schema Changes - 1311
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.
Changed Schema
Name | Part of Schema | Type of Change |
---|---|---|
EnergyEfficiencyType
|
Type | New |
Item.Regulatory.EnergyEfficiencyLabel
|
Field | New |
Item.Regulatory.EnergyEfficiencyLabel.ImageDescription
|
Field | New |
Item.Regulatory.EnergyEfficiencyLabel.ImageURL
|
Field | New |
Item.Regulatory.EnergyEfficiencyLabel.ProductInformationsheet
|
Field | New |
Item.Regulatory.RepairScore
|
Field | Modified |
CustomPolicies.RegionalProductCompliancePolicies
|
Field | Added |
CustomPolicies.RegionalProductCompliancePolicies.CountryPolicies
|
Field | Added |
RegionalProductCompliancePolicies.CountryPolicies
|
Field | Added |
RegionalProductCompliancePolicies.CountryPolicies.Country
|
Field | Added |
RegionalProductCompliancePolicies.CountryPolicies.PolicyID
|
Field | Added |
Item.CustomPolicies
|
Field | Modified |
Announcements - 1311
None for this release.
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1311
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 - 1311.
Regulatory changes
Note: The EnergyEfficiencyLabel and the Hazmat containers are initially available only on the German (DE) marketplace. The RepairScore field is provided for future use (not presently available).
As a part of Digital Services Act (DSA) requirements, the EnergyEfficiencyLabel container and its child fields ImageDescription, ImageURL, and ProductInformationsheet, can be used by the seller to provide Energy Efficiency Label related information for the listing. This information is passed in using the Add/Revise/Relist/Verify calls and returned by calling GetItem.
RegionalProductCompliancePolicies and RegionalTakeBackPolicies fields were added, providing compliance functionality specified by region, and ProductCompliancePolicyID now applies to Global product compliance policies.
Numerous fields scheduled for decommission in order management calls
Numerous fields in the response payloads of the GetOrders, GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling calls are being deprecated. See the Deprecated Trading Order Management Fields document for the complete list of deprecated fields and reasons for deprecation.
Changed Functionality - 1311
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.
Documentation Changes and Errata - 1311
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1311 and Changed Functionality - 1311.
Logic change for Total and AmountPaid fields in GetOrders
The field descriptions for Order.Total and Order.AmountPaid fieldsin GetOrders incorrectly stated that sales tax was included in those two amounts, but that was not the case prior to Version 1307. Going foward, sales tax will be included in these amounts if using Trading WSDL Version 1307 or above. If using a Trading WSDL older than Version 1307, the amount in thes fields will not include sales tax. To incorporate the new logic (sales tax included) while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher.
Version 1305
Documentation Changes and Errata - 1305
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1305
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 - 1305
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 |
---|---|---|
AuthenticityVerification | Type | Modified |
AuthenticityVerification.Status | Field | Modified |
Order.ShippingAddress | Field | Modified |
Announcements - 1305
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1305
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 - 1305.
None for this release.
Changed Functionality - 1305
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.
Vault in-hand submission shipping address returned
For Vault in-hand submission orders, the warehouse address is now available for the buyer view. For these orders, the address returned for the Buyer View will be the authenticator's address.
New status for AuthenticityVerificationType
The status PASSED_WITH_PARTIAL_FAILURE was added as a possible returned value for AuthenticityVerification.Status field of the following calls:
- GetOrders
- GetOrderTransactions
- GetItemTransactions
Documentation Changes and Errata - 1305
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1305 and Changed Functionality - 1305.
None for this release.
Version 1303
Documentation Changes and Errata - 1303
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1303
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 - 1303
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 |
---|---|---|
Transaction.LinkedLineItemArray | Container | New |
LinkedLineItemArray.LinkedLineItem | Container | New |
LinkedLineItemArray.LinkedLineItem.EstimatedDeliveryTimeMax | Field | New |
LinkedLineItemArray.LinkedLineItem.EstimatedDeliveryTimeMin | Field | New |
LinkedLineItemArray.LinkedLineItem.Item | Container | Added |
LinkedLineItemArray.LinkedLineItem.OrderID | Field | New |
LinkedLineItemArray.LinkedLineItem.OrderLineItemID | Field | New |
LinkedLineItemArray.LinkedLineItem.SellerUserID | Field | New |
LinkedLineItemArrayType | Type | New |
LinkedLineItemType | Type | New |
StoreType | Type | Modified |
StoreType.StoreSubscriptionLevelCodeType | Type | Removed |
StoreType.StoreSubscriptionLevel | Field | Removed |
Announcements - 1303
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1303
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 - 1303.
Added Support for Linking Separate Orders
Schema was added that links items from separate orders which may be from different sellers. This can be used to provide details about a component (purchased from one seller) needed for its installation (purchased from a different seller). Details can identify the linked seller and also include delivery times, item information, and order information.
Changed Functionality - 1303
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.
SubscriptionLevel field removed from GetStore
The SubscriptionLevel field has been removed from the GetStore call. Use the getSubscription method of the Account API to retrieve information on a seller's eBay store subscription.
Documentation Changes and Errata - 1303
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1303 and Changed Functionality - 1303.
None for this release.
Version 1301
Documentation Changes and Errata - 1301
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1301
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 - 1301
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 |
---|---|---|
GetApiAccessRules | Call | Removed |
ApiAccessRuleType | Type | Removed |
AccessRuleCurrentStatusCodeType | Type | Removed |
AccessRuleStatusCodeType | Type | Removed |
GetApiAccessRulesRequestType | Type | Removed |
GetApiAccessRulesResponseType | Type | Removed |
Announcements - 1301
Buyers in the EU must be allowed to return an item within 14 days or more
As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container.
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1301
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 - 1301.
None for this release.
Changed Functionality - 1301
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.
GetApiAccessRules Call Decommisioned
The GetApiAccessRules call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by GetApiAccessRules have been removed from the Trading WSDL. You can see the full list of removed types in the Schema Changes - 1301 section. We recommend that you use the Developer Analytics API, an API that retrieves all usage data on all RESTful APIs and the Trading API.
Documentation Changes and Errata - 1301
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1301 and Changed Functionality - 1301.
None for this release.
Version 1299
Documentation Changes and Errata - 1299
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1299
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 - 1299
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 |
---|---|---|
ReportItem.Brand |
Field | New |
Announcements - 1299
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1299
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 - 1299.
None for this release.
Changed Functionality - 1299
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.
New Schema Added to Support VeRO Violation Reporting
The field Brand was added to the ReportItem container to provide the brand name of the item being reported for VeRO violation.
Documentation Changes and Errata - 1299
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1299 and Changed Functionality - 1299.
None for this release.
Version 1295
Documentation Changes and Errata - 1295
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1295
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 - 1295
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 |
---|---|---|
AddDispute |
Call | Removed |
AddDisputeResponse |
Call | Removed |
DisableUnpaidItemAssistance |
Call | Removed |
GetDispute |
Call | Removed |
GetUserDisputes |
Call | Removed |
SellerReverseDispute |
Call | Removed |
AddDisputeRequestType |
Type | Removed |
AddDisputeResponseType |
Type | Removed |
AddDisputeResponseRequestType |
Type | Removed |
AddDisputeResponseResponseType |
Type | Removed |
DisableUnpaidItemAssistanceRequestType |
Type | Removed |
DisableUnpaidItemAssistanceResponseType |
Type | Removed |
GetDisputeRequestType |
Type | Removed |
GetDisputeResponseType |
Type | Removed |
GetUserDisputesRequestType |
Type | Removed |
GetUserDisputesResponseType |
Type | Removed |
SellerReverseDisputeRequestType |
Type | Removed |
SellerReverseDisputeResponseType |
Type | Removed |
DisputeActivityCodeType |
Type | Removed |
DisputeArrayType |
Type | Removed |
DisputeCreditEligibilityCodeType |
Type | Removed |
DisputeExplanationCodeType |
Type | Removed |
DisputeFilterCountType |
Type | Removed |
DisputeFilterTypeCodeType |
Type | Removed |
DisputeIDType |
Type | Removed |
DisputeMessageSourceCodeType |
Type | Removed |
DisputeMessageType |
Type | Removed |
DisputeReasonCodeType |
Type | Removed |
DisputeRecordTypeCodeType |
Type | Removed |
DisputeResolutionReasonCodeType |
Type | Removed |
DisputeResolutionRecordTypeCodeType |
Type | Removed |
DisputeResolutionType |
Type | Removed |
DisputeSortTypeCodeType |
Type | Removed |
DisputeStateCodeType |
Type | Removed |
DisputeStatusCodeType |
Type | Removed |
DisputeType |
Type | Removed |
Announcements - 1295
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1295
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 - 1295.
None for this release.
Changed Functionality - 1295
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.
Six Dispute Calls Decommissioned
The following six Dispute calls have been decommissioned as of January 31, 2023. These calls and their exclusively used types have been removed from the Trading WSDL and from reference documentation:
- AddDispute
- AddDisputeResponse
- DisableUnpaidItemAssistance
- GetDispute
- GetUserDisputes
- SellerReverseDispute
The DisableUnpaidItemAssistance, AddDisputeResponse, and SellerReverseDispute calls do not have alternative APIs to use since the Unpaid Item Assistant feature and Unpaid Item cases are deprecated. However, there is a page in Selling Preferences in My eBay that allows a seller to cancel and relist any items that have not been paid for after a specified amount of days.
There are REST API equivalents for the other three calls as follows:
- AddDispute: Use the Create Cancellation Request method of the Post-Order API to make an order cancellation request.
- GetDispute: Use the Get Cancellation method of the Post-Order API to retrieve details on a specific cancellation request.
- GetUserDisputes: Use the Search Cancellations method of the Post-Order API to search for cancellation requests using a variety of search filters.
GetOrderTransactions Call Deprecated
The GetOrderTransactions call is deprecated and will be decommissioned on January 31, 2024. No further updates are planned for this API during the deprecation period. Developers have the option of migrating to the GetOrders call in the Trading API, or the getOrders method of the Fulfillment API. Please note that the Fulfillment API only returns paid orders, so if your use case calls for retrieving both paid and unpaid orders, we recommend migrating to the GetOrders call in the Trading API.
Documentation Changes and Errata - 1295
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1295 and Changed Functionality - 1295.
None for this release.
Version 1291
Documentation Changes and Errata - 1291
For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.
.Index of Changed Calls - 1291
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
- AddFixedPriceItem
- AddItem
- AddItems
- RelistFixedPriceItem
- RelistItem
- ReviseFixedPriceItem
- ReviseItem
- VerifyAddFixedPriceItem
- VerifyAddItem
Schema Changes - 1291
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 |
---|---|---|
Regulatory |
Container | New |
Regulatory.Hazmat |
Container | New |
Regulatory.Hazmat.Component |
Field | New |
Regulatory.Hazmat.Pictograms |
Container | New |
Regulatory.Hazmat.Pictograms.Pictogram |
Field | New |
Regulatory.Hazmat.SignalWord |
Field | New |
Regulatory.Hazmat.Statements |
Container | New |
Regulatory.Hazmat.Statements.Statement |
Field | New |
Regulatory.RepairScore |
Field | New |
RegulatoryType |
Type | New |
HazmatType |
Type | New |
PictogramsType |
Type | New |
StatementsType |
Type | New |
Announcements - 1291
Change Requests
See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.
New Features - 1291
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 - 1291.
New Schema Added to Support Hazardous Material Label Related Information and Repair Score
Due to regulatory requirement changes, sellers now have the ability to provide hazardous material related information and the repair score for listings.
Changed Functionality - 1291
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.
New Error Codes for 1291
Below is the list of the new error messages that rolled out with the 1291 release. All of these messages are related to using hazardous material related information and repair score. The long version of each message is used below.
- (Warning)
21920371
:replaceable_value ID(s) replaceable_value not found. Please use valid ID(s).
- (Warning)
21920372
:Duplicate Regulatory ID(s) replaceable_value sent in the request. Duplicate ID(s) have been ignored.
- (Warning)
21920373
:Hazmat structure incorrect for replaceable_value.
- (Error)
21920374
:Repair score invalid. Repair score must be in the range from replaceable_value to replaceable_value with one decimal place.
- (Error)
21920375
:The value of the replaceable_value field is invalid. Field must not exceed replaceable_value characters.
These error and warning messages can be viewed in the Errors By Number page.
Documentation Changes and Errata - 1291
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1291 and Changed Functionality - 1291.
None for this release.