eBay Shopping APIVersion 1293
 

CharityType

This type is used to provide details about a charitable organization registered with eBay for Charity. This type is used by the Charity container that is returned in GetSingleItem and GetMultipleItems if the sales proceeds of an eBay listing go towards benefiting a charitable organization.

Type that uses CharityType:

Calls that use CharityType:

Fields



CharityID ( string ) [0..1]
The unique identifier that eBay creates and assigns to each charitable organization that is registered with eBay for Charity. This is the unique identifier that should be used if the user wishes to retrieve more details on a charitable organization by using the getCharityOrg method of the Charity API or the GetCharities call of the Trading API.

This identifier is also used by a seller in an Add/Revise/Relist call when they want to identify the charitable organization that will receive sales proceeds for a listing.
See the Field Index to learn which calls use CharityID.

CharityListing ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use CharityListing.

CharityName ( string ) [0..1]
The name of the charitable organization selected by the seller to receive sales proceeds for the listing.
See the Field Index to learn which calls use CharityName.

DonationPercent ( float ) [0..1]
The percentage of the purchase price that the seller chooses to donate to the selected charitable organization. This percentage is also displayed in the View Item page for the listing. Possible values range from 10.0 to 100.0 (percent), in 5 percent increments. A seller is required to set a donation percentage at listing time, so this field should always be returned for charity listings.
See the Field Index to learn which calls use DonationPercent.

LogoURL ( string ) [0..1]
The full URL to the nonprofit organization's logo image file. This logo image file is the image that is displayed in all eBay listings that benefit that charity. This field is returned as long as it is defined for the nonprofit organization.
See the Field Index to learn which calls use LogoURL.

Mission ( string ) [0..1]
The stated mission of the nonprofit organization. The length of the mission statement can vary by organization. This field is returned as long as it is defined for the nonprofit organization.
See the Field Index to learn which calls use Mission.

This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.
See the Field Index to learn which calls use Status.