Component 
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API

complexType "ns:AddressType"
Namespace:
Content:
complex, 30 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 30 elements, elem. wildcard
Used:
at 14 locations
Component Diagram
XML Representation Summary
<...>
   
Content: 
</...>
All Direct / Indirect Based Elements (14):
ns:ShippingAddress (defined in ns:OrderType complexType),
ns:ShippingAddress (defined in ns:UserType complexType),
Known Usage Locations
Annotation
Contains the data for an eBay user's address. This is the base type for a number of user addresses, including seller payment address, buyer shipping address and buyer and seller registration address.
XML Source (w/o annotations (31); see within schema source)
<xs:complexType name="AddressType">
<xs:sequence>
<xs:element minOccurs="0" name="Name" type="xs:string"/>
<xs:element minOccurs="0" name="Street" type="xs:string"/>
<xs:element minOccurs="0" name="Street1" type="xs:string"/>
<xs:element minOccurs="0" name="Street2" type="xs:string"/>
<xs:element minOccurs="0" name="CityName" type="xs:string"/>
<xs:element minOccurs="0" name="County" type="xs:string"/>
<xs:element minOccurs="0" name="StateOrProvince" type="xs:string"/>
<xs:element minOccurs="0" name="Country" type="ns:CountryCodeType"/>
<xs:element minOccurs="0" name="CountryName" type="xs:string"/>
<xs:element minOccurs="0" name="Phone" type="xs:string"/>
<xs:element minOccurs="0" name="PhoneCountryCode" type="ns:CountryCodeType"/>
<xs:element minOccurs="0" name="PhoneCountryPrefix" type="xs:string"/>
<xs:element minOccurs="0" name="PhoneAreaOrCityCode" type="xs:string"/>
<xs:element minOccurs="0" name="PhoneLocalNumber" type="xs:string"/>
<xs:element minOccurs="0" name="PostalCode" type="xs:string"/>
<xs:element minOccurs="0" name="AddressID" type="xs:string"/>
<xs:element minOccurs="0" name="AddressOwner" type="ns:AddressOwnerCodeType"/>
<xs:element minOccurs="0" name="AddressStatus" type="ns:AddressStatusCodeType"/>
<xs:element minOccurs="0" name="ExternalAddressID" type="xs:string"/>
<xs:element minOccurs="0" name="InternationalName" type="xs:string"/>
<xs:element minOccurs="0" name="InternationalStateAndCity" type="xs:string"/>
<xs:element minOccurs="0" name="InternationalStreet" type="xs:string"/>
<xs:element minOccurs="0" name="CompanyName" type="xs:string"/>
<xs:element minOccurs="0" name="AddressRecordType" type="ns:AddressRecordTypeCodeType"/>
<xs:element minOccurs="0" name="FirstName" type="xs:string"/>
<xs:element minOccurs="0" name="LastName" type="xs:string"/>
<xs:element minOccurs="0" name="Phone2" type="xs:string"/>
<xs:element minOccurs="0" name="AddressUsage" type="ns:AddressUsageCodeType"/>
<xs:element minOccurs="0" name="ReferenceID" type="xs:string"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="AddressAttribute" type="ns:AddressAttributeType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 31/31)
ns:AddressAttribute
Type:
ns:AddressAttributeType, simple content
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
Component Diagram
XML Representation Summary
<ns:AddressAttribute
   
 = 
("ReferenceNumber" | "CustomCode")
   
>
   
Content: 
{ xs:string }
</ns:AddressAttribute>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="AddressAttribute" type="ns:AddressAttributeType"/>

ns:AddressID
Type:
xs:string, predefined, simple content
Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

Note: For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site.
XML Representation Summary
<ns:AddressID>
   
Content: 
{ xs:string }
</ns:AddressID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AddressID" type="xs:string"/>

ns:AddressOwner
Type:
ns:AddressOwnerCodeType, simple content
The realm to which the address belongs (e.g. eBay vs PayPal).
XML Representation Summary
<ns:AddressOwner>
   
Content: 
{ enumeration of xs:token }
</ns:AddressOwner>
Simple Content
Enumeration:
"PayPal"
 - 
This value indicates that the shipping address being referenced is on file with PayPal.
"eBay"
 - 
This value indicates that the shipping address being referenced is on file with eBay.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AddressOwner" type="ns:AddressOwnerCodeType"/>

