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

NAME
eBay::API::XML::DataType::PromotionalSaleType

DESCRIPTION
Details for a single promotional sale.

SYNOPSIS

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

Subroutines:

  setDiscountType()
Type of a promotional sale discount for items (for example, percentage). Applies to price discount sales only.

  Calls: SetPromotionalSale
  RequiredInput: Conditionally

# Argument: 'ns:DiscountCodeType'

  getDiscountType()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'ns:DiscountCodeType'

  setDiscountValue()
Value of a promotional sale discount for items, a percentage discount or a fixed amount reduction. Percentage discounts must be at least 5% and cannot exceed 75% of the original listing price. Fixed amount discounts will be in the currency of the original listing. Applies to price discount sales only.

  Calls: SetPromotionalSale
  RequiredInput: Conditionally

# Argument: 'xs:double'

  getDiscountValue()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'xs:double'

  setPromotionalSaleEndTime()
End date of a promotional sale discount for items. Maximum listing durations vary by site from 14 days to 45 days. The minimum promotional sale duration is 1 day for most sites, but 3 days on some sites.

  Calls: SetPromotionalSale
  RequiredInput: Conditionally

# Argument: 'xs:dateTime'

  getPromotionalSaleEndTime()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'xs:dateTime'

  setPromotionalSaleID()
Unique ID of a promotional sale (discount and/or free shipping) for items. This field is an input field only for the SetPromotionalSale call and only if you are not adding a new promotional sale.

  Calls: SetPromotionalSale
  RequiredInput: Conditionally

# Argument: 'xs:long'

  getPromotionalSaleID()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'xs:long'

  setPromotionalSaleItemIDArray()
Items covered by a promotional sale.

# Argument: 'ns:ItemIDArrayType'

  getPromotionalSaleItemIDArray()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'ns:ItemIDArrayType'

  setPromotionalSaleName()
Name of a promotional sale for items.

  Calls: SetPromotionalSale
  RequiredInput: Conditionally

# Argument: 'xs:string'

  getPromotionalSaleName()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'xs:string'

  setPromotionalSaleStartTime()
Start date of a promotional sale for items. Promotional sales can start immediately or be scheduled to start at a later date. Some sites require items to have been listed for a specific duration before they can be added to a promotional sale (for example, on the US site, items must have been listed for a day before they can be added to a promotional sale).

  Calls: SetPromotionalSale
  RequiredInput: Conditionally

# Argument: 'xs:dateTime'

  getPromotionalSaleStartTime()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'xs:dateTime'

  setPromotionalSaleType()
Type of promotional sale: price discount, free shipping, or both.

  Calls: SetPromotionalSale
  RequiredInput: Conditionally

# Argument: 'ns:PromotionalSaleTypeCodeType'

  getPromotionalSaleType()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'ns:PromotionalSaleTypeCodeType'

  setStatus()
Status of a promotional sale for items.

# Argument: 'ns:PromotionalSaleStatusCodeType'

  getStatus()
  Calls: GetPromotionalSaleDetails
  Returned: Conditionally

# Returns: 'ns:PromotionalSaleStatusCodeType'