Changes since
the last release

com.ebay.sdk.call
Class SetShippingDiscountProfilesCall

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

public class SetShippingDiscountProfilesCall
extends ApiCall

Wrapper class of the SetShippingDiscountProfiles 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: CurrencyID - 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.

Required if the user creates flat rate shipping discount profiles, a promotional discount, a packaging/handling cost profile based on a variable discount rule, or if the user defines shipping insurance range/fee pairs.

Note: There is a currencyID attribute on many elements of SetShippingDiscountProfiles. To avoid an error, be sure to use the same CurrencyID value in each occurrence within the same request.
Input property: CombinedDuration - This field is used to specify 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.
Input property: ModifyActionCode - Indicates what action to take on the specified flat shipping discount, calculated shipping discount or promotional discount. If the action is Delete and if a flat rate or calculated shipping discount profile is specified, the discount profile identified by DiscountProfile.DiscountProfileID is deleted (see DiscountProfile.MappedDiscountProfileID for related details).
Input property: FlatShippingDiscount - Details of a shipping cost discount profile for flat rate shipping. If this is provided, CalculatedShippingDiscount and PromotionalShippingDiscountDetails should be omitted.
Input property: CalculatedShippingDiscount - Details of a shipping cost discount profile for calculated shipping. If this is provided, FlatShippingDiscount and PromotionalShippingDiscountDetails should be omitted.
Input property: CalculatedHandlingDiscount - This container is used by the seller to specify/modify packaging and handling discounts that are applied for Combined Invoice orders.
Input property: PromotionalShippingDiscountDetails - The data for the promotional shipping discount. If this is provided, FlatShippingDiscount and CalculatedShippingDiscount should be omitted.
Input property: ShippingInsurance - Information establishing what fee to apply for domestic shipping insurance for combined payment depending on which range the order item-total price falls into.
Input property: InternationalShippingInsurance - Information establishing what fee to apply for international shipping insurance for combined payment depending on which range the order item-total price falls into.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
SetShippingDiscountProfilesCall()
          Constructor.
SetShippingDiscountProfilesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 CalculatedHandlingDiscountType getCalculatedHandlingDiscount()
          Gets the SetShippingDiscountProfilesRequestType.calculatedHandlingDiscount.
 CalculatedShippingDiscountType getCalculatedShippingDiscount()
          Gets the SetShippingDiscountProfilesRequestType.calculatedShippingDiscount.
 CombinedPaymentPeriodCodeType getCombinedDuration()
          Gets the SetShippingDiscountProfilesRequestType.combinedDuration.
 CurrencyCodeType getCurrencyID()
          Gets the SetShippingDiscountProfilesRequestType.currencyID.
 FlatShippingDiscountType getFlatShippingDiscount()
          Gets the SetShippingDiscountProfilesRequestType.flatShippingDiscount.
 ShippingInsuranceType getInternationalShippingInsurance()
          Gets the SetShippingDiscountProfilesRequestType.internationalShippingInsurance.
 ModifyActionCodeType getModifyActionCode()
          Gets the SetShippingDiscountProfilesRequestType.modifyActionCode.
 PromotionalShippingDiscountDetailsType getPromotionalShippingDiscountDetails()
          Gets the SetShippingDiscountProfilesRequestType.promotionalShippingDiscountDetails.
 ShippingInsuranceType getShippingInsurance()
          Gets the SetShippingDiscountProfilesRequestType.shippingInsurance.
 void setCalculatedHandlingDiscount(CalculatedHandlingDiscountType calculatedHandlingDiscount)
          Sets the SetShippingDiscountProfilesRequestType.calculatedHandlingDiscount.
 void setCalculatedShippingDiscount(CalculatedShippingDiscountType calculatedShippingDiscount)
          Sets the SetShippingDiscountProfilesRequestType.calculatedShippingDiscount.
 void setCombinedDuration(CombinedPaymentPeriodCodeType combinedDuration)
          Sets the SetShippingDiscountProfilesRequestType.combinedDuration.
 void setCurrencyID(CurrencyCodeType currencyID)
          Sets the SetShippingDiscountProfilesRequestType.currencyID.
 void setFlatShippingDiscount(FlatShippingDiscountType flatShippingDiscount)
          Sets the SetShippingDiscountProfilesRequestType.flatShippingDiscount.
 void setInternationalShippingInsurance(ShippingInsuranceType internationalShippingInsurance)
          Sets the SetShippingDiscountProfilesRequestType.internationalShippingInsurance.
 void setModifyActionCode(ModifyActionCodeType modifyActionCode)
          Sets the SetShippingDiscountProfilesRequestType.modifyActionCode.
 void setPromotionalShippingDiscountDetails(PromotionalShippingDiscountDetailsType promotionalShippingDiscountDetails)
          Sets the SetShippingDiscountProfilesRequestType.promotionalShippingDiscountDetails.
 void setShippingDiscountProfiles()
          Enables a seller to define shipping cost discount profiles for things such as combined payments for shipping and handling costs.
 void setShippingInsurance(ShippingInsuranceType shippingInsurance)
          Sets the SetShippingDiscountProfilesRequestType.shippingInsurance.
 
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

