GetCharities

Searches for nonprofit charity organizations that meet the criteria specified in the request. It is recommended that you use at least one input filter, because this call no longer returns all charities when made without filters.

See Identifying Listings that Benefit Nonprofits.

See also the reference documentation for these calls:

AddFixedPriceItem - Defines and lists a new fixed-price item. A fixed-price listing can include multiple identical items.
AddItem - Defines a single new item and lists it on a specified eBay site. Also for Half.com.
AddItems - Defines from one to five items and lists them on a specified eBay site.
GetItem - Returns item data such as title, description, price information, seller information, and so on, for the specified ItemID.
GetItemTransactions - Retrieves order line item (transaction) information for a specified ItemID.
GetSellerTransactions - Retrieves order line item (transaction) information for the user for which the call is made, and not for any other user. Also for Half.com. (To retrieve order line items for another seller's listings, use GetItemTransactions.)
GetSellerList - Returns a list of the items posted by the authenticated user, including the related item data.
RelistFixedPriceItem - Enables a seller to take a single fixed-price item (or a single multi-item listing) that has ended and re-list it on a specified eBay site.
RelistItem - Enables a seller to take a single item (or a single multi-item listing) and re-list it on a specified eBay site.
ReviseFixedPriceItem - Enables a seller to change the properties of a currently active fixed-price listing (including multi-variation listings).
ReviseItem - Enables a seller to change the properties of a currently active listing. Also for Half.com.
VerifyAddItem - Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing. Also for Half.com.
VerifyRelistItem - Checks the arguments that you plan to use for a RelistItem call, looking for errors and listing fees, without actually relisting the item.

GetCharities Input

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 Samples.

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>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

CharityDomain	int	Optional	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.
CharityID	string	Optional	A unique identification number assigned by eBay to registered nonprofit charity organizations.
CharityName	string	Optional	A name assigned to a specified nonprofit organization. Accepts full charity nonprofit name or partial name as input. For example, enter a CharityName of "heart" (case-insensitive) to return all charity nonprofits that start with "heart." Use with a MatchType value of "Contains" to return all charity nonprofits that contain the string "heart." Max length: 150.
CharityRegion	int	Optional	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.
Featured	boolean	Optional	Used to decide if the search is only for featured charities. A value of true will search for only featured charities.
IncludeDescription	boolean	Optional	Used with Query to search for charity nonprofit organizations. A value of true will search the Mission field as well as the CharityName field for a string specified in Query.
MatchType	StringMatchCodeType	Optional	Indicates the type of string matching to use when a value is submitted in CharityName. If no value is specified, default behavior is "StartsWith." Does not apply to Query. Applicable values: • Contains (in) Matches strings that contain the submitted value. For example, submitting a CharityName value of "heart" matches both "Heart of Gold" and "Open Hearts." • CustomCode (in) Reserved for internal or future use. • StartsWith (in) Matches strings that begin with the submitted value. For example, submitting a CharityName value of "heart" matches "Heart of Gold," but not "Open Hearts." Default behavior if no value is specified.
Query	string	Optional	Accepts a case-insensitive string used to find a nonprofit charity organization. Default behavior is to search the CharityName field. Use with an IncludeDescription value of true to include the Mission field in the search. Max length: 350 (characters).

Standard Input Fields

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: Routing the Request (Gateway URLs) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

GetCharities Output

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 Samples.

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>
    <ExternalID> string </ExternalID>
    <LogoURL> anyURI </LogoURL>
    <LogoURLSelling> anyURI </LogoURLSelling>
    <Mission> string </Mission>
    <Name> string </Name>
  </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>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

Charity	CharityInfoType	Conditionally, repeatable: [0..*]	Contains information about charity nonprofit organizations that meet the criteria specified in the request. One Charity node is returned for each applicable nonprofit charity organization. The CharityID value is returned as an id attribute of this node. If no nonprofit charity organization is applicable, this node is not returned.
Charity [ attribute id ]	string	Conditionally	This attribute is a unique identifier used by the corresponding social networking site to identify the nonprofit charity organization.
Charity.CharityDomain	int	Conditionally, repeatable: [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.
Charity.CharityRegion	int	Conditionally	Integer value that indicates the nonprofit charity organization's region. Each nonprofit charity organization may be associated with only one region.
Charity.Description	string	Conditionally	This field provides a short 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. The description may contain a maximum of 115 charecters. This value is returned if set. Max length: 4000.
Charity.DisplayLogoSelling	boolean	Conditionally	Deprecated as of version 659. No longer functional. Use FeaturedInSelling instead. Deprecated. This field will be removed from the schema in a future release. Recommended to use IsFeaturedInSYI. 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. Deprecation version: 659. See also Deprecated Objects.
Charity.ExternalID	string	Conditionally	A unique identifier created and used by MissionFish to identify a registered nonprofit charity organization. This field is only returned for charities that are registered with MissionFish. Max length: 4000.
Charity.LogoURL	anyURI	Conditionally	This URL indicates the location of the nonprofit charity organization's logo image. The image file must be JPG or GIF format, and its size cannot exceed 50 KB. This logo is displayed in item listings if the nonprofit charity organization is registered with eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity organization's logo if the LogoURL or LogoURLSelling values are not provided or these value point to bad URLs or to URLs containing no images or images not meeting eBay logo size and format requirements. This value is returned if set.
Charity.LogoURLSelling	anyURI	Conditionally	An alternative to the LogoURL value. This URL indicates the location of the nonprofit charity organization's logo image. The image file must be JPG or GIF format, and its size cannot exceed 50 KB. 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 item listings if the nonprofit charity organization is registered with eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity organization's logo if the Logo URL is not provided. This value is returned if set.
Charity.Mission	string	Conditionally	The mission statement of a nonprofit charity organization registered with eBay Giving Works. The mission statement is returned in GetCharities and is displayed in item listings if the nonprofit charity organization is registered with eBay Giving Works. Max length: 511.
Charity.Name	string	Conditionally	The name of a non-profit charity organization. The Name field is required if non-registered charity organization, since these companies will not have a eBay Giving Works CharityID Max length: 150.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

GetCharities Detail Controls

Detail Control: DetailLevel

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

GetCharities Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetCharities.

GetCharities Change History

Version	Description
759 2012-02-01	Charity.NonProfitAddress (added): A NonProfitAddress container is returned if address information is set for the nonprofit charity organization. Charity.EIN (added): The Employer Identification Number for the nonprofit charity organization. Charity.NonProfitSecondName (added): An alternative name for the nonprofit charity organization. Charity.PopularityIndex (added): A nonprofit charity organization's popularity rank in comparison with other registered eBay Giving Works organizations.
579 2008-08-20	CharityInfoType.DisplayNameInCheckout (added): When DisplayNameInCheckout is set to true, the nonprofit company name will be displayed on the Review Your Purchase page during checkout. The value for the DisplayNameInCheckout field is returned with the GetCharities response.
557 2008-03-19	Featured (added): When Featured is set to true, featured charities will only be returned in the response. If it is set to false, the existing logic of returning all charities will be returned in the response. Featured is not required in the request, thus not supplying it will set the value to false.
443 2006-01-11	WarningLevel (doc change): The I/O Doc has been updated to indicate that WarningLevel is an applicable input.

User-Contributed Notes

eBay Trading API Call Reference Version 823