Occasionally there are circumstances under which orders need to be canceled. Buyers and sellers can each specify a variety of reasons to initiate the cancellation of an order, and both paid and unpaid orders can be canceled. However, buyers must initiate an order cancellation within one hour after purchase/commitment to buy. In all instances, a buyer-initiated cancellation requires the seller's approval.
The GetOrders response payload includes the following fields which provide general information about canceled orders:
-
Indicates the reason why the order cancellation was initiated.
-
The current status for the order cancellation request for an order, if one exists.
Order cancellations are managed using the Post-Order API Cancellation Calls.
Manage order cancellations
The Post-Order API offers updated after-sale experiences that include new flows for canceling orders.
If order cancellations have previously been processed using the Trading API, changes must be made to existing flows to take advantage of the updated after-sale capabilities offered by the Post-Order API.
For complete information about using the Post-Order API to manage order cancellations, refer to:
Currently, Post-Order API Cancellation Calls act upon an entire order, so a single line item within a multiple line item order cannot be canceled.