eBay Trading APIVersion 1257
 

CharityType

This type is used to provide details about a nonprofit organization that will benefit from each sale generated from an eBay listing.

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.

The field is conditionally required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds to this organization for each sale generated by the listing.
See the Field Index to learn which calls use CharityID.

CharityListing ( boolean ) [0..1]
If this field is returned as true, a percentage of order line item's purchase price will be donated to a nonprofit organization.
See the Field Index to learn which calls use CharityListing.

CharityName ( string ) [0..1]
The full name of the nonprofit organization.

See the Field Index to learn which calls use CharityName.

CharityNumber ( int ) [0..1]
This numeric value is the unique identifier assigned to a non-profit organization when that organization registers with the PayPal Giving Fund.

Note: All registered, non-profit organizations on eBay's platform have a PayPal Giving Fund identifier (CharityNumber) and a unique eBay identifier (CharityID). However, the CharityNumber field is now deprecated in the Trading API, and is scheduled to stop being returned in GetBidderList, GetItem, GetOrderTransactions, and GetSellerList after January 15, 2023. At that time, it will be removed from the Trading WSDL. The CharityID value must be used instead in add/revise/relist calls.
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 displayed in the eBay for Charity listing. Possible values: 10.0 to 100.0. The DonationPercent field is required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds for each sale generated by the listing.
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 charity organization. This mission statement is displayed in the eBay for Charity section of the View Item page.

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.