eBay Trading APIVersion 1173

CharityInfoType

Type defining the Charity container returned in GetCharities, which consists of all details related to a nonprofit charity organization.

Type that uses CharityInfoType:

Call that uses CharityInfoType:

Fields



CharityDomain ( int ) [0..3]
Integer value that indicates the domain (mission area) of the nonprofit charity organization. A nonprofit charity organization does not have to specify a charity domain, so it is possible that this field will not be returned in GetCharities. Each nonprofit charity organization can belong to as many as three charity domains.
See the Field Index to learn which calls use CharityDomain.

CharityID ( string ) [0..1]
Not used by any call.

This field is no longer returned. eBay's unique identifier for nonprofit organizations is now returned in the id attribute of the the opening Charity tag instead.
See the Field Index to learn which calls use CharityID.

CharityRegion ( int ) [0..1]
Integer value that indicates the nonprofit charity organization's region. Each nonprofit charity organization may only be associated with one region.
See the Field Index to learn which calls use CharityRegion.

Description ( string ) [0..1]
This field provides a description about the nonprofit charity organization's primary purpose. "I want to support" will be added to the beginning of the contents of this field. For example, if the description is "the fight against cancer", then on the checkout page "I want to support the fight against cancer" will be displayed. This field is returned if available for the nonprofit organization.
See the Field Index to learn which calls use Description.

DisplayLogoSelling ( boolean ) [0..1]
This boolean value indicates if the LogoURLSelling image will appear in the eBay for Charity section of the View Item page for a charitable listing.
See the Field Index to learn which calls use DisplayLogoSelling.

DisplayNameInCheckout ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use DisplayNameInCheckout.

EIN ( string ) [0..1]
This value is the Employer Identification Number (EIN) of the nonprofit charity organization. A nonprofit company's EIN is used for tax purposes by the Internal Revenue Service. This value is returned if the nonprofit organization has an EIN and it has been set.
See the Field Index to learn which calls use EIN.

ExternalID ( string ) [0..1]
A unique identifier created and used by PayPal Giving Fund to identify a registered nonprofit charity organization. This field is only returned for charities that are registered with PayPal Giving Fund.
See the Field Index to learn which calls use ExternalID.

ListingNPContactName ( string ) [0..1]
Not used by any call.

This field is for internal use only.
See the Field Index to learn which calls use ListingNPContactName.

ListingNPEmail ( string ) [0..1]
Not used by any call.

This field is for internal use only.
See the Field Index to learn which calls use ListingNPEmail.

ListingNPEmailNotifPref ( boolean ) [0..1]
Not used by any call.

This flag is for internal use only.
See the Field Index to learn which calls use ListingNPEmailNotifPref.

LogoURL ( anyURI ) [0..1]
The URL to the nonprofit charity organization's logo image. The image file will be in JPG or GIF format. This logo is displayed in charitable listings in the eBay for Charity section of the View Item page. This field is returned if available for the nonprofit organization.
See the Field Index to learn which calls use LogoURL.

LogoURLSelling ( anyURI ) [0..1]
An alternative to the LogoURL value. This URL indicates the location of the nonprofit charity organization's logo image. The image file will be in JPG or GIF format. This URL will be used if the LogoURL value points to a broken link or if that location either contains no image or contains an image that does not meet the eBay requirements - GIF or JPG file; maximum size of 50 KB. A nonprofit charity organization's logo is displayed in the eBay for Charity section of the View Item page for a charitable listing.
See the Field Index to learn which calls use LogoURLSelling.

Mission ( string ) [0..1]
The mission statement of the nonprofit charity organization. This field will be returned if the organization's mission statement is available.

See the Field Index to learn which calls use Mission.

Name ( string ) [0..1]
The name of a nonprofit charity organization.

See the Field Index to learn which calls use Name.

NonProfitAddress ( NonProfitAddressType ) [0..*]
Not used by any call.

Container consisting of the address (including latitude and longitude) of a nonprofit charity organization. This container is always returned if it is set.
See the Field Index to learn which calls use NonProfitAddress.

NonProfitSecondName ( string ) [0..1]
Not used by any call.

An alternative name for the nonprofit charity organization. This value is used by PayPal to search for nonprofit organizations. This value is returned if set.
See the Field Index to learn which calls use NonProfitSecondName.

NonProfitSocialAddress ( NonProfitSocialAddressType ) [0..*]
Not used by any call.

Container consisting of the nonprofit charity organization's social networking site ID/handle. A NonProfitSocialAddress container will exist for each social networking site that the charity organization is associated with. Supported social networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One or more of these containers are returned if set.
See the Field Index to learn which calls use NonProfitSocialAddress.

PopularityIndex ( int ) [0..1]
An integer value that indicates a nonprofit charity organization's popularity rank in comparison with other registered eBay for Charity organizations. This value is determined and managed by PayPal Giving Fund and is based on various factors. This value is always returned for nonprofit organizations registered with PayPal Giving Fund.
See the Field Index to learn which calls use PopularityIndex.

SearchableString ( string ) [0..1]
Not used by any call.

Keyword string to be used for search purposes.
See the Field Index to learn which calls use SearchableString.

ShowMultipleDonationAmountInCheckout ( boolean ) [0..1]
Not used by any call.

This field must be used with the DisplayNameInCheckout field to control the options that are visible to a buyer during checkout. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to False, a checkbox with the one dollar option will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to False, no options will be displayed during checkout.

Reserved for future use. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout, but the multiple donation amount field will be set.
See the Field Index to learn which calls use ShowMultipleDonationAmountInCheckout.

Not used by any call.

This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.
See the Field Index to learn which calls use Status.

Attribute

id ( string )
This attribute is the eBay-assigned, unique identifier of the nonprofit charity organization.