eBay Shopping APIVersion 1145

CharityType

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

Type that uses CharityType:

Calls that use CharityType:

Fields



CharityID ( string ) [0..1]
The unique identifier that eBay creates and assigns to each nonprofit 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 nonprofit organization by using the Trading API's lt;b>GetCharities call, or used by a seller in an Add/Revise/Relist call when they want to identify the nonprofit organization that will receive sale 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 benefiting nonprofit organization selected by the charity seller to receive sale proceeds for the listing.
See the Field Index to learn which calls use CharityName.

CharityNumber ( int ) [0..1]
The unique identifier that the PayPal Giving Fund assigns to each nonprofit organization that registers with eBay for Charity.

Note: The CharityNumber field has been scheduled for deprecation. It is the CharityID value that should be used instead if the user wishes to retrieve more details on a nonprofit organization by using the Trading API's GetCharities call, or used by a seller in an Add/Revise/Relist call when they want to identify the nonprofit organization that will receive sale proceeds for a listing.
See the Field Index to learn which calls use CharityNumber.

DonationPercent ( float ) [0..1]
The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is also displayed in the eBay 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.