eBay Post-Order APIVersion 2.6

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, the specified order is eligible to be canceled. If false, the 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_ASKED_CANCEL and OUT_OF_STOCK_OR_CANNOT_FULFILL.
See the Field Index to learn which calls use eligibleCancelReason.

failureReason ( array of token ) [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..?]
A list that indicates 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.

Because cancellations happen at the order level, if the orderEligibilityResult.eligible value is true, the itemEligibilityResult.eligible value for each line item must also be true.

Note it's possible for the orderEligibilityResult.eligible value to return false while some itemEligibilityResult.eligible values return true (and others 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: 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.