API docs by Redocly

Charity API (v1.2.0)

Download OpenAPI specification:Download

License: eBay API License Agreement

The Charity API allows third-party developers to search for and access details on supported charitable organizations.

charity_org

getCharityOrg

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.

Authorizations:
Client_Credentials
path Parameters
charity_org_id
required
string

The unique ID of the charitable organization.

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

A header used to specify the eBay marketplace ID.

Valid Values: EBAY_GB and EBAY_US

Responses

Response samples

Content type
application/json
{
  • "charityOrgId": "string",
  • "description": "string",
  • "location": {
    },
  • "logoImage": {
    },
  • "missionStatement": "string",
  • "name": "string",
  • "registrationId": "string",
  • "website": "string"
}

getCharityOrgs

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.

Authorizations:
Client_Credentials
query Parameters
limit
string

The number of items, from the result set, returned in a single page.

Valid Values: 1-100

Default: 20

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

q
string

A query string that matches the keywords in name, mission statement, or description.

registration_ids
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

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

A header used to specify the eBay marketplace ID.

Valid Values: EBAY_GB and EBAY_US

Responses

Response samples

Content type
application/json
{
  • "charityOrgs": [
    ],
  • "href": "string",
  • "limit": 0,
  • "next": "string",
  • "offset": 0,
  • "prev": "string",
  • "total": 0
}

getCharityOrgByLegacyId

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.

Authorizations:
Client_Credentials
query Parameters
legacy_charity_org_id
required
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.

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

A header used to specify the eBay marketplace ID.

Valid Values: EBAY_GB and EBAY_US

Responses

Response samples

Content type
application/json
{
  • "charityOrgId": "string",
  • "description": "string",
  • "location": {
    },
  • "logoImage": {
    },
  • "missionStatement": "string",
  • "name": "string",
  • "registrationId": "string",
  • "website": "string"
}