eBay Post-Order APIVersion 2.7.2
 

ItemEligibilityResult

This type is used to indicate whether or not an order line item is eligible to be cancelled. 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 quantity of the specified order line item that is being cancelled.

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

eligible ( boolean ) [0..?]
If the value of this field is returned as true, the corresponding 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 corresponding orderEligibilityResult.eligible field is also true. However, if the value of the orderEligibilityResult.eligible field 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 string ) [0..?]
An array of one or more reasons why a line item has been found to be ineligible for cancellation. This array is only returned if the value of the itemEligibilityResult.eligible field is false.

The full list of reasons why an order may not be eligible for cancellation can be found in the EligibilityFailureReasonEnum type definition.
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.