eBay Post-Order APIVersion 2

OrderEligibilityResult

A complex type that describes whether or not the order, or the order's line items, is eligible to be canceled.

Type that uses OrderEligibilityResult:

Calls that use OrderEligibilityResult:

Fields



eligible ( boolean ) [0..?]
If set to true, this order is eligible to be canceled. If false, this order is not eligible to be canceled.
See the Field Index to learn which calls use eligible.

eligibleCancelReason ( array of token ) [0..?]
A list of one or more reasons that a buyer or seller can give for canceling this order. This field is returned only if the value of the eligible field is true. The two enumeration values that are specifically for sellers are BUYER_CANCEL_OR_ADDRESS_ISSUE and OUT_OF_STOCK_OR_CANNOT_FULFILL.
See the Field Index to learn which calls use eligibleCancelReason.

failureReason ( array of EligibilityFailureReasonEnum ) [0..?]
A list of one or more reasons why this order has been found ineligible for cancellation. This field is returned only if the value of the eligible field is false. This field repeats for each applicable failure reason.
See the Field Index to learn which calls use failureReason.

itemEligibilityResult ( array of ItemEligibilityResult ) [0..?]
This array contains information indicating whether each of the order's line items is eligible to be canceled.

An itemEligibilityResult container is returned for each line item in the order. The itemId and transactionId pair identify each line item.

Because cancellations happen at the order level, if the orderEligibilityResult.eligible value is true, the itemEligibilityResult.eligible value for each line item should also be true. However, if the orderEligibilityResult.eligible value is false, some itemEligibilityResult.eligible values may be true and others may be false (in a multiple line item order).
See the Field Index to learn which calls use itemEligibilityResult.

legacyOrderId ( string ) [0..?]
A unique eBay-assigned ID for the order being 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.