Trading API
The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues.
If you are getting started with the API, the following locations have information about joining the eBay Developers Program, creating test users, and other steps to getting your application certified to go live against the eBay production servers:
|
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
The lowest supported version is 941.
To learn how versioning works in the Trading API, see eBay's Schema Versioning Strategy.
Documentation Changes and Errata - 1145
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
AccountDetailsEntryType.ShippingInsuranceFee |
Enum | New |
AccountDetailsEntryType.ShippingInsuranceFeeCredit |
Enum | New |
AccountDetailsEntryType.UspsLabelFee |
Enum | New |
AccountDetailsEntryType.UspsLabelFeeCredit |
Enum | New |
AccountDetailsEntryType.UspsShortpaidFee |
Enum | New |
AccountDetailsEntryType.UspsShortpaidFeeCredit |
Enum | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
Beginning in April 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level. From June 2019 up until now, users could control whether the new or old order ID format was returned in response payloads. This change affects the following calls:
Note that unique identifiers of orders change as they transition from 'commit to buy'/unpaid to paid orders. So, users will still be able to pass in the IDs for unpaid orders to get the status of those orders, but once orders are paid for, sellers should only use/reference the new order ID format (for paid orders), as these are the identifiers that will also be known to the buyers.
Currently, in Add/Revise/Relist calls, sellers have an option to identify a nonprofit organization with the eBay unique identifier through the Charity.CharityID field, or they can identify the same nonprofit organization using the PayPal Giving Fund unique identifier through the Charity.CharityNumber field. The CharityNumber field has been scheduled for deprecation, so sellers using the CharityNumber field should make plans to migrate to the CharityID field instead.
The eBay unique identifier for nonprofit organizations is shown in the id attribute of each Charity container returned in the response of the GetCharities call.
The ReviseCheckoutStatus call has been staged for deprecation, and this endpoint will no longer be available toward the latter half of 2021. More specific details on exact timing will be announced at a later date. We recommend that you use the CompleteSale call instead of ReviseCheckoutStatus to update the status and/or details of your order. If your use case is to provide shipment tracking information for one or more line items of a paid order, you can use the createShippingFulfillment method of the Fulfillment API to do this task.
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 - 1145.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Previously, the Succeeded enumeration value would automatically get returned in the Payment.PaymentStatus field for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded.
This change affects the GetOrders, GetOrderTransactions, GetItemTransactions, and GetSellerTransactions calls.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1145 and Changed Functionality - 1145.
There were several areas in the Call Reference documentation where it wasn't clear if a field was designed for the eBay unique identifier of a nonprofit organization or the PayPal Giving Fund unique identifier of a nonprofit organization. Below is a list of the fields in Trading that identify nonprofit organizations, and whether the values of those fields are for eBay or PayPal Giving Fund charity IDs:
Documentation Changes and Errata - 1139
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1139.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Postal code values returned in the Item.PostalCode field of GetItem will be masked to all users except for the seller of the item. Different countries will mask postal/zip codes in slightly different ways, but an example would be 951**.
The behavior of the fields returned in the FeedbackDetail container of the GetFeedback response has changed in the following ways:
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1139 and Changed Functionality - 1139.
Added a note to the SetPromotionalSale, SetPromotionalSaleListings, and GetPromotionalSaleDetails calls recommending that sellers/developers make plans to migrate to the Marketing API, which provides all Promotions Manager and Promoted Listings capabilities. The Trading API does not support Promoted Listings, and there are no plans for the Trading API to support Promoted Listing or additional Promotions Manager functionality going forward.
Added a note to the VariationProductListingDetails.ProductReferenceID field about it not being supported for any categories. Currently, sellers cannot associate an eBay catalog product with single variations within a multiple-variation listing. If the seller attempts to supply an eBay Product Identifier (ePID) at the variation level, a warning will get returned and the ePID value will just be dropped.
Included a note and a link in the Item.Description field about the View Item Description Summary Feature. This feature allows sellers to customize the description of an item as it appears on a mobile device.
Added site-specific max length values for several address-related fields (in AddressType), including Street1, Street2, CityName, StateOrProvince, and PostalCode. For all five of these fields, the max lengths according eBay marketplace are shown:
For sellers opted in to the feature that supports different same-day handling order cut off times for each business day, the CutoffTime field set in SetUserPreferences and returned in GetUserPreferences is not applicable/usable. This particular field and the DispatchCutoffTimePreference container is designed to only support one order cutoff time.If a seller wishes to view or modify their order cutoff times for same-day handling, that seller must go to Shipping Preferences in My eBay.
Documentation Changes and Errata - 1131
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
GetAccountRequest.OrderID |
Field | New |
AccountHistorySelectionCodeType.OrderId |
Enum | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
Category and item specific changes were rolled out as part of the 2019 Fall Seller Release.
To get more information on the category changes, and to see the full list of affected categories, go here. For sellers using the add and revise listing calls of the Trading API to add/revise items, old category IDs will automatically be remapped to new category IDs as long as the CategoryMappingAllowed boolean field is not set to false (it's set to true by default).
Item specific changes went into effect on October 15, 2019. To get more information on the item specifics changes, go here. For sellers using legacy APIs (like Trading API), we suggest that you call GetCategorySpecifics for your category to get the required and recommended item specifics for your category. To see if an item specific is required, recommended, or optional, look at the NameRecommendation.ValidationRules.UsageConstraint field for each item specific returned in the response. Sellers will be blocked from listing/revising an item if required item specifics are not included. As long as they are relevant/applicable to the item, sellers should also make sure to include recommended and optional item specifics as well, and this may make it easier for buyers to find your listings. A REST alternative to the Trading API's GetCategorySpecifics is the Taxonomy API's getItemAspectsForCategory call.
Both category metadata calls mentioned above will return the latest item specific metadata, but newly added item specific names can also be found in table format (organized by category) on this page. All of the item specific names on this page are required, so sellers can search for their listing categories on this page to make sure their listings in these categories have these item specfics.
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 - 1131.
The GetAccount call was updated to retrieve account entries related to a specific order. To search for account entries related to a specific order, the user includes the AccountHistorySelection field in the request and sets it value to (newly-added) OrderId, and includes the newly-added OrderID field and sets its value to the unique identifier of the order. If one or more account entries are found for the specified order, the corresponding AccountEntry.OrderId will be shown for those account entries.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
A new error code (21920255) was added to cover 'Buy it Now' prices that exceed the maximum thresdhold for a category. If a seller specifies the 'Buy it Now' price at a value above this threshold, this error code is returned and the seller is blocked from listing/revising an item.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1131 and Changed Functionality - 1131.
None for this release.
Documentation Changes and Errata - 1129
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
CollectionMethodCodeType |
Type | New (reserved for future use) |
TaxDetailsType.CollectionMethod |
Field | New (reserved for future use) |
AccountEntryType.OrderId |
Field | New |
AccountDetailsEntryType.PaymentIntermediationFeeCredit |
Enum | New |
AccountDetailsEntryType.EbaySendLabelFee |
Enum | New |
AccountDetailsEntryType.EbaySendLabelFeeCredit |
Enum | New |
AccountDetailsEntryType.USInternetSalesTax |
Enum | New |
AccountDetailsEntryType.USInternetSalesTaxCredit |
Enum | New |
AccountDetailsEntryType.NewZealandGST |
Enum | New |
AccountDetailsEntryType.NewZealandGSTCredit |
Enum | New |
AccountDetailsEntryType.AustraliaGST |
Enum | New |
AccountDetailsEntryType.AustraliaGSTCredit |
Enum | New |
AccountDetailsEntryType.CoFundingCharge |
Enum | New |
AccountDetailsEntryType.CoFundingChargeCredit |
Enum | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
Beginning in early November, for orders subject to eBay 'Collect and Remit' taxes, PayPal will begin distributing order funds to the seller's account with the sales tax included. However, shortly after the order funds clear in the seller's account, the 'Collect and Remit' tax amount will be pulled by PayPal from the seller's account and then disributed to the appropriate taxing authority. Currently, PayPal is stripping this 'Collect and Remit' tax from the buyer's payment and directly submitting this amount to the appropriate taxing authority, and this tax amount never shows up in the sellers account.
eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' tax that is applicable to Australian and New Zealand sellers. To accomodate for these changes, the order management calls and the GetAccount call was updated. See the Changed Functionality section for more information about how these API calls are handling this logic change.
This change does not affect sellers that are already opted in to eBay managed payments. For these sellers, the sales tax amount will never be included in a seller payout.
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 - 1129.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Beginning in early November, for orders subject to eBay 'Collect and Remit' taxes, PayPal will begin distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' tax that is applicable to Australian and New Zealand sellers. Due to this change, the following updates were made to GetOrders (and other order management calls):
This change does not affect sellers that are already opted in to eBay managed payments. For these sellers, the sales tax amount will never be included in a seller payout. For sellers that are opted in to eBay managed payments, the 'Collect and Remit' tax will only be shown in the Transaction.eBayCollectAndRemitTaxes container, and not in the Transaction.Taxes. For sellers not opted in to eBay managed payments, both of these containers will appear in the response showing the 'Collect and Remit' tax details.
Six new enumeration values were added for GetAccount (in AccountDetailEntryCodeType) to account for the eBay 'Collect and Remit' tax that is distributed to the seller's account by PayPal, and then pulled from the account by PayPal and sent to the appropriate tax authority. The enumeration values include:
USInternetSalesTaxUSInternetSalesTaxCreditNewZealandGSTNewZealandGSTCreditAustraliaGSTAustraliaGSTCreditSee these new values in AccountDetailEntryCodeType for more information.
A new OrderId field was also added to the AccountEntry container of GetAccount to indicate the order associated with the 'Collect and Remit' tax account entry.
The GetCategorySpecifics call has been updated to return all available item specific name-value pairs by default. Before this change, 30 item specific names would be returned by default and 25 corresponding values for each returned item specific name. The maximum amount of item specific names that could be returned was 50, and this limitation was also lifted.
The MaxNames and MaxValuesPerName request filters can still be used if the user wishes to limit the number of item specific names and/or values that are returned in the GetCategorySpecifics response. To account for this change, the Max constraints and the Default values were removed from these request filter field descriptions.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1129 and Changed Functionality - 1129.
None for this release.
Documentation Changes and Errata - 1125
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
AccountDetailsEntryType.AdFeePremium |
Enum | New |
AccountDetailsEntryType.AdFeePremiumCredit |
Enum | New |
AccountDetailsEntryType.CanadaPostLabelFee |
Enum | New |
AccountDetailsEntryType.CanadaPostLabelFeeCredit |
Enum | New |
AccountDetailsEntryType.PerListingPaymentsFee |
Enum | New |
AccountDetailsEntryType.PerListingPaymentsFeeCredit |
Enum | New |
AccountDetailsEntryType.SendLabelFee |
Enum | New |
AccountDetailsEntryType.SendLabelFeeCredit |
Enum | New |
AccountDetailsEntryType.UpsLabelFee |
Enum | New |
AccountDetailsEntryType.UpsLabelFeeCredit |
Enum | New |
AccountDetailsEntryType.VehiclesListingBasicPackageFee |
Enum | New |
AccountDetailsEntryType.VehiclesListingBasicPackageCredit |
Enum | New |
AccountDetailsEntryType.VehiclesListingPlusPackageFee |
Enum | New |
AccountDetailsEntryType.VehiclesListingPlusPackageCredit |
Enum | New |
AccountDetailsEntryType.VehiclesListingPremiumPackageFee |
Enum | New |
AccountDetailsEntryType.VehiclesListingPremiumPackageCredit |
Enum | New |
SubscriptionLevel.Starter |
Enum | New |
SubscriptionLevel.Enterprise |
Enum | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1125.
Two new enumeration values, Starter and Enterprise, were added to StoreSubscriptionLevelCodeType to account for the two new eBay Store subscription levels. An eBay user's store subscription level is returned in the GetStore call.
A user must use the 1125 WSDL or set Compatibility Level to '1125' to see these two enumeration values (when applicable) in the GetStore call response.
16 new enumeration values were added to AccountDetailEntryCodeType to represent the new fees and credits that were added to account for new ad fees, payment fees, vehicle listing fees, and shipping label fees. See the GetAccount Change History section for a full list of the new enum values.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1125 and Changed Functionality - 1125.
A note was added to all OrderID fields to call out how OrderID (and ExtendedOrderID) values change as orders go from unpaid to paid (for sellers integrated with the new order ID format). When using a GetOrders or GetOrderTransactions call (or any other call that uses OrderID in request), either of these order IDs (paid or unpaid status) can be used to identify an order.
Added a note to the Platform Notifications Landing Page (Notification Payloads section) about the requirement For sellers to upload the Payload Version of their Platform Notifications in order to retrieve the new order ID format for order-related Platform Notifications that are returned in the GetItemTransactions response (when triggered/applicable). A SetNotificationPreferences call should be run to update the payload version of Platform Notifications to '1113' or above.
Added Min/Max value constraints to the WeightMinor field that is used under ShippingPackageDetails container to express the number of ounces or grams for the weight of a package. The weight of the package is necessary when creating listings that use calculated shipping costs. For ounces, the maximum value is '15', and for grams, the maximum value is '999'.
Documentation Changes and Errata - 1119
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1119.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
If the seller is using Flat or Calculated shipping, at least one actual shipping service option must be specified through a ShippingDetails.ShippingServiceOptions container when using an Add or Revise Item call. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingServicevalue set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup.
The Feature Gallery listing feature, currently only available for Top-Rated sellers on the Germany site, has been scheduled for deprecation. Below is the deprecation schedule for the feature:
Lifetime.Gallerythe GalleryDuration in PictureDetailsType has been removed from the Trading WSDL. In an Add/Revise/Relist call, the value of the GalleryType field in the PictureDetails container should no longer be set to Featured. The ListingEnhancementDurationCodeType, only used to set the duration of the Featured Gallery feature, and the Featured enumeration value of GalleryTypeCodeType have also been marked as no longer applicable due to the impending end of this feature.
The ShippingSurcharge field in ShippingServiceOptionsType has been removed from the Trading WSDL. For the next 18 months, this field will still be supported if used in a Add/Revise/Relist call, but it is recommended that sellers configure shipping surcharges in Shipping rate tables instead. Shipping rate tables can be added and modified through the Shipping Preferences in My eBay.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1119 and Changed Functionality - 1119.
The SellerInventoryID field in ItemType has been removed from the Trading WSDL. This field was no longer applicable as soon as the Half.com site was shut down.
Semicolons cannot be used in a PictureURL field. Unlike a blank space, a semicolon cannot be "escaped" with %20. If a semicolon is used in a PictureURL field, that picture will not be allowed.
Documentation Changes and Errata - 1113
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
The new format for eBay orders has been implemented. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. This new format will now appear in the order details section of the View Order Details page, in Seller Hub, in reports, and in email correspondence. Both the old format and the new order ID format will be supported in all API calls. See the Changed Functionality section for current details on how order IDs will work with Trading API calls.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1113.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The new format for eBay orders has been implemented, and this new format will now appear in the order details section of the View Order Details page, in Seller Hub, in reports, and in email correspondence.
Whether the old or new format for Order IDs is returned in OrderID fields in Trading API call responses is determined by the WSDL version being used and on the X-EBAY-API-COMPATIBILITY-LEVEL request header value. See below for more details on version control:
1113 to see the new order ID format in call responses. Regardless of the WSDL version number or the X-EBAY-API-COMPATIBILITY-LEVEL, both old and new order ID formats can be used to identify an order in all Trading API call requests. These calls include the following:
eBay will support the old identifier format in APIs until at least Q1 2020, but it is a good idea that developers integrate with the new format as soon as possible just for ease of management of orders, as only the new order ID format will be showing up elsewhere - Order Details, Seller Hub, email correspondence, etc.
If a user is using Version 1113 (or using an older version with the X-EBAY-API-COMPATIBILITY-LEVEL value set to '1113', the new order ID format will be seen in the OrderID field for the following call responses:
For the ExtendedOrderID field (returned in all order management calls), the new order ID format will be returned, regardless of the WSDL version number or compatibility level. The ExtendedOrderID was previously created to distinguish between legacy and REST API-based order identifiers. Now, with the rollout of the new order ID format, the same order identifiers will be used for both legacy and REST-based APIs, although the legacy APIs will support both the old and the new formats until 2020.
For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. However, when using a GetOrders or GetOrderTransactions call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order. Sellers can also check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment.
Once you integrate with the new order ID format, it is possible that you will retrieve an order that you had already acknowledged and fulfilled, but you may not recognize that order because the order ID value has changed. To help avoid this scenario and shipping the same order twice, you can consider taking the following approaches:
For sellers that are subscribed to order-related Platform Notifications that are returned in the GetItemTransactions response (when triggered/applicable), and also integrated with the new order ID format, a SetNotificationPreferences call should be run to upload the payload version of Platform Notifications to '1113' or above. This is necessary so that the order ID values that are returned in the GetItemTransactions response and the order ID values that are returned in the XML SOAP messages sent to servers and/or email addresses are in synch with one another. To update the payload version of Platform Notifications using the SetNotificationPreferences call, the user would just pass in the ApplicationDeliveryPreferences.PayloadVersion field and set its value to '1113' or above, as demonstrated below:
<ApplicationDeliveryPreferences>
<PayloadVersion>1113</PayloadVersion>
</ApplicationDeliveryPreferences>
Platform Notifications can be configured to be sent to servers and/or email addresses by using the ApplicationDeliveryPreferences container in a SetNotificationPreferences call. Order-related Plaform Notifications include the following:
AuctionCheckoutCompleteCheckoutCheckoutBuyerRequestsTotalEndOfAuctionFixedPriceTransactionThe OrderLineItemCount field, introduced with Version 1107, is used to indicate the total number of line items in an order. Similar to the order ID format change, the OrderLineItemCount field was released with version/compatibility control. This field will be returned under the ContainingOrder container of the GetItemTransactions or GetSellerTransactions calls if the following is true:
1113trueThis section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1113 and Changed Functionality - 1113.
The maximum length has been published for all occurrences of OrderID and ExtendedOrderID fields. The maximum length is 40 characters. Previously, the maximum length value was not stated in the API documentation. This maximum length value applies to both the old and the new order ID format.
Documentation Changes and Errata - 1111
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
UsageConstraintCodeType |
Type | New |
ValidationRules.UsageConstraint |
Field | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1111.
The NameRecommendation.ValidationRules.UsageConstraint field was added to the GetCategorySpecifics response to indicate whether the item specific is required, recommended, or optional. Previously, returned item specifics were only 'marked' as required or optional. With the introduction of this new field, eBay is able to specify to sellers which item specifics are highly recommended, although not required. The item specifics that are recommended can possibly improve search results and/or sales conversion.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1111 and Changed Functionality - 1111.
None for this release.
Documentation Changes and Errata - 1107
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
OrderType.OrderLineItemCount |
Field | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1107.
New OrderLineItemCount field added to OrderType. This field will indicate the total number of line items in an order. This field will be returned under the ContainingOrder container of the GetItemTransactions or GetSellerTransactions calls. In order for the ContainingOrder container to be returned, a user must include the IncludeContainingOrder field in the call request and set its value to true.
This field has yet to be wired on, so will not be currently returned in any circumstance. However, once this field is wired on, the user must be using Version 1107 of the Trading WSDL (or newer, as versions roll out), and the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value must be set to '1113' in order to see this field in the response.
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.
Starting in June 2019, eBay will start changing the format of order identifier values. The new format will be a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
During the transition period, developers/sellers will use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in all Trading API call response payloads. The compatibility version is expected to be Version 1113. During the transition period and even after, the new and old OrderID formats will still be supported in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
You can read more about this change in the Spring 2019 Seller Updates.
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). You can read more about this change in the Spring 2019 Seller Updates.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1107 and Changed Functionality - 1107.
The occurrence value of the CityName field of AddressType was incorrectly stated as 'Always' being returned. This was not correct, and the occurrence value was changed to 'Conditionally' returned instead. Although most addresses include a city name, some do not. For example, Singapore is an island city-state, and the CityName field would not be applicable to any address in Singapore.
For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. The Buyer.Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.
Copyright © 2005–2020 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.