eBay Trading APIVersion 1257
 

GetCharitiesRequestType ( AbstractRequestType )

The GetCharities call is used to search for nonprofit organizations that are registered with the eBay for Charity program. This call allows users to search for a specific nonprofit organization, or to search for multiple nonprofit organizations from a particular charitable domain, and/or geographical region, or by using a search string.

Call that uses GetCharitiesRequestType:

Fields



CampaignID ( long ) [0..1]
Not used by any call.

Reserved for future use.
See the Field Index to learn which calls use CampaignID.

CharityDomain ( int ) [0..1]
This field can be used to search for registered nonprofit organizations within a specified charitable domain. Each charitable domain will have an integer value associated with it. This integer value is what is passed in to this field. Nonprofit organizations can be associated with multiple charitable domains.
See the Field Index to learn which calls use CharityDomain.

CharityID ( string ) [0..1]
The unique identifier that eBay creates and assigns to each nonprofit organization. This is NOT the unique identifier used by the PayPal Giving Fund. This eBay unique identifier is returned in the Charity.CharityID field of a GetItem call for charitable listings.

If a CharityID value is used in the request, all other search filters set in the call request will be ignored, as the call will only search for the specified nonprofit organization.
See the Field Index to learn which calls use CharityID.

CharityName ( string ) [0..1]
This field will accept the full or partial name of a registered nonprofit organization. For example, if you pass in a value of heart, all registered nonprofit organizations with "heart" in their name may be returned in the response. If the MatchType field is used and set to StartsWith (default value), or is not used at all, the phrase "heart" must come at the beginning of the nonprofit organization's name to be returned. However, if the MatchType field is used and set to Contains, all registered nonprofit organizations with "heart" in their name should be returned in the response. The string passed in this field is not case-sensitive.
See the Field Index to learn which calls use CharityName.

CharityRegion ( int ) [0..1]
This field can be used to search for registered nonprofit organizations within a specified geographical region. Each geographical region will have an integer value associated with it. This integer value is what is passed in to this field.
See the Field Index to learn which calls use CharityRegion.

Featured ( boolean ) [0..1]
This boolean field is used and set to true if the user wants to search for nonprofit organizations currently featured on the eBay for Charity site.
See the Field Index to learn which calls use Featured.

IncludeDescription ( boolean ) [0..1]
This field should be included and set to true if a user wants the charity's description to appear in the response. Note that not all charitable organizations will have defined descriptions.
See the Field Index to learn which calls use IncludeDescription.

MatchType ( StringMatchCodeType ) [0..1]
This filter is used if the user wants to specify where to look for the string specified in the CharityName field. The enumeration value input into this field controls the type of string matching to use when a value is submitted in the CharityName field. If this field is omitted, and a CharityName string is used, this parameter value defaults to StartsWith.

This field is not applicable when a Query value is used.
See the Field Index to learn which calls use MatchType.

Query ( string ) [0..1]
This field accepts any string up to 350 characters in length. The functionality of this field is similar to the CharityName field, except that the call will also search for the supplied query string within the charity's mission statement (which is returned under the Charity.Mission field in the response). If you pass in a value of heart, all registered nonprofit organizations with "heart" in their name or in their mission statement may be returned in the response.

The string passed in this field is not case-sensitive. The MatchType field will have no effect if the Query field is used, as the MatchType field will only have an effect if a CharityName string field is included.
See the Field Index to learn which calls use Query.