eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType(3)

NAME
eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType

DESCRIPTION
Details of a promotional shipping discount.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setDiscountName()
The type of promotional shipping discount that is detailed in the profile. If MaximumShippingCostPerOrder, see ShippingCost. If ShippingCostXForAmountY, see ShippingCost and OrderAmount. If ShippingCostXForItemCountN, see ShippingCost and ItemCount.

  Calls: SetShippingDiscountProfiles
  RequiredInput: Conditionally
  OnlyTheseValues:
                                                                MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN

# Argument: 'ns:DiscountNameCodeType'

  getDiscountName()
  Calls: GetShippingDiscountProfiles
  Returned: Conditionally
  OnlyTheseValues:
                                                                MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
  OnlyTheseValues:
                                                                MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN

# Returns: 'ns:DiscountNameCodeType'

  setItemCount()
This is the number of items, when DiscountName is set to ShippingCostXForItemsY.

  Calls: SetShippingDiscountProfiles
  RequiredInput: Conditionally

# Argument: 'xs:int'

  getItemCount()
  Calls: GetShippingDiscountProfiles
  Returned: Conditionally

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

# Returns: 'xs:int'

  setOrderAmount()
This is the cost Y of the order (not including shipping cost), when DiscountName is set to ShippingCostXForAmountY.

  Calls: SetShippingDiscountProfiles
  RequiredInput: Conditionally

# Argument: 'ns:AmountType'

  getOrderAmount()
  Calls: GetShippingDiscountProfiles
  Returned: Conditionally

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

# Returns: 'ns:AmountType'

  setShippingCost()
This is shipping cost X, when DiscountName is either ShippingCostXForAmountY or ShippingCostXForItemCountN, and is the maximum cost when DiscountName is MaximumShippingCostPerOrder.

  Calls: SetShippingDiscountProfiles
  RequiredInput: Conditionally

# Argument: 'ns:AmountType'

  getShippingCost()
  Calls: GetShippingDiscountProfiles
  Returned: Conditionally

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

# Returns: 'ns:AmountType'