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

NAME
eBay::API::XML::DataType::CharityInfoType

DESCRIPTION
Contains information about a nonprofit charity organization.

SYNOPSIS

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

Subroutines:

  setCharityDomain()
Domain (mission area) that a nonprofit charity organization belongs to. Nonprofit charity organizations may belong to multiple mission areas. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityDomain input value must be valid for that SiteID.

# Argument: reference to an array
                      of 'xs:int'

  getCharityDomain()
  Calls: GetCharities
  Returned: Conditionally

# Returns: reference to an array
                      of 'xs:int'

  setCharityID()
A unique identification number assigned by eBay to registered non-profit charity organizations. This number is returned in GetCharitiesResponse as an id attribute in the parent Charity node.

# Argument: 'xs:string'

  getCharityID()
# Returns: 'xs:string'

  setCharityRegion()
Region that the nonprofit charity organization is associated with. A specific nonprofit charity organization may be associated with only one region. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityRegion input value must be valid for that SiteID.

# Argument: 'xs:int'

  getCharityRegion()
  Calls: GetCharities
  Returned: Conditionally

# Returns: 'xs:int'

  setDisplayLogoSelling()
This boolean value should be set to true if an alternate logo URL should be supplied by sellers using the eBay Sell Your Item flow. If this field has not been set to true, it will return the default value of false.

# Argument: 'xs:boolean'

  isDisplayLogoSelling()
  Calls: GetCharities
  Returned: Conditionally

# Returns: 'xs:boolean'

  setDisplayNameInCheckout()
Set this boolean value to true if the name of the nonprofit company should be shown during checkout. If this field has not been set to true, it will return the default value of false. If the user rolls their mouse over the name of the nonprofit company, they will see the nonprofit company's mission statement.

# Argument: 'xs:boolean'

  isDisplayNameInCheckout()
  Calls: GetCharities
  Returned: Conditionally

# Returns: 'xs:boolean'

  setLogoURL()
A URL with the location of the nonprofit charity organization's logo image. Logo must be JPG or GIF format, with a size maximum of 50 KB. This image is displayed in the Giving Works item listing.

# Argument: 'xs:anyURI'

  getLogoURL()
  Calls: GetCharities
  Returned: Conditionally

# Returns: 'xs:anyURI'

  setLogoURLSelling()
An alternate URL, provided by the seller during the Sell Your Item flow with the location of the nonprofit charity organization's logo image. This URL will be returned if it exists in the eBay database. Otherwise, the field will be empty. The logo must be JPG or GIF format, with a size maximum of 50 KB. This image is displayed in the Giving Works item listing.

# Argument: 'xs:anyURI'

  getLogoURLSelling()
  Calls: GetCharities
  Returned: Conditionally

# Returns: 'xs:anyURI'

  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: GetCharities
  Returned: Conditionally

# Returns: 'xs:string'

  setName()
A name assigned to a specified nonprofit organization.

MaxLength: 150

# Argument: 'xs:string'

  getName()
  Calls: GetCharities
  Returned: Conditionally

# Returns: 'xs:string'

  setSearchableString()
Keyword string to be used for search purposes.

# Argument: 'xs:string'

  getSearchableString()
# Returns: 'xs:string'

  setStatus()
The status of the nonprofit charity organization.

# Argument: 'ns:CharityStatusCodeType'

  getStatus()
# Returns: 'ns:CharityStatusCodeType'

  setId()
A unique identification number assigned by eBay to registered nonprofit charity organizations.

# Argument: 'xs:string'

  getId()
  Calls: GetCharities
  Returned: Conditionally

# Returns: 'xs:string'