Just getting started with the Post-Order API? The navigation bar contains links to the API Reference, the Usage Guide, and more.
See the following for a general introduction to the Post-Order API, and other resources offered by the eBay Developers Program:
The following table lists the official releases for the Post-Order API, Version 2:
Release Version | Release Date | Description of Release | |
---|---|---|---|
Version 2.5 | 2019-10-21 | Updates to Cancellation resource. | |
Version 2.4 | 2019-06-12 | Added ability to auto-relist an item when refund is issued. | |
Version 2.3 | 2019-01-01 | Added ability for sellers to provide return instructions. | |
Version 2.2 | 2015-09-28 | Added seller shipping label functionality. | |
Version 2.1 | 2015-08-24 | Added order inquiry and order escalation functionality. | |
Version 2.0 | 2015-06-29 | Initial Version 2 Release |
This release updates the Cancellation and Return services in Post-Order API, Version 2.5
Note that this release does not introduce any new methods to the Post-Order API.
There are three types of updates to the Cancellation schema: new schema objects, updated object types, and updated values supported in enumeration types. Please see the Post-Order API Reference for details on these new and updated types.
This update introduces the following new complex object and enumeration types in the Cancellation resource:
The following enumeration types have updated values, please see the documentation for details:
There are three types of updates to the Return schema: new schema objects, updated object types, and updated values supported in enumeration types. Please see the Post-Order API Reference for details on these new and updated types.
This update introduces the following new complex object and enumeration types in the Return resource:
The following object types have been updated in this release:
The following enumeration types have updated values, please see the documentation for details:
All the methods and types defined for the RULES resource have been deprecated and removed from the schema and documentation.
The functionality for return rules continues to be supported and updated in Seller Hub, where sellers can establish and maintain the rules by which they want to handle order returns.
The following method response fields in the Cancellation resource have been removed from the Post-Order API Reference documentation:
This Post-Order API, Version 2 feature update gives sellers the ability to automatically relist an item when they issue a refund.
Sellers now have the ability to request that an item be automatically relisted when the seller issues a refund for a returned item.
The new Boolean relistItem field in the POST /post-order/v2/return/{returnId}/issue_refund call lets sellers indicate that they want eBay to automatically relist the returned item when the seller issues the refund for the return.
Sellers can check the eligibility for an item to be relisted by calling Get Return. In the response, check the itemDetail.relistStatus field for eligibility. This field will also show the status of a relist request as either SUCCESS
(the relist succeeded) or FAILED
(the relist request did not succeed).
If the relist request succeeds, call Get Return and check the itemDetail.relistedItemId to get the listing ID of the newly relisted item (the ID should match the ID of the original item listing).
This release adds new fields to the following two operations in order returns:
This release has the following schema updates:
This Post-Order API, Version 2 feature update gives sellers the ability to add return instructions for buyers.
Seller can specify return instructions using the comments.
content field of the POST /post-order/v2/return/{returnId}/decide call. Added comments are displayed on the Return Details page when the buyer visits the page to retrieve their return shipping label.
Note that the content field is not new, but the functionality to display the comments to the buyer has been added starting in January 2019.
The Processing return requests section of the Features Guide has been updated to clarify the API flows for item returns. Please review the new flows if you (the seller) provide your own shipping labels or if you use eBay-supplied labels.
This is a feature update for the Post-Order API, Version 2.
This release adds new upload seller shipping label functionality to the Post-Order API.
None
Name | Part of Schema | Type of Change |
---|---|---|
LabelActionEnum |
Enumerated type | New |
NoSellerUploadLabelReasonEnum |
Enumerated type | New |
ProvideLabelRequest.forwardShippingLabelProvided |
Element | New |
ProvideLabelRequest.labelAction |
Element | New |
ProvideLabelRequest.noLabelReason |
Element | New |
ReturnHoldInfoType.holdTransactionId |
Element | New |
The POST /post-order/v2/return/{returnId}/add_shipping_label call was enhanced to enable the seller to provide their own shipping labels to buyers for return shipping. To do this, the seller first uses the POST /post-order/v2/return/{returnId}/file/upload call to upload a scanned image of the seller's shipping label to the return request. Then, the seller uses the POST /post-order/v2/return/{returnId}/add_shipping_label call to make this shipping label available to the buyer. See the POST /post-order/v2/return/{returnId}/add_shipping_label sample to find out more about how this is done.
In addition to being able to provide a seller-generated shipping label to the buyer, the new labelAction field in the POST /post-order/v2/return/{returnId}/add_shipping_label call allows the seller to perform the following actions:
New holdTransactionId field is conditionally returned in the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls if a return request has been placed in hold status.
The Shipping returns section of the Features Guide was updated to account for the new upload seller shipping label functionality.
The POST /post-order/v2/return/{returnId}/file/upload and POST /post-order/v2/return/{returnId}/add_shipping_label call samples have been updated to account for the new upload seller shipping label functionality.
The API Reference, the Usage Guide, and the Post-Order content of the eBay Features Guide have been revised and extended for clarity and accuracy as of December 3, 2015. Existing code should still behave the same.
This is a feature update for the Post-Order API, Version 2.
This release adds new operations for order inquiries (/inquiry)and order escalations (/casemanagement) to the Post-Order API.
This release contains several new operations that offer flows for order inquiries and escalations.
See the New Calls section for a complete list of the new operations, and the Usage Guide for details on the newly supported use cases.
The documentation has been updated to support the new inquiry and escalation operations and use cases.
This is the initial release of the Post-Order API, Version 2.
The following /return and /cancellation operations are included in this initial release of the Post-Order API, Version 2.
Copyright © 2015–2019 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.