eBay Post-Order APIVersion 2.6

ItemEligibilityResult

Type used to indicate whether or not an order line item is eligible to be canceled. An itemEligibilityResult container is returned for each line item in the order.

Type that uses ItemEligibilityResult:

Calls that use ItemEligibilityResult:

Fields



cancelQuantity ( integer ) [0..?]
The number of items from the specified line item that are being canceled from the order.

This value must be equal-to or less-than the quantity of items ordered on the specified line item of the order.
See the Field Index to learn which calls use cancelQuantity.

eligible ( boolean ) [0..?]
When set to true, the identified line item is eligible for cancellation.

The value of this field should always be true for all line items in the order if the value of the orderEligibilityResult.eligible is also true. However, if the value of the orderEligibilityResult.eligible is false, it is possible that some line items in the order may be eligible for cancellation, but other line items may not be eligible.
See the Field Index to learn which calls use eligible.

failureReason ( array of token ) [0..?]
A list containing one or more reasons why a line item has been found ineligible for cancellation. This field repeats for each applicable failure reason.

This field is not returned if the value of the itemEligibilityResult.eligible field is true.
See the Field Index to learn which calls use failureReason.

itemId ( string ) [0..?]
The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order.
See the Field Index to learn which calls use itemId.

transactionId ( string ) [0..?]
The unique identifier for the purchase of the item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order.
See the Field Index to learn which calls use transactionId.