Changes since
the last release

com.ebay.sdk.call
Class LeaveFeedbackCall

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

public class LeaveFeedbackCall
extends ApiCall

Wrapper class of the LeaveFeedback 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: FeedbackDetail - Helper wrapper to set LeaveFeedbackRequestType CommentText, CommentType, ItemID: CommentText sets LeaveFeedbackRequestType.CommentText: Textual comment that explains, clarifies, or justifies the feedback score specified in CommentType. CommentType sets LeaveFeedbackRequestType.CommentType: Score for the Feedback being left. May be Positive, Neutral, or Negative.

Note: Sellers can not leave neutral or negative feedback for buyers. In addition, buyers can not leave neutral or negative feedback within 7 days from the completion of the order for active Power Sellers who have been on eBay for 12 months. ItemID sets LeaveFeedbackRequestType.ItemID: Unique identifier for an eBay item listing. A listing can have multiple order line items, but only one ItemID. Unless an OrderLineItemID is specified in the LeaveFeedback request, the ItemID is required along with the TargetUser to identify an order line item existing between the caller and the TargetUser that requires feedback. A Feedback comment will be posted for this order line item. If there are multiple order line items between the two order partners that still require feedback, the TransactionID will also be required to isolate the targeted order line item. Feedback cannot be left for order line items with creation dates more than 60 days in the past.
Input property: TransactionID - Unique identifier for an eBay order line item. If there are multiple order line items between the two order partners that still require Feedback, the TransactionID is required along with the corresponding ItemID and TargetUser to isolate the targeted order line item. If an OrderLineItemID is included in the response to identify a specific order line item, none of the preceding fields (ItemID, TransactionID, TargetUser) are needed. Feedback cannot be left for order line items with creation dates more than 60 days in the past.
Input property: TargetUser - Specifies the recipient user about whom the Feedback is being left.
Input property: SellerItemRatingDetailArray - Container for detailed seller ratings (DSRs). If a buyer is providing DSRs, they are specified in this container. Sellers have access to the number of ratings they've received, as well as to the averages of the DSRs they've received in each DSR area (i.e., to the average of ratings in the item-description area, etc.).
Input property: OrderLineItemID - OrderLineItemID is a unique identifier for an eBay order line item and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. If an OrderLineItemID is included in the request, the ItemID, TransactionID, and TargetUser fields are not required. Feedback cannot be left for order line items with creation dates more than 60 days in the past.

Input property: ItemArrivedWithinEDDType - This field or the ItemDeliveredWithinEDD field should be included if it is the buyer leaving feedback for the seller. This field will inform eBay about whether or not the buyer received the order line item within the estimated delivery date, which is established once a buyer purchases or commits to buy an item.

Note: A new "Late shipment rate" metric became a new component of Seller Standards beginning in February 2016. On-time shipping means that the seller shipped the item before the "handling time" expired and/or the item was received by the buyer within the estimated delivery date window, which is established once the buyer pays for the order line item. Previously, a seller's account could be dinged just for getting a low rating for the "shippping time" Detailed Seller Rating.
Input property: ItemDeliveredWithinEDD - This field or the ItemArrivedWithinEDDType field should be included if it is the buyer leaving feedback for the seller. This field will inform eBay about whether or not the buyer received the order line item within the estimated delivery date window, which is established once a buyer purchases or commits to buy an item. The value of this field is set to true if the item did arrive within the estimated delivery date, or false if the item arrived past the estimated delivery date.

Note: A new "Late shipment rate" metric became a new component of Seller Standards beginning in February 2016. On-time shipping means that the seller shipped the item before the "handling time" expired and/or the item was received by the buyer within the estimated delivery date window, which is established once the buyer pays for the order line item. Previously, a seller's account could be dinged just for getting a low rating for the "shippping time" Detailed Seller Rating.
Output property: ReturnedFeedbackID - The unique identifier of the Feedback entry that has been submitted by the caller.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
LeaveFeedbackCall()
          Constructor.
LeaveFeedbackCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 FeedbackDetailType getFeedbackDetail()
          Gets the LeaveFeedbackRequestType.feedbackDetail.
 ItemArrivedWithinEDDCodeType getItemArrivedWithinEDDType()
          Gets the LeaveFeedbackRequestType.itemArrivedWithinEDDType.
 java.lang.Boolean getItemDeliveredWithinEDD()
          Gets the LeaveFeedbackRequestType.itemDeliveredWithinEDD.
 java.lang.String getOrderLineItemID()
          Gets the LeaveFeedbackRequestType.orderLineItemID.
 java.lang.String getReturnedFeedbackID()
          Valid after executing the API.
 ItemRatingDetailArrayType getSellerItemRatingDetailArray()
          Gets the LeaveFeedbackRequestType.sellerItemRatingDetailArray.
 java.lang.String getTargetUser()
          Gets the LeaveFeedbackRequestType.targetUser.
 java.lang.String getTransactionID()
          Gets the LeaveFeedbackRequestType.transactionID.
 void leaveFeedback()
          Enables a buyer and seller to leave Feedback for their order partner at the conclusion of a successful order.
 void setFeedbackDetail(FeedbackDetailType feedbackDetail)
          Sets the LeaveFeedbackRequestType.feedbackDetail.
 void setItemArrivedWithinEDDType(ItemArrivedWithinEDDCodeType itemArrivedWithinEDDType)
          Sets the LeaveFeedbackRequestType.itemArrivedWithinEDDType.
 void setItemDeliveredWithinEDD(java.lang.Boolean itemDeliveredWithinEDD)
          Sets the LeaveFeedbackRequestType.itemDeliveredWithinEDD.
 void setOrderLineItemID(java.lang.String orderLineItemID)
          Sets the LeaveFeedbackRequestType.orderLineItemID.
 void setSellerItemRatingDetailArray(ItemRatingDetailArrayType sellerItemRatingDetailArray)
          Sets the LeaveFeedbackRequestType.sellerItemRatingDetailArray.
 void setTargetUser(java.lang.String targetUser)
          Sets the LeaveFeedbackRequestType.targetUser.
 void setTransactionID(java.lang.String transactionID)
          Sets the LeaveFeedbackRequestType.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, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, 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

LeaveFeedbackCall

public LeaveFeedbackCall()
Constructor.


LeaveFeedbackCall

public LeaveFeedbackCall(ApiContext apiContext)
Constructor.

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

leaveFeedback

public void leaveFeedback()
                   throws ApiException,
                          SdkException,
                          java.lang.Exception
Enables a buyer and seller to leave Feedback for their order partner at the conclusion of a successful order.

Throws:
ApiException
SdkException
java.lang.Exception

getFeedbackDetail

public FeedbackDetailType getFeedbackDetail()
Gets the LeaveFeedbackRequestType.feedbackDetail.

Returns:
FeedbackDetailType

setFeedbackDetail

public void setFeedbackDetail(FeedbackDetailType feedbackDetail)
Sets the LeaveFeedbackRequestType.feedbackDetail.

Parameters:
feedbackDetail - FeedbackDetailType

getItemArrivedWithinEDDType

public ItemArrivedWithinEDDCodeType getItemArrivedWithinEDDType()
Gets the LeaveFeedbackRequestType.itemArrivedWithinEDDType.

Returns:
ItemArrivedWithinEDDCodeType

setItemArrivedWithinEDDType

public void setItemArrivedWithinEDDType(ItemArrivedWithinEDDCodeType itemArrivedWithinEDDType)
Sets the LeaveFeedbackRequestType.itemArrivedWithinEDDType.

Parameters:
itemArrivedWithinEDDType - ItemArrivedWithinEDDCodeType

getItemDeliveredWithinEDD

public java.lang.Boolean getItemDeliveredWithinEDD()
Gets the LeaveFeedbackRequestType.itemDeliveredWithinEDD.

Returns:
Boolean

setItemDeliveredWithinEDD

public void setItemDeliveredWithinEDD(java.lang.Boolean itemDeliveredWithinEDD)
Sets the LeaveFeedbackRequestType.itemDeliveredWithinEDD.

Parameters:
itemDeliveredWithinEDD - Boolean

getOrderLineItemID

public java.lang.String getOrderLineItemID()
Gets the LeaveFeedbackRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

public void setOrderLineItemID(java.lang.String orderLineItemID)
Sets the LeaveFeedbackRequestType.orderLineItemID.

Parameters:
orderLineItemID - String

getSellerItemRatingDetailArray

public ItemRatingDetailArrayType getSellerItemRatingDetailArray()
Gets the LeaveFeedbackRequestType.sellerItemRatingDetailArray.

Returns:
ItemRatingDetailArrayType

setSellerItemRatingDetailArray

public void setSellerItemRatingDetailArray(ItemRatingDetailArrayType sellerItemRatingDetailArray)
Sets the LeaveFeedbackRequestType.sellerItemRatingDetailArray.

Parameters:
sellerItemRatingDetailArray - ItemRatingDetailArrayType

getTargetUser

public java.lang.String getTargetUser()
Gets the LeaveFeedbackRequestType.targetUser.

Returns:
String

setTargetUser

public void setTargetUser(java.lang.String targetUser)
Sets the LeaveFeedbackRequestType.targetUser.

Parameters:
targetUser - String

getTransactionID

public java.lang.String getTransactionID()
Gets the LeaveFeedbackRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(java.lang.String transactionID)
Sets the LeaveFeedbackRequestType.transactionID.

Parameters:
transactionID - String

getReturnedFeedbackID

public java.lang.String getReturnedFeedbackID()
Valid after executing the API. Gets the returned LeaveFeedbackResponseType.returnedFeedbackID.

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.