getCharityOrgs: eBay Charity API | eBay Developers Program

GET/charity_org

This call is used to search for supported charitable organizations. It allows users to search for a specific charitable organization, or for multiple charitable organizations, from a particular charitable domain and/or geographical region, or by using search criteria.

The call returns paginated search results containing the charitable organizations that match the specified criteria.

Input

Resource URI

GET https://api.ebay.com/commerce/charity/v1/charity_org?

q=string&

registration_ids=string&

limit=string&

offset=string

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

Parameter	Type	Description
q	string	A query string that matches the keywords in name, mission statement, or description. Occurrence: Optional
registration_ids	array of string	A comma-separated list of charitable organization registration IDs. Note: Do not specify this parameter for query-based searches. Specify either the q or registration_ids parameter, but not both. Maximum Limit: `20` Occurrence: Optional
limit	string	The number of items, from the result set, returned in a single page. Valid Values: `1-100` Default: `20` Occurrence: Optional
offset	string	The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to `0` and the limit is set to `10`, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to `10` and the limit is set to `10`, the method will retrieve items 11 through 20 from the list of items returned. Valid Values: `0-10,000` Default: `0` Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header Type Description

Header	Type	Description
X-EBAY-C-MARKETPLACE-ID	string	A header used to specify the eBay marketplace ID. Valid Values: `EBAY_GB` and `EBAY_US` Occurrence: Required

X-EBAY-C-MARKETPLACE-ID

string

A header used to specify the eBay marketplace ID.

Valid Values: EBAY_GB and EBAY_US

Occurrence: Required

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* CharitySearchResponse */

"charityOrgs" : [

{ /* CharityOrg */

"charityOrgId" : "string",

"description" : "string",

"location" :

{ /* Location */

"address" :

{ /* Address */

"city" : "string",

"stateOrProvince" : "string",

"postalCode" : "string",

"country" : "CountryCodeEnum : [AD,AE,AF...]"

"geoCoordinates" :

{ /* GeoCoordinates */

"latitude" : "number",

"longitude" : "number"

}

"logoImage" :

{ /* Image */

"height" : "string",

"imageUrl" : "string",

"width" : "string"

"missionStatement" : "string",

"name" : "string",

"registrationId" : "string",

"website" : "string"

}

"href" : "string",

"limit" : "integer",

"next" : "string",

"offset" : "integer",

"prev" : "string",

"total" : "integer"

}

Response fields

Output container/field	Type	Description
charityOrgs	array of CharityOrg	The list of charitable organizations that match the search criteria. Occurrence: Conditional
charityOrgs.charityOrgId	string	The ID of the charitable organization. Occurrence: Always
charityOrgs.description	string	The description of the charitable organization. Occurrence: Conditional
charityOrgs.location	Location	The location details of the charitable organization. Occurrence: Conditional
charityOrgs.location.address	Address	The address of the charitable organization. Occurrence: Conditional
charityOrgs.location.address.city	string	The city of the charitable organization. Occurrence: Conditional
charityOrgs.location.address.stateOrProvince	string	The state or province of the charitable organization. Occurrence: Conditional
charityOrgs.location.address.postalCode	string	The postal code of the charitable organization. Occurrence: Conditional
charityOrgs.location.address.country	CountryCodeEnum	The two-letter ISO 3166 standard of the country of the address. Occurrence: Conditional
charityOrgs.location.geoCoordinates	GeoCoordinates	The geo-coordinates of the charitable organization. Occurrence: Conditional
charityOrgs.location.geoCoordinates.latitude	number	The latitude component of the geographic coordinate. Occurrence: Conditional
charityOrgs.location.geoCoordinates.longitude	number	The longitude component of the geographic coordinate. Occurrence: Conditional
charityOrgs.logoImage	Image	The logo of the charitable organization. Occurrence: Conditional
charityOrgs.logoImage.height	string	The height of the logo image. Occurrence: Conditional
charityOrgs.logoImage.imageUrl	string	The URL to the logo image location. Occurrence: Conditional
charityOrgs.logoImage.width	string	The width of the logo image. Occurrence: Conditional
charityOrgs.missionStatement	string	The mission statement of the charitable organization. Occurrence: Conditional
charityOrgs.name	string	The name of the charitable organization. Occurrence: Always
charityOrgs.registrationId	string	The registration ID for the charitable organization. Note: For the US marketplace, this is the EIN. Occurrence: Conditional
charityOrgs.website	string	The link to the website for the charitable organization. Occurrence: Conditional
href	string	The relative path to the current set of results. Occurrence: Always
limit	integer	The number of items, from the result set, returned in a single page. Valid Values: `1-100` Default: `20` Occurrence: Conditional
next	string	The relative path to the next set of results. Occurrence: Conditional
offset	integer	The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to `0` and the limit is set to `10`, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to `10` and the limit is set to `10`, the method will retrieve items 11 through 20 from the list of items returned. Valid Values: `0-10,000` Default: `0` Occurrence: Conditional
prev	string	The relative path to the previous set of results. Occurrence: Conditional
total	integer	The total number of matches for the search criteria. Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
200	OK
400	Bad Request
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
165000	API_CHARITY	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
165001	API_CHARITY	REQUEST	Invalid, missing or unsupported marketplace. Please refer to documentation.
165003	API_CHARITY	REQUEST	The specified limit is invalid. Maximum value supported is 100.
165004	API_CHARITY	REQUEST	The specified offset is invalid.
165005	API_CHARITY	REQUEST	Please specify registration_ids OR query text for the search.

Warnings

This call has no warnings.

Samples

This call has no samples.