ns:AddressRecordType
Type:
XML Representation Summary
<ns:AddressRecordType>
   
Content: 
{ enumeration of xs:token }
</ns:AddressRecordType>
Simple Content
Enumeration:
"Residential"
 - 
This value is not used.
"Business"
 - 
This value is not used.
"CustomCode"
 - 
This value is not used.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AddressRecordType" type="ns:AddressRecordTypeCodeType"/>

ns:AddressStatus
Type:
ns:AddressStatusCodeType, simple content
XML Representation Summary
<ns:AddressStatus>
   
Content: 
{ enumeration of xs:token }
</ns:AddressStatus>
Simple Content
Enumeration:
"None"
 - 
This value is not used.
"Confirmed"
 - 
This value is not used.
"Unconfirmed"
 - 
This value is not used.
"CustomCode"
 - 
This value is not used.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AddressStatus" type="ns:AddressStatusCodeType"/>

ns:AddressUsage
Type:
ns:AddressUsageCodeType, simple content
This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.
XML Representation Summary
<ns:AddressUsage>
   
Content: 
{ enumeration of xs:token }
</ns:AddressUsage>
Simple Content
Enumeration:
"DefaultShipping"
 - 
This value indicates that the shipping address provided by the buyer at checkout time is the buyer's default/primary shipping address.
"Shipping"
 - 
This value indicates that the shipping address provided by the buyer at checkout time is one of the buyer's secondary shipping addresses on file with eBay.
"Invalid"
 - 
This value indicates that the address is not valid, and an alternative address will have to be provided before the order is shipped.
"CustomCode"
 - 
(out) Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AddressUsage" type="ns:AddressUsageCodeType"/>

ns:CityName
Type:
xs:string, predefined, simple content
The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable.
XML Representation Summary
<ns:CityName>
   
Content: 
{ xs:string }
</ns:CityName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CityName" type="xs:string"/>

ns:CompanyName
Type:
xs:string, predefined, simple content
User's company name. This field should only be passed in or returned if applicable/defined.
XML Representation Summary
<ns:CompanyName>
   
Content: 
{ xs:string }
</ns:CompanyName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CompanyName" type="xs:string"/>

ns:Country
Type:
ns:CountryCodeType, simple content
The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.
XML Representation Summary
<ns:Country>
   
Content: 
{ enumeration of xs:token }
</ns:Country>
Simple Content
Enumeration:
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Country" type="ns:CountryCodeType"/>

ns:CountryName
Type:
xs:string, predefined, simple content
The full name of the country associated with an address on file with eBay.
XML Representation Summary
<ns:CountryName>
   
Content: 
{ xs:string }
</ns:CountryName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CountryName" type="xs:string"/>

ns:County
Type:
xs:string, predefined, simple content
The county associated with an address on file with eBay. This field should only be passed in or returned if applicable/defined.
XML Representation Summary
<ns:County>
   
Content: 
{ xs:string }
</ns:County>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="County" type="xs:string"/>

ns:ExternalAddressID
Type:
xs:string, predefined, simple content
This is a unique identifier assigned to the customer address if the address is on file with PayPal. The AddressOwner field will indicate if the address is on file with eBay or PayPal. This field will only be applicable/returned if it is a PayPal-owned address. The ID changes if a user changes their address.
XML Representation Summary
<ns:ExternalAddressID>
   
Content: 
{ xs:string }
</ns:ExternalAddressID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ExternalAddressID" type="xs:string"/>

ns:FirstName
Type:
xs:string, predefined, simple content
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType value is Commercial.
XML Representation Summary
<ns:FirstName>
   
Content: 
{ xs:string }
</ns:FirstName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="FirstName" type="xs:string"/>

ns:InternationalName
Type:
xs:string, predefined, simple content
Seller's international name that is associated with the payment address. This field is only applicable to seller payment/billing addresses.
XML Representation Summary
<ns:InternationalName>
   
Content: 
{ xs:string }
</ns:InternationalName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="InternationalName" type="xs:string"/>

ns:InternationalStateAndCity
Type:
xs:string, predefined, simple content
International state and city that is associated with the seller's payment address. This field is only applicable to seller payment/billing addresses.
XML Representation Summary
<ns:InternationalStateAndCity>
   
Content: 
{ xs:string }
</ns:InternationalStateAndCity>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="InternationalStateAndCity" type="xs:string"/>

