eBay Post-Order APIVersion 2

CancelSummary

This complex type describes an order cancellation.

Type that uses CancelSummary:

Call that uses CancelSummary:

Fields



buyerResponseDueDate ( DateTime ) [0..?]
A timestamp that indicates when 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 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 cancelSummary 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 (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.

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

Note: This is the value of the OrderId field returned by the Trading API's GetOrders call.

See the Field Index to learn which calls use legacyOrderId.

marketplaceId ( MarketplaceIdEnum ) [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.

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.

requestorType ( token ) [0..?]
The party who made the initial cancellation request (either the buyer or the seller).
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. This is typically be the full amount that the buyer paid for the order, including the item price and shipping fees. The returned information 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.

sellerResponseDueDate ( DateTime ) [0..?]
A timestamp that indicates when 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 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, it is too late for the order to be canceled. 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.

state ( 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 events and the appropriate actions you can take.
See the Field Index to learn which calls use state.

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