|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.AddDisputeCall
public class AddDisputeCall
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.
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.
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.
ItemID
- 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.
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.
OrderLineItemID
- 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.
ReturnedDisputeID
- This field will show the unique identifier of an Unpaid Item case that was created, or the unique identifier of the order cancellation.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
AddDisputeCall()
Constructor. |
|
AddDisputeCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.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. |
java.lang.String |
getItemID()
Gets the AddDisputeRequestType.itemID. |
java.lang.String |
getOrderLineItemID()
Gets the AddDisputeRequestType.orderLineItemID. |
java.lang.String |
getReturnedDisputeID()
Valid after executing the API. |
java.lang.String |
getTransactionID()
Gets the AddDisputeRequestType.transactionID. |
void |
setDisputeExplanation(DisputeExplanationCodeType disputeExplanation)
Sets the AddDisputeRequestType.disputeExplanation. |
void |
setDisputeReason(DisputeReasonCodeType disputeReason)
Sets the AddDisputeRequestType.disputeReason. |
void |
setItemID(java.lang.String itemID)
Sets the AddDisputeRequestType.itemID. |
void |
setOrderLineItemID(java.lang.String orderLineItemID)
Sets the AddDisputeRequestType.orderLineItemID. |
void |
setTransactionID(java.lang.String transactionID)
Sets the AddDisputeRequestType.transactionID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AddDisputeCall()
public AddDisputeCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public java.lang.String addDispute() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public DisputeExplanationCodeType getDisputeExplanation()
public void setDisputeExplanation(DisputeExplanationCodeType disputeExplanation)
disputeExplanation
- DisputeExplanationCodeTypepublic DisputeReasonCodeType getDisputeReason()
public void setDisputeReason(DisputeReasonCodeType disputeReason)
disputeReason
- DisputeReasonCodeTypepublic java.lang.String getItemID()
public void setItemID(java.lang.String itemID)
itemID
- Stringpublic java.lang.String getOrderLineItemID()
public void setOrderLineItemID(java.lang.String orderLineItemID)
orderLineItemID
- Stringpublic java.lang.String getTransactionID()
public void setTransactionID(java.lang.String transactionID)
transactionID
- Stringpublic java.lang.String getReturnedDisputeID()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.