ns:InternationalStreet
Type:
xs:string, predefined, simple content
Seller's international street address that is associated with the payment address. This field is only applicable to seller payment/billing addresses.
XML Representation Summary
<ns:InternationalStreet>
   
Content: 
{ xs:string }
</ns:InternationalStreet>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="InternationalStreet" type="xs:string"/>

ns:LastName
Type:
xs:string, predefined, simple content
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial.
XML Representation Summary
<ns:LastName>
   
Content: 
{ xs:string }
</ns:LastName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LastName" type="xs:string"/>

ns:Name
Type:
xs:string, predefined, simple content
The eBay user's name associated with an address on file with eBay.
XML Representation Summary
<ns:Name>
   
Content: 
{ xs:string }
</ns:Name>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Name" type="xs:string"/>

ns:Phone
Type:
xs:string, predefined, simple content
User's primary phone number. This may return a value of Invalid Request if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.
XML Representation Summary
<ns:Phone>
   
Content: 
{ xs:string }
</ns:Phone>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Phone" type="xs:string"/>

ns:Phone2
Type:
xs:string, predefined, simple content
Secondary Phone number of the lead. Not returned if information is unavailable.
XML Representation Summary
<ns:Phone2>
   
Content: 
{ xs:string }
</ns:Phone2>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Phone2" type="xs:string"/>

ns:PhoneAreaOrCityCode
Type:
xs:string, predefined, simple content
Area or City Code of a user's primary phone number. This field applies to Classified Ad listings only.
XML Representation Summary
<ns:PhoneAreaOrCityCode>
   
Content: 
{ xs:string }
</ns:PhoneAreaOrCityCode>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PhoneAreaOrCityCode" type="xs:string"/>

ns:PhoneCountryCode
Type:
ns:CountryCodeType, simple content
Standard ISO code for the country of the user's primary telephone phone number. For Classified Ad listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad listings only.
XML Representation Summary
<ns:PhoneCountryCode>
   
Content: 
{ enumeration of xs:token }
</ns:PhoneCountryCode>
Simple Content
Enumeration:
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PhoneCountryCode" type="ns:CountryCodeType"/>

ns:PhoneCountryPrefix
Type:
xs:string, predefined, simple content
Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad listings only.
XML Representation Summary
<ns:PhoneCountryPrefix>
   
Content: 
{ xs:string }
</ns:PhoneCountryPrefix>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PhoneCountryPrefix" type="xs:string"/>

ns:PhoneLocalNumber
Type:
xs:string, predefined, simple content
The local number portion of the user's primary phone number. This field applies to Classified Ad listings only.

Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix.
XML Representation Summary
<ns:PhoneLocalNumber>
   
Content: 
{ xs:string }
</ns:PhoneLocalNumber>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PhoneLocalNumber" type="xs:string"/>

ns:PostalCode
Type:
xs:string, predefined, simple content
User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.
XML Representation Summary
<ns:PostalCode>
   
Content: 
{ xs:string }
</ns:PostalCode>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PostalCode" type="xs:string"/>

ns:ReferenceID
Type:
xs:string, predefined, simple content
Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456"
XML Representation Summary
<ns:ReferenceID>
   
Content: 
{ xs:string }
</ns:ReferenceID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ReferenceID" type="xs:string"/>

ns:StateOrProvince
Type:
xs:string, predefined, simple content
The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined.
XML Representation Summary
<ns:StateOrProvince>
   
Content: 
{ xs:string }
</ns:StateOrProvince>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="StateOrProvince" type="xs:string"/>

ns:Street
Type:
xs:string, predefined, simple content
A concatenation of Street1 and Street2, primarily used for a registration address.
XML Representation Summary
<ns:Street>
   
Content: 
{ xs:string }
</ns:Street>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Street" type="xs:string"/>

ns:Street1
Type:
xs:string, predefined, simple content
The first line of the user's street address.

Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields.
XML Representation Summary
<ns:Street1>
   
Content: 
{ xs:string }
</ns:Street1>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Street1" type="xs:string"/>

ns:Street2
Type:
xs:string, predefined, simple content
The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).

Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields.
XML Representation Summary
<ns:Street2>
   
Content: 
{ xs:string }
</ns:Street2>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Street2" type="xs:string"/>

{any element from any namespace}
XML Source (see within schema source)
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

 Component 
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.