eBay Trading APIVersion 1119

CancelDetailType

Type used by the CancelDetail container, which consists of details related to an eBay order that has been cancelled or is in the process of possibly being cancelled.

Type that uses CancelDetailType:

Calls that use CancelDetailType:

Fields



CancelCompleteDate ( dateTime ) [0..1]
Timestamp indicating when the cancellation process of an eBay order has been completed, which will be indicated if the Order.CancelStatus field has a value of CancelComplete. This field will not be returned until the cancellation process is completed.
See the Field Index to learn which calls use CancelCompleteDate.

CancelIntiationDate ( dateTime ) [0..1]
This timestamp indicates when the cancellation of the eBay order was initiated. This field is always returned with the CancelDetail container.
See the Field Index to learn which calls use CancelIntiationDate.

CancelIntiator ( token ) [0..1]
This value indicates which party initiated the cancellation of the eBay order. It will usually be Buyer or Seller, but it can also be CS (eBay Customer Support). See CancelInitiatorCodeType for the complete list of enumeration values that can be returned in this field. This field is always returned with the CancelDetail container.
See the Field Index to learn which calls use CancelIntiator.

CancelReason ( token ) [0..1]
This value indicates the reason why the order cancellation was initiated. This field is always returned with the CancelDetail container. Typical buyer-initiated cancellation reasons include OrderPlacedByMistake, WontArriveInTime, or FoundCheaperPrice. Sellers may initiate an order cancellation on behalf of the buyer. In this scenario, the seller should state the cancellation reason as BuyerCancelOrder. If the seller is cancelling an order because he/she is out of stock on an item, the seller should state the cancellation reason as OutOfStock. Unfortunately, in this scenario, the seller will receive a seller defect for this cancellation reason. Other order cancellation reasons are specific to eBay Scheduled Delivery orders. eBay Scheduled Delivery is similar to the eBay Now service in the US (now retired), and is only available in the UK. See CancelReasonCodeType for the complete list of enumeration values that can be returned in this field.

Note: Currently, the CancelReason field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.
See the Field Index to learn which calls use CancelReason.

CancelReasonDetails ( string ) [0..1]
The detailed reason of why the order cancellation was initiated. This field is only returned if it is available for an order that has been cancelled, or if an order is going through the cancellation process.

Note: Currently, the CancelReasonDetails field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.
See the Field Index to learn which calls use CancelReasonDetails.