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.
Input
Resource URI
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 |
|---|---|---|
| charity_org_id | string | The 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.
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 |
|---|---|---|
| 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
Response fields
| Output container/field | Type | Description |
|---|---|---|
| charityOrgId | string | The ID of the charitable organization. Occurrence: Always |
| description | string | The description of the charitable organization. Occurrence: Conditional |
| location | Location | The location details of the charitable organization. Occurrence: Conditional |
| location.address | Address | The address of the charitable organization. Occurrence: Conditional |
| location.address.city | string | The city of the charitable organization. Occurrence: Conditional |
| location.address.stateOrProvince | string | The state or province of the charitable organization. Occurrence: Conditional |
| location.address.postalCode | string | The postal code of the charitable organization. Occurrence: Conditional |
| location.address.country | CountryCodeEnum | The two-letter ISO 3166 standard of the country of the address. Occurrence: Conditional |
| location.geoCoordinates | GeoCoordinates | The geo-coordinates of the charitable organization. Occurrence: Conditional |
| location.geoCoordinates.latitude | number | The latitude component of the geographic coordinate. Occurrence: Conditional |
| location.geoCoordinates.longitude | number | The longitude component of the geographic coordinate. Occurrence: Conditional |
| logoImage | Image | The logo of the charitable organization. Occurrence: Conditional |
| logoImage.height | string | The height of the logo image. Occurrence: Conditional |
| logoImage.imageUrl | string | The URL to the logo image location. Occurrence: Conditional |
| logoImage.width | string | The width of the logo image. Occurrence: Conditional |
| missionStatement | string | The mission statement of the charitable organization. Occurrence: Conditional |
| name | string | The name of the charitable organization. Occurrence: Always |
| registrationId | string | The registration ID for the charitable organization. Occurrence: Conditional |
| website | string | 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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 404 | Not found |
| 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. |
| 165002 | API_CHARITY | REQUEST | Charity Org Id 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
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.
GEThttps://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.