com.ebay.sdk.call.GetSellerDashboardCall Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation
This SDK enables you to use Java to make API calls in the eBay Trading API, which is an XML API. This maven build is provided by tonicsoft for convenience and is an exact copy of version 981 of the project distributed by eBay via the official eBay SDK website.
The newest version!
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent  version 
thereof released by eBay.  The then-current version of the License can be found 
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that 
is under the root directory at /LICENSE.txt.
*/

package com.ebay.sdk.call;


import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * 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 element 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 - Provides information about the PowerSeller discount level you have earned,
 * if any. As a PowerSeller, you can earn discounts on your monthly invoice
 * Final Value Fees based on how well you're rated as a seller. Only returned
 * for members of the eBay US or Canada PowerSeller program.
 * 
 Output property: ReturnedPowerSellerStatus - Provides information about your PowerSeller status, such as whether or not
 * you meet the PowerSeller requirements. Your PowerSeller status directly
 * affects your discount (SellerFeeDiscount).
 * 


 * For eBay Germany and France, you must be a registered business seller to
 * see your PowerSeller status.
 * 
 Output property: ReturnedPolicyCompliance - This container is no longer returned in GetSellerDashboard.
 * 
 Output property: ReturnedBuyerSatisfaction - Rates your level of customer service. This information helps you to keep
 * track of how well you are providing members with positive buying
 * experiences.
 * 


 * This element is not returned for all sites. 
 * 
 Output property: ReturnedSellerAccount - The status of your latest eBay invoice. Includes any alerts issued to your
 * account to help you identify possible problems.
 * 
 Output property: ReturnedPerformance - Provides information about the seller's performance within different eBay
 * regions. A seller's performance rating can be Top-Rated, Above Standard,
 * Standard, and Below Standard.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetSellerDashboardCall extends com.ebay.sdk.ApiCall
{
  
  private SearchStandingDashboardType returnedSearchStanding=null;
  private SellerFeeDiscountDashboardType returnedSellerFeeDiscount=null;
  private PowerSellerDashboardType returnedPowerSellerStatus=null;
  private PolicyComplianceDashboardType returnedPolicyCompliance=null;
  private BuyerSatisfactionDashboardType returnedBuyerSatisfaction=null;
  private SellerAccountDashboardType returnedSellerAccount=null;
  private PerformanceDashboardType[] returnedPerformance=null;


  /**
   * Constructor.
   */
  public GetSellerDashboardCall() {
  }

  /**
   * Constructor.
   * @param apiContext The ApiContext object to be used to make the call.
   */
  public GetSellerDashboardCall(ApiContext apiContext) {
    super(apiContext);
    

  }

  /**
   * Retrieves a brief summary of the requester's status as an eBay seller.
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The SearchStandingDashboardType object.
   */
  public SearchStandingDashboardType getSellerDashboard()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetSellerDashboardRequestType req;
    req = new GetSellerDashboardRequestType();

    GetSellerDashboardResponseType resp = (GetSellerDashboardResponseType) execute(req);

    this.returnedSearchStanding = resp.getSearchStanding();
    this.returnedSellerFeeDiscount = resp.getSellerFeeDiscount();
    this.returnedPowerSellerStatus = resp.getPowerSellerStatus();
    this.returnedPolicyCompliance = resp.getPolicyCompliance();
    this.returnedBuyerSatisfaction = resp.getBuyerSatisfaction();
    this.returnedSellerAccount = resp.getSellerAccount();
    this.returnedPerformance = resp.getPerformance();
    return this.getReturnedSearchStanding();
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellerDashboardResponseType.returnedBuyerSatisfaction.
   * 
   * @return BuyerSatisfactionDashboardType
   */
  public BuyerSatisfactionDashboardType getReturnedBuyerSatisfaction()
  {
    return this.returnedBuyerSatisfaction;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellerDashboardResponseType.returnedPerformance.
   * 
   * @return PerformanceDashboardType[]
   */
  public PerformanceDashboardType[] getReturnedPerformance()
  {
    return this.returnedPerformance;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellerDashboardResponseType.returnedPolicyCompliance.
   * 
   * @return PolicyComplianceDashboardType
   */
  public PolicyComplianceDashboardType getReturnedPolicyCompliance()
  {
    return this.returnedPolicyCompliance;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellerDashboardResponseType.returnedPowerSellerStatus.
   * 
   * @return PowerSellerDashboardType
   */
  public PowerSellerDashboardType getReturnedPowerSellerStatus()
  {
    return this.returnedPowerSellerStatus;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellerDashboardResponseType.returnedSearchStanding.
   * 
   * @return SearchStandingDashboardType
   */
  public SearchStandingDashboardType getReturnedSearchStanding()
  {
    return this.returnedSearchStanding;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellerDashboardResponseType.returnedSellerAccount.
   * 
   * @return SellerAccountDashboardType
   */
  public SellerAccountDashboardType getReturnedSellerAccount()
  {
    return this.returnedSellerAccount;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellerDashboardResponseType.returnedSellerFeeDiscount.
   * 
   * @return SellerFeeDiscountDashboardType
   */
  public SellerFeeDiscountDashboardType getReturnedSellerFeeDiscount()
  {
    return this.returnedSellerFeeDiscount;
  }

}