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 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. This field is required if the user is adding or updating one or more shipping discount profiles.



Note that There is a currencyID attribute on all SetShippingDiscountProfiles elements involving money. To avoid a call error, be sure to use the same currency type in these attributes as what is set for the CurrencyID field.
Input property: CombinedDuration - This field is used to specify the number of days after the purchase of an item that 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 - This field is used to set which action is being taken (Add, Update, or Delete) in the call. If you are adding a shipping discount rule, you will have to supply a name for that shipping discount profile. If you want to update or delete a shipping discount profile, you'll have to provide the unique identifier of this rule through the corresponding containers. The unique identifiers of these rules can be retrieved with the GetShippingDiscountRules call, or the seller can view these identifiers in My eBay Shipping Preferences.
Input property: FlatShippingDiscount - This container allows you to create, update, or delete a flat-rate shipping discount profile.
Input property: CalculatedShippingDiscount - This container allows you to create, update, or delete a calculated shipping discount profile.
Input property: CalculatedHandlingDiscount - This container allows you to create, update, or delete a calculated handling discount profile.
Input property: PromotionalShippingDiscountDetails - This container allows you to create, update, or delete a promotional shipping discount profile.
Input property: ShippingInsurance - This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
Input property: InternationalShippingInsurance - This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

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()
          This call enables a seller to create and manage shipping discounts rules.
 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, 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

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,
                                        java.lang.Exception
This call enables a seller to create and manage shipping discounts rules. These are the same shipping discount rules that can be created or managed in My eBay Shipping Preferences.

The types of shipping discount rules that can be created and managed with this call include flat-rate shipping rules, calculated shipping rules, and promotional shipping rules. This call can also be used by sellers to set whether or not they allow buyers to combine separate line items into one Combined Invoice order, and how many days they allow buyers to perform that action.

A seller can only create, update, or delete one discount rule type with each call. The action to take (either Add, Update, or Delete) is set and controlled with the ModifyActionCode field.

Throws:
ApiException
SdkException
java.lang.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.