Changes since
the last release

com.ebay.sdk.call
Class GetShippingDiscountProfilesCall

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

public class GetShippingDiscountProfilesCall
extends ApiCall

Wrapper class of the GetShippingDiscountProfiles 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: ReturnedCurrencyID - The three-digit code of the currency to be used for shipping cost discounts and insurance for Combined Invoice orders. A discount profile can only be associated with a listing if the CurrencyID value of the profile matches the Item.Currency value specified in a listing.
Output property: ReturnedFlatShippingDiscount - Details of an individual discount profile defined by the user for flat rate shipping--one for each profile defined by the user. Empty if no shipping discount profiles were defined.
Output property: ReturnedCalculatedShippingDiscount - Details of an individual discount profile defined by the user for calculated shipping--one for each profile defined by the user. Empty if no shipping discount profiles were defined.
Output property: ReturnedPromotionalShippingDiscount - Indicates whether the user defined a promotional discount (the discount is active as soon as it exists).
Output property: ReturnedCalculatedHandlingDiscount - This container consists of details related to how the seller may have specified/modified packaging and handling discounts that are applied for Combined Invoice orders. This container is only returned if it is set for the Shipping Discount Profile.
Output property: ReturnedPromotionalShippingDiscountDetails - The data for the specific promotional shipping discount. Returned only if it has been defined.
Output property: ReturnedShippingInsurance - The data for the domestic insurance for combined payment. Returned only if it has been defined.
Output property: ReturnedInternationalShippingInsurance - The data for the international insurance for combined payment. Returned only if it has been defined.
Output property: ReturnedCombinedDuration - This field indicates the number of days after the sale of an item in which the buyer or seller can combine multiple and mutual order line items into one Combined Invoice order. In a Combined Invoice order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Invoice order.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetShippingDiscountProfilesCall()
          Constructor.
GetShippingDiscountProfilesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 CalculatedHandlingDiscountType getReturnedCalculatedHandlingDiscount()
          Valid after executing the API.
 CalculatedShippingDiscountType getReturnedCalculatedShippingDiscount()
          Valid after executing the API.
 CombinedPaymentPeriodCodeType getReturnedCombinedDuration()
          Valid after executing the API.
 CurrencyCodeType getReturnedCurrencyID()
          Valid after executing the API.
 FlatShippingDiscountType getReturnedFlatShippingDiscount()
          Valid after executing the API.
 ShippingInsuranceType getReturnedInternationalShippingInsurance()
          Valid after executing the API.
 Boolean getReturnedPromotionalShippingDiscount()
          Valid after executing the API.
 PromotionalShippingDiscountDetailsType getReturnedPromotionalShippingDiscountDetails()
          Valid after executing the API.
 ShippingInsuranceType getReturnedShippingInsurance()
          Valid after executing the API.
 CurrencyCodeType getShippingDiscountProfiles()
          Returns the shipping discount profiles defined by the user, along with other Combined Invoice-related details such as packaging and handling costs.
 
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

GetShippingDiscountProfilesCall

public GetShippingDiscountProfilesCall()
Constructor.


GetShippingDiscountProfilesCall

public GetShippingDiscountProfilesCall(ApiContext apiContext)
Constructor.

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

getShippingDiscountProfiles

public CurrencyCodeType getShippingDiscountProfiles()
                                             throws ApiException,
                                                    SdkException,
                                                    Exception
Returns the shipping discount profiles defined by the user, along with other Combined Invoice-related details such as packaging and handling costs.

Returns:
The CurrencyCodeType object.
Throws:
ApiException
SdkException
Exception

getReturnedCalculatedHandlingDiscount

public CalculatedHandlingDiscountType getReturnedCalculatedHandlingDiscount()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedCalculatedHandlingDiscount.

Returns:
CalculatedHandlingDiscountType

getReturnedCalculatedShippingDiscount

public CalculatedShippingDiscountType getReturnedCalculatedShippingDiscount()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedCalculatedShippingDiscount.

Returns:
CalculatedShippingDiscountType

getReturnedCombinedDuration

public CombinedPaymentPeriodCodeType getReturnedCombinedDuration()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedCombinedDuration.

Returns:
CombinedPaymentPeriodCodeType

getReturnedCurrencyID

public CurrencyCodeType getReturnedCurrencyID()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedCurrencyID.

Returns:
CurrencyCodeType

getReturnedFlatShippingDiscount

public FlatShippingDiscountType getReturnedFlatShippingDiscount()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedFlatShippingDiscount.

Returns:
FlatShippingDiscountType

getReturnedInternationalShippingInsurance

public ShippingInsuranceType getReturnedInternationalShippingInsurance()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedInternationalShippingInsurance.

Returns:
ShippingInsuranceType

getReturnedPromotionalShippingDiscount

public Boolean getReturnedPromotionalShippingDiscount()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedPromotionalShippingDiscount.

Returns:
Boolean

getReturnedPromotionalShippingDiscountDetails

public PromotionalShippingDiscountDetailsType getReturnedPromotionalShippingDiscountDetails()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedPromotionalShippingDiscountDetails.

Returns:
PromotionalShippingDiscountDetailsType

getReturnedShippingInsurance

public ShippingInsuranceType getReturnedShippingInsurance()
Valid after executing the API. Gets the returned GetShippingDiscountProfilesResponseType.returnedShippingInsurance.

Returns:
ShippingInsuranceType

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.