eBay Trading APIVersion 1285
 

AddDisputeRequestType ( AbstractRequestType )

Enables a seller to create a cancellation request.

Note: This call is deprecated and is scheduled for decommission on January 31, 2023. The alternative API to create cancellation requests is the Create Cancellation Request method of the Post-Order API .

Call that uses AddDisputeRequestType:

Fields



DisputeExplanation ( DisputeExplanationCodeType ) [0..1]
This enumerated value gives the explanation of why an order is being cancelled. 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]
This enumeration value indicates the reason why the order is being cancelled. The seller should pass in TransactionMutuallyCanceled into this field if both buyer and seller have mutually agreed to cancel the order. Alternatively, if the buyer has not paid for an order within four days after committing to purchase, and the seller has not been able to communicate with the buyer concerning payment and cancellation, the seller can pass in BuyerHasNotPaid into this field.
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 commitment to purchase. A TransactionID is created by eBay once a buyer commits to purchasing an 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 OrderLineItemID is used, this field is required.

The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.
See the Field Index to learn which calls use TransactionID.