Changes since
the last release

com.ebay.sdk.call
Class AddDisputeCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.AddDisputeCall

public class AddDisputeCall
extends ApiCall

Wrapper class of the AddDispute call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: DisputeExplanation - 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.
Input property: DisputeReason - 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.
Input property: ItemID - Unique identifier of an eBay item 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.

Input property: TransactionID - 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.

Input property: OrderLineItemID - OrderLineItemID is a unique identifier of an order line item, and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. 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.

Output property: ReturnedDisputeID - This field will show the unique identifier of an Unpaid Item case that was created, or the unique identifier of the order cancellation.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddDisputeCall()
          Constructor.
AddDisputeCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 String addDispute()
          Enables a seller to create an Unpaid Item case against a buyer, or to cancel a single line item order.
 DisputeExplanationCodeType getDisputeExplanation()
          Gets the AddDisputeRequestType.disputeExplanation.
 DisputeReasonCodeType getDisputeReason()
          Gets the AddDisputeRequestType.disputeReason.
 String getItemID()
          Gets the AddDisputeRequestType.itemID.
 String getOrderLineItemID()
          Gets the AddDisputeRequestType.orderLineItemID.
 String getReturnedDisputeID()
          Valid after executing the API.
 String getTransactionID()
          Gets the AddDisputeRequestType.transactionID.
 void setDisputeExplanation(DisputeExplanationCodeType disputeExplanation)
          Sets the AddDisputeRequestType.disputeExplanation.
 void setDisputeReason(DisputeReasonCodeType disputeReason)
          Sets the AddDisputeRequestType.disputeReason.
 void setItemID(String itemID)
          Sets the AddDisputeRequestType.itemID.
 void setOrderLineItemID(String orderLineItemID)
          Sets the AddDisputeRequestType.orderLineItemID.
 void setTransactionID(String transactionID)
          Sets the AddDisputeRequestType.transactionID.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddDisputeCall

public AddDisputeCall()
Constructor.


AddDisputeCall

public AddDisputeCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

addDispute

public String addDispute()
                  throws ApiException,
                         SdkException,
                         Exception
Enables a seller to create an Unpaid Item case against a buyer, or to cancel a single line item order. 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. 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.

Returns:
The String object.
Throws:
ApiException
SdkException
Exception

getDisputeExplanation

public DisputeExplanationCodeType getDisputeExplanation()
Gets the AddDisputeRequestType.disputeExplanation.

Returns:
DisputeExplanationCodeType

setDisputeExplanation

public void setDisputeExplanation(DisputeExplanationCodeType disputeExplanation)
Sets the AddDisputeRequestType.disputeExplanation.

Parameters:
disputeExplanation - DisputeExplanationCodeType

getDisputeReason

public DisputeReasonCodeType getDisputeReason()
Gets the AddDisputeRequestType.disputeReason.

Returns:
DisputeReasonCodeType

setDisputeReason

public void setDisputeReason(DisputeReasonCodeType disputeReason)
Sets the AddDisputeRequestType.disputeReason.

Parameters:
disputeReason - DisputeReasonCodeType

getItemID

public String getItemID()
Gets the AddDisputeRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the AddDisputeRequestType.itemID.

Parameters:
itemID - String

getOrderLineItemID

public String getOrderLineItemID()
Gets the AddDisputeRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

public void setOrderLineItemID(String orderLineItemID)
Sets the AddDisputeRequestType.orderLineItemID.

Parameters:
orderLineItemID - String

getTransactionID

public String getTransactionID()
Gets the AddDisputeRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(String transactionID)
Sets the AddDisputeRequestType.transactionID.

Parameters:
transactionID - String

getReturnedDisputeID

public String getReturnedDisputeID()
Valid after executing the API. Gets the returned AddDisputeResponseType.returnedDisputeID.

Returns:
String

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.