complexType "ns:CharityType" | eBay Trading API

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:CharityType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 8 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 8 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

ns:CharityName?, ns:CharityNumber?, ns:DonationPercent?, ns:CharityID?, ns:Mission?, ns:LogoURL?, ns:Status?, ns:CharityListing?, {any}*

</...>

All Direct / Indirect Based Elements (1):

ns:Charity (defined in ns:ItemType complexType)

Known Usage Locations

As direct type of elements (1):

ns:Charity (defined in ns:ItemType complexType)

Annotation

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

XML Source (w/o annotations (9); see within schema source)

<xs:complexType name="CharityType">

<xs:sequence>

<xs:element minOccurs="0" name="CharityName" type="xs:string"/>

<xs:element minOccurs="0" name="CharityNumber" type="xs:int"/>

<xs:element minOccurs="0" name="DonationPercent" type="xs:float"/>

<xs:element minOccurs="0" name="CharityID" type="xs:string"/>

<xs:element minOccurs="0" name="Mission" type="xs:string"/>

<xs:element minOccurs="0" name="LogoURL" type="xs:string"/>

<xs:element minOccurs="0" name="Status" type="ns:CharityStatusCodeType"/>

<xs:element minOccurs="0" name="CharityListing" type="xs:boolean"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 9/9)

ns:CharityID

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:CharityID>

Content:

{ xs:string }

</ns:CharityID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CharityID" type="xs:string"/>

ns:CharityListing

Type:

xs:boolean, predefined, simple content

If this field is returned as true, a percentage of order line item's purchase price will be donated to a nonprofit organization.

XML Representation Summary

<ns:CharityListing>

Content:

{ xs:boolean }

</ns:CharityListing>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CharityListing" type="xs:boolean"/>

ns:CharityName

Type:

xs:string, predefined, simple content

The full name of the nonprofit organization.

XML Representation Summary

<ns:CharityName>

Content:

{ xs:string }

</ns:CharityName>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CharityName" type="xs:string"/>

ns:CharityNumber

Type:

xs:int, predefined, simple content

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.

XML Representation Summary

<ns:CharityNumber>

Content:

{ xs:int }

</ns:CharityNumber>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CharityNumber" type="xs:int"/>

ns:DonationPercent

Type:

xs:float, predefined, simple content

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.

Percentages must increment by 5.0.
Minimum donation percentages may be required for eBay for Charity listings, see Selling to benefit nonprofit organizations for details.

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.

XML Representation Summary

<ns:DonationPercent>

Content:

{ xs:float }

</ns:DonationPercent>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DonationPercent" type="xs:float"/>

ns:LogoURL

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:LogoURL>

Content:

{ xs:string }

</ns:LogoURL>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="LogoURL" type="xs:string"/>

ns:Mission

Type:

xs:string, predefined, simple content

The stated mission of the nonprofit charity organization. This mission statement is displayed in the eBay for Charity section of the View Item page.

XML Representation Summary

<ns:Mission>

Content:

{ xs:string }

</ns:Mission>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Mission" type="xs:string"/>

ns:Status

Type:

ns:CharityStatusCodeType, simple content

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.

XML Representation Summary

<ns:Status>

Content:

{ enumeration of xs:token }

</ns:Status>

Simple Content

Enumeration:

"Valid"	-	The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.
"NoLongerValid"	-	The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Status" type="ns:CharityStatusCodeType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.