eBay Trading APIVersion 1119

AddDisputeRequestType ( AbstractRequestType )

Enables a seller to create an Unpaid Item case against a buyer, or to cancel a single line item order.

Although the seller is eligible to open up an Unpaid Item case two days after the buyer purchases the item or wins the item through an auction, it is recommended that the seller contacts the buyer first to try and make it right before opening a case. The Unpaid Items help page talks more about how a seller should to handle an unpaid item.

To cancel a multiple line item order programmatically, the seller would have to use the POST /post-order/v2/cancellation call of the Post-Order API.

Call that uses AddDisputeRequestType:

Fields



DisputeExplanation ( DisputeExplanationCodeType ) [0..1]
This enumerated value gives the explanation of why the seller opened a case (or why seller canceled a single line item order). Not all values contained in DisputeExplanationCodeType are allowed in the AddDispute call, and the values that are allowed must match the DisputeReason value.
See the Field Index to learn which calls use DisputeExplanation.

DisputeReason ( DisputeReasonCodeType ) [0..1]
The enumeration value passed into this required field will depend on the action being taken. The seller will pass in BuyerHasNotPaid if the seller is creating an Unpaid Item case against the buyer, or TransactionMutuallyCanceled if the seller is cancelling a single line item order at the request of the buyer, or if the seller has ran out of stock on the item or otherwise cannot fulfill the order.
See the Field Index to learn which calls use DisputeReason.

ItemID ( ItemIDType (string) ) [0..1]
Unique identifier of an eBay listing. To identify a specific order line item, either an ItemID/TransactionID pair or an OrderLineItemID value must be passed in the request. So, unless OrderLineItemID is used, this field is required.
See the Field Index to learn which calls use ItemID.

OrderLineItemID ( string ) [0..1]
OrderLineItemID is a unique identifier of an order line item. To identify a specific order line item, either an ItemID/TransactionID pair or an OrderLineItemID value must be passed in the request. So, unless ItemID/TransactionID pair is used, this field is required.
See the Field Index to learn which calls use OrderLineItemID.

TransactionID ( string ) [0..1]
The unique identifier of a buyer's purchase. A TransactionID is created by eBay once a buyer purchases the item through a fixed-priced listing or by using the Buy It Now feature in an auction listing, or when an auction listing ends with a winning bidder. To identify a specific order line item, either an ItemID/TransactionID pair or an OrderLineItemID value must be passed in the request. So, unless OrderLineItemID is used, this field is required.
See the Field Index to learn which calls use TransactionID.