/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::DiscountProfileType

NAME

eBay::API::XML::DataType::DiscountProfileType

DESCRIPTION

Details of a flat or calculated shipping discount profile.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::DiscountProfileType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setDiscountProfileID()

The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored.

Calls: SetShippingDiscountProfiles
RequiredInput: Conditionally

# Argument: 'xs:string'

getDiscountProfileID()

Calls: GetShippingDiscountProfiles
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:string'

setDiscountProfileName()

The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile.

Calls: SetShippingDiscountProfiles
RequiredInput: Conditionally

# Argument: 'xs:string'

getDiscountProfileName()

Calls: GetShippingDiscountProfiles
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:string'

setEachAdditionalAmount()

The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

Calls: SetShippingDiscountProfiles
RequiredInput: Conditionally
Context: FlatShippingDiscount

# Argument: 'ns:AmountType'

getEachAdditionalAmount()

Calls: GetShippingDiscountProfiles
Returned: Conditionally
Context: FlatShippingDiscount

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: FlatShippingDiscount
         InternationalFlatShippingDiscount

# Returns: 'ns:AmountType'

setEachAdditionalAmountOff()

The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

Calls: SetShippingDiscountProfiles
RequiredInput: Conditionally
Context: FlatShippingDiscount

# Argument: 'ns:AmountType'

getEachAdditionalAmountOff()

Calls: GetShippingDiscountProfiles
Returned: Conditionally
Context: FlatShippingDiscount

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: FlatShippingDiscount
         InternationalFlatShippingDiscount

# Returns: 'ns:AmountType'

setEachAdditionalPercentOff()

The percent (expressed in decimal, as in .5 for 50%), if the seller specified EachAdditionalPercentOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

Calls: SetShippingDiscountProfiles
RequiredInput: Conditionally
Context: FlatShippingDiscount

# Argument: 'xs:float'

getEachAdditionalPercentOff()

Calls: GetShippingDiscountProfiles
Returned: Conditionally
Context: FlatShippingDiscount

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: FlatShippingDiscount
         InternationalFlatShippingDiscount

# Returns: 'xs:float'

setMappedDiscountProfileID()

For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed. For SetShippingDiscountProfiles and GetItem, this is the intended discount profile mapping.

Calls: SetShippingDiscountProfiles
RequiredInput: Conditionally
Context: CalculatedShippingDiscount

# Argument: 'xs:string'

getMappedDiscountProfileID()

Calls: GetShippingDiscountProfiles
Returned: Conditionally
Context: CalculatedShippingDiscount

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: CalculatedShippingDiscount
         InternationalCalculatedShippingDiscount

# Returns: 'xs:string'

setWeightOff()

The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.

Calls: SetShippingDiscountProfiles
RequiredInput: Conditionally
Context: CalculatedShippingDiscount

# Argument: 'ns:MeasureType'

getWeightOff()

Calls: GetShippingDiscountProfiles
Returned: Conditionally
Context: CalculatedShippingDiscount

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: CalculatedShippingDiscount
         InternationalCalculatedShippingDiscount

# Returns: 'ns:MeasureType'