eBay Merchant Data APIVersion 1177

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.

Note: In an Add/Revise/Relist call, this CharityID should be used instead of the CharityNumber field, which is the PayPal Giving Fund's unique identifier for the nonprofit organization. The CharityNumber field will eventually be deprecated. The field is 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. If both the CharityNumber and CharityID fields are used, the CharityID takes precedence.
See the Field Index to learn which calls use CharityID.

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

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]
Not used by any call.

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 nonprofit charity organization by the PayPal Giving Fund.

Note: In an Add/Revise/Relist call, use CharityID instead, which is the unique identifier that eBay creates and assigns to the same nonprofit organization. The CharityNumber field will eventually be deprecated. If both the CharityNumber and CharityID fields are used, the CharityID takes precedence.
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]
Not used by any call.

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]
Not used by any call.

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.

Status ( CharityStatusCodeType ) [0..1]
Not used by any call.

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.