eBay Post-Order APIVersion 2.7.2
 

CancelDetail

This type contains all of the details associated with an order cancellation request.

The containers and fields returned under the cancelDetail container will depend on whether the fieldgroups query parameter of the GET /post-order/v2/cancellation/{cancelId} request is set to FULL or SUMMARY.

Type that uses CancelDetail:

Call that uses CancelDetail:

Fields



activityHistories ( array of CancelActivityHistory ) [0..?]
A complete list of the activity associated with the order cancellation request.
See the Field Index to learn which calls use activityHistories.

buyerLoginName ( string ) [0..?]
The eBay username of the buyer involved in the order cancellation request.
See the Field Index to learn which calls use buyerLoginName.

buyerResponseDueDate ( DateTime ) [0..?]
The timestamp in this container indicates the time by which the buyer is required to respond to an active order cancellation request. This container is not returned if the order cancellation request does not currently require a response from the buyer.
See the Field Index to learn which calls use buyerResponseDueDate.

cancelCloseDate ( DateTime ) [0..?]
A timestamp that indicates when the order cancellation request was closed. This field is only applicable and returned if/when the cancellation request is closed (regardless of outcome).
See the Field Index to learn which calls use cancelCloseDate.

cancelCloseReason ( token ) [0..?]
This enumeration value indicates the reason why the order cancellation request was closed. This field is only applicable and returned if/when the cancellation request was closed or if the buyer attempted to close the cancellation request.

The full list of enumeration values that may get returned in this field are defined in the CancelCloseReasonEnum type definition.
See the Field Index to learn which calls use cancelCloseReason.

cancelId ( string ) [0..?]
A unique eBay-assigned ID for an order cancellation request. All data in the cancelDetail container refers to this specific order cancellation request.
See the Field Index to learn which calls use cancelId.

cancelReason ( token ) [0..?]
This value indicates the reason why the user (either the buyer or seller, as defined in the requestorType field) initiated the order cancellation request.

The full list of enumeration values that may get returned in this field are defined in the CancelReasonEnum type definition.
See the Field Index to learn which calls use cancelReason.

cancelRequestDate ( DateTime ) [0..?]
The timestamp in this container indicates when the order cancellation request was created.
See the Field Index to learn which calls use cancelRequestDate.

cancelState ( string ) [0..?]
This value indicates the current state or condition of the cancellation process.

This value, combined with the value of the cancelStatus field, can help you determine upcoming cancellation events and the appropriate actions you can take.

The full list of enumeration values that may get returned in this field are defined in the CancelStateEnum type definition.
See the Field Index to learn which calls use cancelState.

cancelStatus ( string ) [0..?]
This value indicates the last action taken by one of the parties associated with the order cancellation request.

This value, combined with the value of the cancelState field, can help you determine upcoming events and the appropriate actions you can take on the cancellation.

The full list of enumeration values that may get returned in this field are defined in the CancelStatusEnum type definition.
See the Field Index to learn which calls use cancelStatus.

legacyOrderId ( string ) [0..?]
The unique identifier of the order being cancelled or 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 may be returned in this field based on payment status.

See the Field Index to learn which calls use legacyOrderId.

marketplaceId ( string ) [0..?]
A unique identifier for the eBay marketplace where the order cancellation request was created.

The full list of enumeration values that represent eBay marketplaces are defined in the MarketplaceIdEnum type definition.
See the Field Index to learn which calls use marketplaceId.

moneyMovementInfo ( array of can:MoneyMovementDetailType ) [0..?]
This array consists of detailed information on any and all money movement transactions that have occurred in regards to the order cancellation request.
See the Field Index to learn which calls use moneyMovementInfo.

partialOrderType ( PartialOrderTypeEnum ) [0..?]
This value indicates whether the cancellation request is for the entire order, or only for a subset of one or more line items in an order.

Currently, only full orders are eligible for cancellation, so the value returned here should be FULL_ORDER.
See the Field Index to learn which calls use partialOrderType.

paymentStatus ( PaymentStatusEnum ) [0..?]
The value returned in this field will indicate whether or not the buyer has paid for the order that is being cancelled or considered for cancellation.
See the Field Index to learn which calls use paymentStatus.

payoutRecoupInfo ( PayoutRecoupInfo ) [0..?]
This container shows the payout ID and payout amount associated with a paid order that is being cancelled or considered for cancellation. It will not be returned for unpaid orders.

The payout amount data includes the sale price in the seller's currency, and if any currency conversion was necessary, it will also show the amount, currency, and exchange rate used for conversion.
See the Field Index to learn which calls use payoutRecoupInfo.

refundInfo ( RefundInfo ) [0..?]
This container provides detailed information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order.
See the Field Index to learn which calls use refundInfo.

requestorType ( PartyEnum ) [0..?]
The enumeration value returned here indicates who initiated the order cancellation request (either the buyer or seller).
See the Field Index to learn which calls use requestorType.

requestRefundAmount ( Amount ) [0..?]
This container shows the amount of the refund that the buyer is expecting to receive if the order is successfully cancelled.

The monetary amount indicated here is typically the full amount that the buyer paid for the order, including the item price and shipping fees.

The information returned also includes any currency conversion information (as necessary), the current currency code, the value in the original currency, and the original currency's code.
See the Field Index to learn which calls use requestRefundAmount.

sellerLoginName ( string ) [0..?]
The eBay username of the seller involved in the order cancellation request.
See the Field Index to learn which calls use sellerLoginName.

sellerResponseDueDate ( DateTime ) [0..?]
The timestamp in this container indicates the time by which the seller is required to respond to an active order cancellation request.

This container is not returned if the order cancellation request does not currently require a response from the seller.
See the Field Index to learn which calls use sellerResponseDueDate.

shipmentDate ( DateTime ) [0..?]
The timestamp in this container indicates the time when the seller shipped the order (or a line item within the order) that the buyer is attempting to cancel.

Once a seller ships one or more line items within an order, the order is no longer eligible for cancellation. This container is only applicable and returned if the seller shipped one or more line items in order, thus making it impossible for the order cancellation request to be granted.
See the Field Index to learn which calls use shipmentDate.