SetShippingDiscountProfilesCall

public SetShippingDiscountProfilesCall()
Constructor.


SetShippingDiscountProfilesCall

public SetShippingDiscountProfilesCall(ApiContext apiContext)
Constructor.

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

setShippingDiscountProfiles

public void setShippingDiscountProfiles()
                                 throws ApiException,
                                        SdkException,
                                        Exception
Enables a seller to define shipping cost discount profiles for things such as combined payments for shipping and handling costs.

Throws:
ApiException
SdkException
Exception

getCalculatedHandlingDiscount

public CalculatedHandlingDiscountType getCalculatedHandlingDiscount()
Gets the SetShippingDiscountProfilesRequestType.calculatedHandlingDiscount.

Returns:
CalculatedHandlingDiscountType

setCalculatedHandlingDiscount

public void setCalculatedHandlingDiscount(CalculatedHandlingDiscountType calculatedHandlingDiscount)
Sets the SetShippingDiscountProfilesRequestType.calculatedHandlingDiscount.

Parameters:
calculatedHandlingDiscount - CalculatedHandlingDiscountType

getCalculatedShippingDiscount

public CalculatedShippingDiscountType getCalculatedShippingDiscount()
Gets the SetShippingDiscountProfilesRequestType.calculatedShippingDiscount.

Returns:
CalculatedShippingDiscountType

setCalculatedShippingDiscount

public void setCalculatedShippingDiscount(CalculatedShippingDiscountType calculatedShippingDiscount)
Sets the SetShippingDiscountProfilesRequestType.calculatedShippingDiscount.

Parameters:
calculatedShippingDiscount - CalculatedShippingDiscountType

getCombinedDuration

public CombinedPaymentPeriodCodeType getCombinedDuration()
Gets the SetShippingDiscountProfilesRequestType.combinedDuration.

Returns:
CombinedPaymentPeriodCodeType

setCombinedDuration

public void setCombinedDuration(CombinedPaymentPeriodCodeType combinedDuration)
Sets the SetShippingDiscountProfilesRequestType.combinedDuration.

Parameters:
combinedDuration - CombinedPaymentPeriodCodeType

getCurrencyID

public CurrencyCodeType getCurrencyID()
Gets the SetShippingDiscountProfilesRequestType.currencyID.

Returns:
CurrencyCodeType

setCurrencyID

public void setCurrencyID(CurrencyCodeType currencyID)
Sets the SetShippingDiscountProfilesRequestType.currencyID.

Parameters:
currencyID - CurrencyCodeType

getFlatShippingDiscount

public FlatShippingDiscountType getFlatShippingDiscount()
Gets the SetShippingDiscountProfilesRequestType.flatShippingDiscount.

Returns:
FlatShippingDiscountType

setFlatShippingDiscount

public void setFlatShippingDiscount(FlatShippingDiscountType flatShippingDiscount)
Sets the SetShippingDiscountProfilesRequestType.flatShippingDiscount.

Parameters:
flatShippingDiscount - FlatShippingDiscountType

getInternationalShippingInsurance

public ShippingInsuranceType getInternationalShippingInsurance()
Gets the SetShippingDiscountProfilesRequestType.internationalShippingInsurance.

Returns:
ShippingInsuranceType

setInternationalShippingInsurance

public void setInternationalShippingInsurance(ShippingInsuranceType internationalShippingInsurance)
Sets the SetShippingDiscountProfilesRequestType.internationalShippingInsurance.

Parameters:
internationalShippingInsurance - ShippingInsuranceType

getModifyActionCode

public ModifyActionCodeType getModifyActionCode()
Gets the SetShippingDiscountProfilesRequestType.modifyActionCode.

Returns:
ModifyActionCodeType

setModifyActionCode

public void setModifyActionCode(ModifyActionCodeType modifyActionCode)
Sets the SetShippingDiscountProfilesRequestType.modifyActionCode.

Parameters:
modifyActionCode - ModifyActionCodeType

getPromotionalShippingDiscountDetails

public PromotionalShippingDiscountDetailsType getPromotionalShippingDiscountDetails()
Gets the SetShippingDiscountProfilesRequestType.promotionalShippingDiscountDetails.

Returns:
PromotionalShippingDiscountDetailsType

setPromotionalShippingDiscountDetails

public void setPromotionalShippingDiscountDetails(PromotionalShippingDiscountDetailsType promotionalShippingDiscountDetails)
Sets the SetShippingDiscountProfilesRequestType.promotionalShippingDiscountDetails.

Parameters:
promotionalShippingDiscountDetails - PromotionalShippingDiscountDetailsType

getShippingInsurance

public ShippingInsuranceType getShippingInsurance()
Gets the SetShippingDiscountProfilesRequestType.shippingInsurance.

Returns:
ShippingInsuranceType

setShippingInsurance

public void setShippingInsurance(ShippingInsuranceType shippingInsurance)
Sets the SetShippingDiscountProfilesRequestType.shippingInsurance.

Parameters:
shippingInsurance - 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.