Note: The getCharityOrgByLegacyId method requires a PayPal Giving Fund ID to retrieve an eBay charitable organizaiton, and eBay will no longer support these IDs beginning on January 16, 2023. The alternative to this method is the getCharityOrg method, and this method requires the eBay-generated ID for a charitable organization.
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.
The call returns the full details for the charitable organization that matches the specified ID.
|legacy_charity_org_id||string||The 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.
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.
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):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
This call has no response headers.
The ID of the charitable organization.
The description of the charitable organization.
The location details of the charitable organization.
The address of the charitable organization.
The city of the charitable organization.
The state or province of the charitable organization.
The postal code of the charitable organization.
The two-letter ISO 3166 standard of the country of the address.
The geo-coordinates of the charitable organization.
The latitude component of the geographic coordinate.
The longitude component of the geographic coordinate.
The logo of the charitable organization.
The height of the logo image.
The URL to the logo image location.
The width of the logo image.
The mission statement of the charitable organization.
The name of the charitable organization.
The registration ID for the charitable organization.
The link to the website for the charitable organization.
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.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|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.|
|165006||API_CHARITY||REQUEST||LegacyId is invalid or missing.|
This call has no warnings.
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.
This sample retrieves detailed information for a supported charitable organization based on its legacy charity ID.
The input is the legacy_charity_org_id URI parameter. There is no payload with this request.
If the call is successful, the charitable organization details for the specified legacy charity ID are returned.