GetCharities

Note: This call is deprecated, and will be decommisioned on September 18, 2023. The alternative for this API is Charity API, which has a getCharityOrg method to retrieve details on a specific Charity, and a getCharityOrgs method to retrieve multiple charities based on search filters.
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.

See Identifying Listings that Benefit Nonprofits.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetCharitiesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <CharityDomain> int </CharityDomain>
  <CharityID> string </CharityID>
  <CharityName> string </CharityName>
  <CharityRegion> int </CharityRegion>
  <Featured> boolean </Featured>
  <IncludeDescription> boolean </IncludeDescription>
  <MatchType> StringMatchCodeType </MatchType>
  <Query> string </Query>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetCharitiesRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetCharitiesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Charity id="string"> CharityInfoType
    <CharityDomain> int </CharityDomain>
    <!-- ... more CharityDomain values allowed here ... -->
    <CharityRegion> int </CharityRegion>
    <Description> string </Description>
    <DisplayLogoSelling> boolean </DisplayLogoSelling>
    <EIN> string </EIN>
    <LogoURL> anyURI </LogoURL>
    <LogoURLSelling> anyURI </LogoURLSelling>
    <Mission> string </Mission>
    <Name> string </Name>
    <PopularityIndex> int </PopularityIndex>
  </Charity>
  <!-- ... more Charity nodes allowed here ... -->
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetCharitiesResponse>

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

Code samples not yet added for this call's documentation.

Change History