charity APIv1.1.0

getCharityOrg

GET
/charity_org/{charity_org_id}
This call is used to retrieve detailed information about supported charitable organizations. It allows users to retrieve the details for a specific charitable organization using its charity organization ID.

The call returns the full details for the charitable organization that matches the specified ID.

Input

Resource URI (production)

GET https://api.ebay.com/commerce/charity/v1/charity_org/{charity_org_id}

URI parameters

ParameterTypeDescription
charity_org_idstringThe unique ID of the charitable organization.

Occurrence: Required

HTTP request headers

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

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.

Output

HTTP response headers

Output container/fieldTypeDescription
charityOrgIdstringThe ID of the charitable organization.

Occurrence: Always

descriptionstringThe description of the charitable organization.

Occurrence: Conditional

locationLocationThe location details of the charitable organization.

Occurrence: Conditional

location.addressAddressThe address of the charitable organization.

Occurrence: Conditional

location.address.citystringThe city of the charitable organization.

Occurrence: Conditional

location.address.stateOrProvincestringThe state or province of the charitable organization.

Occurrence: Conditional

location.geoCoordinatesGeoCoordinatesThe geo-coordinates of the charitable organization.

Occurrence: Conditional

location.geoCoordinates.latitudenumberThe latitude component of the geographic coordinate.

Occurrence: Conditional

location.geoCoordinates.longitudenumberThe longitude component of the geographic coordinate.

Occurrence: Conditional

logoImageImageThe logo of the charitable organization.

Occurrence: Conditional

logoImage.heightstringThe height of the logo image.

Occurrence: Conditional

logoImage.imageUrlstringThe URL to the logo image location.

Occurrence: Conditional

logoImage.widthstringThe width of the logo image.

Occurrence: Conditional

missionStatementstringThe mission statement of the charitable organization.

Occurrence: Conditional

namestringThe name of the charitable organization.

Occurrence: Always

registrationIdstringThe registration ID for the charitable organization. For the US marketplace, this is the EIN.

Occurrence: Conditional

websitestringThe 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.
165002API_CHARITYREQUESTCharity Org Id is invalid or missing.

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

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

Input

The input is the charity_org_id URI parameter. There is no payload with this request.
GET
https://api.ebay.com/commerce/charity/v1/charity_org/302

Output

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