eBay Post-Order APIVersion 2.6

CancelDetail

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

Get this return object by setting the fieldgroups query parameter of your search request to FULL. The detailed response includes information about each activity performed on the cancellation request, plus a list of all the line items associated with the cancellation request.

Type that uses CancelDetail:

Call that uses CancelDetail:

Fields



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

buyerLoginName ( string ) [0..?]
The eBay-assigned username of the account that represents the buyer in the transaction.
See the Field Index to learn which calls use buyerLoginName.

buyerResponseDueDate ( DateTime ) [0..?]
A timestamp that indicates the time by which the buyer is required to respond to an active cancellation request. This container is not returned if the 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 cancellation request was closed. This field is only applicable and returned when the cancellation request is closed (regardless of outcome).
See the Field Index to learn which calls use cancelCloseDate.

cancelCloseReason ( token ) [0..?]
The reason why the cancel request was closed. This field is only applicable and returned if the cancellation request was closed or if the buyer attempted to close the cancellation request.
See the Field Index to learn which calls use cancelCloseReason.

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

cancelReason ( token ) [0..?]
The reason why the user (either the buyer or seller, as defined in the requestorType field) initiated the cancellation request.
See the Field Index to learn which calls use cancelReason.

cancelRequestDate ( DateTime ) [0..?]
A timestamp that indicates when the cancellation request was created.
See the Field Index to learn which calls use cancelRequestDate.

cancelState ( token ) [0..?]
The current stage 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.
See the Field Index to learn which calls use cancelState.

cancelStatus ( token ) [0..?]
The last action taken by one of the parties associated with the cancellation.

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.
See the Field Index to learn which calls use cancelStatus.

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

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.

marketplaceId ( token ) [0..?]
A unique eBay-assigned ID for the eBay marketplace where the cancellation was created.
See the Field Index to learn which calls use marketplaceId.

moneyMovementInfo ( array of can:MoneyMovementDetailType ) [0..?]
This container consists of detailed information on a money movement transaction. A moneyMovementInfo container is returned for each separate money movement transaction.

Note: If the seller is opted in to eBay managed payments, additional refund information for the cancelled order is shown in the refundInfo container.
See the Field Index to learn which calls use moneyMovementInfo.

partialOrderType ( token ) [0..?]
This value indicates whether the cancellation is for either a full or partial order.

Currently, only full orders are eligible for cancellation.
See the Field Index to learn which calls use partialOrderType.

paymentStatus ( token ) [0..?]
The current status of the buyer's payment for the order that is being canceled or considered for cancellation.
See the Field Index to learn which calls use paymentStatus.

payoutRecoupInfo ( PayoutRecoupInfo ) [0..?]
Defines the monetary amount of a payout.

Payout amount data includes the sale price in the original currency with it's currency code, and any currency conversion information (as necessary), which includes the current currency code.
See the Field Index to learn which calls use payoutRecoupInfo.

refundInfo ( RefundInfo ) [0..?]
This container provides more information about a refund that was issued, or is scheduled to be issued for a cancelled order.

This container is only returned if the order's seller is opted in to eBay managed payments. If the seller is not opted in to eBay managed payments, the refund information for the cancelled order is shown in a moneyMovementInfo node instead.
See the Field Index to learn which calls use refundInfo.

requestorType ( token ) [0..?]
The reason why the user (either the buyer or the seller, as defined in the requestorType field) initiated the cancellation request.
See the Field Index to learn which calls use requestorType.

requestRefundAmount ( Amount ) [0..?]
The amount of the refund that the buyer is expecting to receive if the order is successfully canceled.

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-assigned username of the account that represents the seller in the transaction.
See the Field Index to learn which calls use sellerLoginName.

sellerResponseDueDate ( DateTime ) [0..?]
A timestamp that indicates the time by which the seller is required to respond to an active cancellation request.

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

shipmentDate ( DateTime ) [0..?]
A timestamp that 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 cancel request to be granted.
See the Field Index to learn which calls use shipmentDate.