eBay Trading API
Call Reference Version 661

Domain (mission area) that a nonprofit charity organization belongs to. Nonprofit charity organizations may belong to multiple mission areas. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityDomain input value must be valid for that SiteID.

Region that the nonprofit charity organization is associated with. A specific nonprofit charity organization may be associated with only one region. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityRegion input value must be valid for that SiteID.

This field provides a short description about the non profit organizations primary purpose. "I want to support" will be added to the beginning of the contents of this field. For example, if the description is "the fight against cancer", then on the checkout page "I want to support the fight against cancer" will be displayed. The description may contain a maximum of 115 charecters.

Deprecated. This field will be removed from the schema in a future release. Recommended to use IsFeaturedInSYI. This boolean value should be set to true if an alternate logo URL should be supplied by sellers using the eBay Sell Your Item flow. If this field has not been set to true, it will return the default value of false.

Deprecated. This field will be removed from the schema in a future release. Recommended to use a combination of IsFeaturedInXO/DisplayAtCheckout, based on the scenario. Set this boolean value to true if the name of the nonprofit company should be shown during checkout. If this field has not been set to true, it will return the default value of false. If the user rolls their mouse over the name of the nonprofit company, they will see the nonprofit company's mission statement.

A URL with the location of the nonprofit charity organization's logo image. Logo must be JPG or GIF format, with a size maximum of 50 KB. This image is displayed in the Giving Works item listing.

An alternate URL, provided by the seller during the Sell Your Item flow with the location of the nonprofit charity organization's logo image. This URL will be returned if it exists in the eBay database. Otherwise, the field will be empty. The logo must be JPG or GIF format, with a size maximum of 50 KB. This image is displayed in the Giving Works item listing.

The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing.

A name assigned to a specified nonprofit organization.

This field must be used with the DisplayNameInCheckout field to control the options that are visible to a buyer during checkout. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to False, a checkbox with the one dollar option will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to False, no options will be displayed during checkout.

Reserved for future use. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout, but the multiple donation amount field will be set.