NAME

eBay::API::XML::DataType::CharityType

DESCRIPTION

Identifies a Giving Works listing and benefiting nonprofit charity organization. Currently supported through the US and eBay Motors sites only. The Ad Format and Mature Audiences categories are not supported. Not applicable for US eBay Motors, international, Real Estate, and Tickets.

SYNOPSIS

INHERITANCE

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

Subroutines:

setCharityID()

A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items.

  Calls: AddItem
         GetItemRecommendations
         RelistItem
         VerifyAddItem
  RequiredInput: Conditionally

# Argument: 'xs:string'

getCharityID()

  Calls: GetBidderList
  Returned: Conditionally

  Calls: GetItem
         GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setCharityListing()

If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item's purchase price to a selected nonprofit organization.

# Argument: 'xs:boolean'

isCharityListing()

  Calls: GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:boolean'

setCharityName()

The name of the benefiting nonprofit charity organization selected by the charity seller.

MaxLength: 150

# Argument: 'xs:string'

getCharityName()

  Calls: GetBidderList
  Returned: Conditionally

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetItem
         GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setCharityNumber()

A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. Being superseded by CharityID. Max 10 digits.

  Calls: AddItem
         GetItemRecommendations
         RelistItem
         VerifyAddItem
  RequiredInput: No

# Argument: 'xs:int'

getCharityNumber()

  Calls: GetBidderList
  Returned: Conditionally

  Calls: GetItem
         GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:int'

setDonationPercent()

The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items.

  Calls: AddItem
         GetItemRecommendations
         RelistItem
         VerifyAddItem
  RequiredInput: Conditionally

# Argument: 'xs:float'

getDonationPercent()

  Calls: GetBidderList
  Returned: Conditionally

  Calls: GetItem
         GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:float'

setLogoURL()

The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing.

# Argument: 'xs:string'

getLogoURL()

  Calls: GetItem
         GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

  Calls: GetBidderList
  Returned: Conditionally

# Returns: 'xs:string'

setMission()

The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing.

MaxLength: 511

# Argument: 'xs:string'

getMission()

  Calls: GetBidderList
  Returned: Conditionally

  Calls: GetItem
         GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setStatus()

The status of the nonprofit charity organization.

# Argument: 'ns:CharityStatusCodeType'

getStatus()

  Calls: GetBidderList
  Returned: Conditionally

  Calls: GetItem
         GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

# Returns: 'ns:CharityStatusCodeType'