Skip to main content

GET/charity_org/get_charity_org_by_legacy_id

This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID. The legacy charity ID is separate from eBay’s generic charity ID.

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
legacy_charity_org_idstringThe legacy ID of the charitable organization.

Note: The legacy charity ID is the identifier assigned to an organization upon registration with the PayPal Giving Fund (PPGF). It has also been referred to as the external ID/charity number.

Occurrence: Required

HTTP request headers

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

This method has the additional request header requirements listed below. See HTTP request headers- opens rest request components page for details.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringA 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

Response fields

Output container/fieldTypeDescription
charityOrgIdstring

The ID of the charitable organization.

Occurrence: Always

descriptionstring

The description of the charitable organization.

Occurrence: Conditional

locationLocation

The location details of the charitable organization.

Occurrence: Conditional

location.addressAddress

The address of the charitable organization.

Occurrence: Conditional

location.address.citystring

The city of the charitable organization.

Occurrence: Conditional

location.address.stateOrProvincestring

The state or province of the charitable organization.

Occurrence: Conditional

location.address.postalCodestring

The postal code of the charitable organization.

Occurrence: Conditional

location.address.countryCountryCodeEnum

The two-letter ISO 3166 standard of the country of the address.

Occurrence: Conditional

location.geoCoordinatesGeoCoordinates

The geo-coordinates of the charitable organization.

Occurrence: Conditional

location.geoCoordinates.latitudenumber

The latitude component of the geographic coordinate.

Occurrence: Conditional

location.geoCoordinates.longitudenumber

The longitude component of the geographic coordinate.

Occurrence: Conditional

logoImageImage

The logo of the charitable organization.

Occurrence: Conditional

logoImage.heightstring

The height of the logo image.

Occurrence: Conditional

logoImage.imageUrlstring

The URL to the logo image location.

Occurrence: Conditional

logoImage.widthstring

The width of the logo image.

Occurrence: Conditional

missionStatementstring

The mission statement of the charitable organization.

Occurrence: Conditional

namestring

The name of the charitable organization.

Occurrence: Always

registrationIdstring

The registration ID for the charitable organization.

Note: For the US marketplace, this is the EIN.

Occurrence: Conditional

websitestring

The link to the website for the charitable organization.

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.

StatusMeaning
200OK
404Not found
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
165000API_CHARITYAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
165001API_CHARITYREQUESTInvalid, missing or unsupported marketplace. Please refer to documentation.
165006API_CHARITYREQUESTLegacyId is invalid or missing.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve Charitable Organization Details by Legacy Charity ID

This sample retrieves detailed information for a supported charitable organization based on its legacy charity ID.

Input

The input is the legacy_charity_org_id URI parameter. There is no payload with this request.

GEThttps://api.ebay.com/commerce/charity/v1/charity_org/get_charity_org_by_legacy_id?legacy_charity_org_id=3843

Output

If the call is successful, the charitable organization details for the specified legacy charity ID are returned.