Changes since
the last release

com.ebay.sdk.call
Class GetSellerDashboardCall

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

public class GetSellerDashboardCall
extends ApiCall

Wrapper class of the GetSellerDashboard 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.


Output property: ReturnedSearchStanding - Provides information about the visibility level you have earned for your listings. The higher your search standing rating, the higher your items will be placed in search results sorted by Best Match. Because your search standing rating is directly tied to your customer service record, this rating is an important way that eBay rewards you as a good seller--it encourages you to give buyers the best possible shopping experience.

This field is returned only for the following sites.

Site Id
AU 15
BEFR 23
BENL 123
CA 2
ES 186
FR 71
IN 203
IT 101
MOTORS 100
NL 146
PL 212

Output property: ReturnedSellerFeeDiscount - This container provides the percentage discount that the seller is eligible to receive on the Final Value Fee for each order line item. Top Rated Sellers may be eligible for Final Value Fee discounts if their listings meet all requirements for the discount.
Output property: ReturnedPowerSellerStatus - This container provides the seller's PowerSeller status, as well as any informational alerts related to the seller's PowerSeller status. If the seller has not achieved Power Seller status, a value of None will be returned in the PowerSellerStatus.Level field. A PowerSellerStatus.Alert container will only be returned if there is an alert/message related to the seller's PowerSeller status.

For eBay Germany and France, you must be a registered business seller to see your Power Seller status.
Output property: ReturnedPolicyCompliance - This container is no longer returned in GetSellerDashboard.
Output property: ReturnedBuyerSatisfaction - This container provides the seller's Buyer Satisfaction status, as well as any informational alerts related to the seller's Buyer Satisfaction status. A BuyerSatisfaction.Alert container will only be returned if there is an alert/message related to the seller's Buyer Satisfaction status.

This field is not returned for all sites.
Output property: ReturnedSellerAccount - This container provides the seller's account status, as well as any informational alerts related to the seller's account status. A seller's account status can either be 'current' (all selling fees paid), 'past due' (seller is late paying selling fees), or 'on hold' (seller will be blocked from listing and is in danger of being suspended until selling fees are brought current). A SellerAccount.Alert container will only be returned if there is an alert/message related to the seller's account status.
Output property: ReturnedPerformance - This container provides the seller's performance level, as well as any informational alerts related to the seller's performance level. A Performance.Alert container will only be returned if there is an alert/message related to the seller's performance level.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSellerDashboardCall()
          Constructor.
GetSellerDashboardCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 BuyerSatisfactionDashboardType getReturnedBuyerSatisfaction()
          Valid after executing the API.
 PerformanceDashboardType[] getReturnedPerformance()
          Valid after executing the API.
 PolicyComplianceDashboardType getReturnedPolicyCompliance()
          Valid after executing the API.
 PowerSellerDashboardType getReturnedPowerSellerStatus()
          Valid after executing the API.
 SearchStandingDashboardType getReturnedSearchStanding()
          Valid after executing the API.
 SellerAccountDashboardType getReturnedSellerAccount()
          Valid after executing the API.
 SellerFeeDiscountDashboardType getReturnedSellerFeeDiscount()
          Valid after executing the API.
 SearchStandingDashboardType getSellerDashboard()
          The base request type for the GetSellerDashboard call.
 
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

GetSellerDashboardCall

public GetSellerDashboardCall()
Constructor.


GetSellerDashboardCall

public GetSellerDashboardCall(ApiContext apiContext)
Constructor.

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

getSellerDashboard

public SearchStandingDashboardType getSellerDashboard()
                                               throws ApiException,
                                                      SdkException,
                                                      Exception
The base request type for the GetSellerDashboard call. This call retrieves seller performance data, including seller standards level, Power Seller status, Buyer Satisfaction status, eBay Search standing, and any seller fee discounts.

Returns:
The SearchStandingDashboardType object.
Throws:
ApiException
SdkException
Exception

getReturnedBuyerSatisfaction

public BuyerSatisfactionDashboardType getReturnedBuyerSatisfaction()
Valid after executing the API. Gets the returned GetSellerDashboardResponseType.returnedBuyerSatisfaction.

Returns:
BuyerSatisfactionDashboardType

getReturnedPerformance

public PerformanceDashboardType[] getReturnedPerformance()
Valid after executing the API. Gets the returned GetSellerDashboardResponseType.returnedPerformance.

Returns:
PerformanceDashboardType[]

getReturnedPolicyCompliance

public PolicyComplianceDashboardType getReturnedPolicyCompliance()
Valid after executing the API. Gets the returned GetSellerDashboardResponseType.returnedPolicyCompliance.

Returns:
PolicyComplianceDashboardType

getReturnedPowerSellerStatus

public PowerSellerDashboardType getReturnedPowerSellerStatus()
Valid after executing the API. Gets the returned GetSellerDashboardResponseType.returnedPowerSellerStatus.

Returns:
PowerSellerDashboardType

getReturnedSearchStanding

public SearchStandingDashboardType getReturnedSearchStanding()
Valid after executing the API. Gets the returned GetSellerDashboardResponseType.returnedSearchStanding.

Returns:
SearchStandingDashboardType

getReturnedSellerAccount

public SellerAccountDashboardType getReturnedSellerAccount()
Valid after executing the API. Gets the returned GetSellerDashboardResponseType.returnedSellerAccount.

Returns:
SellerAccountDashboardType

getReturnedSellerFeeDiscount

public SellerFeeDiscountDashboardType getReturnedSellerFeeDiscount()
Valid after executing the API. Gets the returned GetSellerDashboardResponseType.returnedSellerFeeDiscount.

Returns:
SellerFeeDiscountDashboardType

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.