eBay Post-Order APIVersion 2.7.2
 

CreateCancelRequest

This is the base request type for the POST /post-order/v2/cancellation method, which is used to create an order cancellation request.

Call that uses CreateCancelRequest:

Fields



buyerPaid ( boolean ) [0..?]
This field should be included and set to true if the buyer has paid for the order, and is eligible for a refund if the cancellation request is approved by the seller. If the buyer has paid for the order, the payment date should also be included in the buyerPaidDate field.

If the buyer has not paid for an order, this field should be included and set to false. In this case, the buyer is not eligible for a refund even if the cancellation request is approved by the seller.
See the Field Index to learn which calls use buyerPaid.

buyerPaidDate ( DateTime ) [0..?]
The timestamp in this container indicates that the buyer paid for the order. If the buyer has not paid for the order, this container is not applicable.
See the Field Index to learn which calls use buyerPaidDate.

cancelReason ( string ) [0..?]
This field is used to indicate the reason why the buyer or seller wants to cancel the order. One of the enumeration values defined in the CancelReasonEnum type definition must be used in this field. The descriptions for each enumeration value in that type definition will indicate whether the cancel reason is intended for the buyer or seller.

Although not required, it is highly recommended that a cancel reason is provided.
See the Field Index to learn which calls use cancelReason.

legacyOrderId ( string ) [0..?]
A unique eBay-assigned ID for the order being considered for cancellation.

Note: The unique identifier of an order changes as the order goes from unpaid to paid, so the IDs for both unpaid and paid orders are supported in this field. For orders where payment has been made, the ID for the paid order should be used.

See the Field Index to learn which calls use legacyOrderId.

relistLineItem ( array of RelistLineItem ) [0..?]
This array can be used for seller-initiated order cancellation requests if the seller wishes to relist one or more line items that are a part of the order being cancelled. Once the order cancellation is successfully processed by eBay, the line item(s) will be relisted automatically.
See the Field Index to learn which calls use relistLineItem.