Charity API — client.commerce.charity¶
Version v1.2.1 · base path /commerce/charity/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_charity_org ¶
get_charity_org(charity_org_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_charity_models.CharityOrg
get_charity_org(charity_org_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_charity_org(charity_org_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_charity_models.CharityOrg | httpx.Response
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.
get_charity_orgs ¶
get_charity_orgs(*, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, registration_ids: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_charity_models.CharitySearchResponse
get_charity_orgs(*, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, registration_ids: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_charity_orgs(*, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, registration_ids: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_charity_models.CharitySearchResponse | httpx.Response
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.
Models¶
CountryCodeEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
GeoCoordinates ¶
Image ¶
Bases: EbayModel
height
class-attribute
instance-attribute
¶
height = Field(None, description='The height of the logo image.')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The URL to the logo image location.')
width
class-attribute
instance-attribute
¶
width = Field(None, description='The width of the logo image.')
Address ¶
Bases: EbayModel
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city of the charitable organization.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province of the charitable organization.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the charitable organization.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 standard of the country of the address.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
Location ¶
Bases: EbayModel
CharityOrg ¶
Bases: EbayModel
charity_org_id
class-attribute
instance-attribute
¶
charity_org_id = Field(None, alias='charityOrgId', description='The ID of the charitable organization.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the charitable organization.')
location
class-attribute
instance-attribute
¶
location = Field(None, description='The location details of the charitable organization.')
logo_image
class-attribute
instance-attribute
¶
logo_image = Field(None, alias='logoImage', description='The logo of the charitable organization.')
mission_statement
class-attribute
instance-attribute
¶
mission_statement = Field(None, alias='missionStatement', description='The mission statement of the charitable organization.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the charitable organization.')
registration_id
class-attribute
instance-attribute
¶
registration_id = Field(None, alias='registrationId', description='The registration ID for the charitable organization. Note: For the US marketplace, this is the EIN.')
website
class-attribute
instance-attribute
¶
website = Field(None, description='The link to the website for the charitable organization.')
CharitySearchResponse ¶
Bases: EbayModel
charity_orgs
class-attribute
instance-attribute
¶
charity_orgs = Field(None, alias='charityOrgs', description='The list of charitable organizations that match the search criteria.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The relative path to the current set of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The relative path to the next set of results.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='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.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The relative path to the previous set of results.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of matches for the search criteria.')