eBay Post-Order APIVersion 2.6

CreateCancelRequest

A complex object that contains the input data for canceling an order.

Call that uses CreateCancelRequest:

Fields



buyerPaid ( boolean ) [0..?]
If set to true, the buyer has paid for the order and will receive a refund if the cancellation request is approved by the seller (in this case, you must populate the buyerPaidDate field in the request).

A value of false indicates that the buyer did not pay for the order, so is not eligible for a refund even if the cancellation request is approved by the seller.

This field is required only if the buyer requested to cancel the order cancellation and only if the buyer did not pay via PayPal.
See the Field Index to learn which calls use buyerPaid.

buyerPaidDate ( DateTime ) [0..?]
The date and time that the buyer paid for the order. This field is required for only a buyer-requested cancellation and only if buyerPaid=true.
See the Field Index to learn which calls use buyerPaidDate.

cancelReason ( token ) [0..?]
The reason why the buyer or seller wants to cancel the order.

The value supplied must be one of the values returned in the eligibleCancelReason container returned by a POST /post-order/v2/cancellation/check_eligibility call.

Although not required, eBay recommends you populate this field. If omitted, the cancelReason value defaults to OTHER. The values specific to sellers are ADDRESS_ISSUES and OUT_OF_STOCK_OR_CANNOT_FULFILL.
See the Field Index to learn which calls use cancelReason.

legacyOrderId ( string ) [0..?]
The unique eBay-assigned ID of the order that the buyer is attempting to cancel or that the seller is canceling.

Note: The order ID value changes as an order goes from the unpaid to the paid state.

See the Field Index to learn which calls use legacyOrderId.

relistLineItem ( array of RelistLineItem ) [0..?]
Populate this array with a list of the items you want to relist from the order being canceled. eBay automatically relists the specified items when the seller marks them as received from the cancellation request.
See the Field Index to learn which calls use relistLineItem.