/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::AddressType

NAME

eBay::API::XML::DataType::AddressType

DESCRIPTION

Contains the data for one user 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.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::AddressType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setAddressID()

ID assigned to the address in the eBay database. For GetOrders, applies only to Half.com.

# Argument: 'xs:string'

getAddressID()

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setAddressOwner()

The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.

# Argument: 'ns:AddressOwnerCodeType'

getAddressOwner()

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

# Returns: 'ns:AddressOwnerCodeType'

setAddressRecordType()

Indicates the nature of the address (e.g., residential or business). Not applicable to Half.com.

# Argument: 'ns:AddressRecordTypeCodeType'

getAddressRecordType()

# Returns: 'ns:AddressRecordTypeCodeType'

setAddressStatus()

PayPal address status. Not applicable to Half.com.

# Argument: 'ns:AddressStatusCodeType'

getAddressStatus()

# Returns: 'ns:AddressStatusCodeType'

setCityName()

The name of the user's city. Also applicable to Half.com (for GetOrders).

MaxLength: 64

# Argument: 'xs:string'

getCityName()

Calls: GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: ReturnAll

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetUserContactDetails
Returned: Always

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setCompanyName()

User's company name. Only returned if available. Not applicable to Half.com.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getCompanyName()

Calls: GetUserContactDetails
Returned: Always

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

# Returns: 'xs:string'

setCountry()

The country code of the user.<br> <br> If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.<br> <br> Also applicable to Half.com (for GetOrders).

Calls: SetUserPreferences
RequiredInput: No

# Argument: 'ns:CountryCodeType'

getCountry()

Calls: GetAllBidders
       GetHighBidders
       GetUserContactDetails
Returned: Always

Calls: GetBidderList
       GetUserPreferences
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress
         ShippingAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
         GranularityLevel: Fine

Context: HighBidder

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

# Returns: 'ns:CountryCodeType'

setCountryName()

The name of the user's country. Also applicable to Half.com (for GetOrders).

# Argument: 'xs:string'

getCountryName()

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setCounty()

County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getCounty()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'xs:string'

setExternalAddressID()

ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner). Also applicable to Half.com (for GetOrders).

MaxLength: 20

# Argument: 'xs:string'

getExternalAddressID()

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll

# Returns: 'xs:string'

setFirstName()

Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.

# Argument: 'xs:string'

getFirstName()

Calls: GetItem
       GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:string'

setInternationalName()

Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.

# Argument: 'xs:string'

getInternationalName()

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

# Returns: 'xs:string'

setInternationalStateAndCity()

International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.

# Argument: 'xs:string'

getInternationalStateAndCity()

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

# Returns: 'xs:string'

setInternationalStreet()

Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.

# Argument: 'xs:string'

getInternationalStreet()

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

# Returns: 'xs:string'

setLastName()

Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.

# Argument: 'xs:string'

getLastName()

Calls: GetItem
       GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:string'

setName()

User's name for the address. Also applicable to Half.com (for GetOrders).

MaxLength: 64

# Argument: 'xs:string'

getName()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetUserContactDetails
Returned: Always

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll

# Returns: 'xs:string'

setPhone()

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. Also applicable to Half.com (for GetOrders).

# Argument: 'xs:string'

getPhone()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetUserContactDetails
Returned: Always

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

Calls: GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: ReturnAll

# Returns: 'xs:string'

setPhone2()

Secondary Phone number of the lead. Not returned if information is unavailable.

# Argument: 'xs:string'

getPhone2()

Calls: GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: ReturnAll

# Returns: 'xs:string'

setPhone2AreaOrCityCode()

Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getPhone2AreaOrCityCode()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'xs:string'

setPhone2CountryCode()

Standard ISO code for the country of a user's secondary telephone phone number. For Classifed Ad format 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 format listings only.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'ns:CountryCodeType'

getPhone2CountryCode()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'ns:CountryCodeType'

setPhone2CountryPrefix()

Country prefix of a user's secondary phone number. This value is derived from inputs supplied for Phone2CountryCode. This field applies to Classified Ad format listings only.

# Argument: 'xs:string'

getPhone2CountryPrefix()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'xs:string'

setPhone2LocalNumber()

The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only. <br> <b>Note:</b> The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. Starting with API release 497, the full phone number can be entered in Phone2LocalNumber. Refer to the release notes for additional information.

MaxLength: 30

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getPhone2LocalNumber()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'xs:string'

setPhoneAreaOrCityCode()

Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getPhoneAreaOrCityCode()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'xs:string'

setPhoneCountryCode()

Standard ISO code for the country of the user's primay telephone phone number. For Classifed Ad format 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 format listings only.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'ns:CountryCodeType'

getPhoneCountryCode()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'ns:CountryCodeType'

setPhoneCountryPrefix()

Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad format listings only.

# Argument: 'xs:string'

getPhoneCountryPrefix()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'xs:string'

setPhoneLocalNumber()

The local number portion of the user's primary phone number. This field applies to Classified Ad format listings only. <br> <b>Note:</b> The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Starting with API release 497, the full phone number can be entered in PhoneLocalNumber. Refer to the release notes for additional information.

MaxLength: 30

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getPhoneLocalNumber()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

# Returns: 'xs:string'

setPostalCode()

User's postal code.<br> <br> If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.<br> <br> Also applicable to Half.com (for GetOrders).

MaxLength: 12

# Argument: 'xs:string'

getPostalCode()

Calls: GetBidderList
Returned: Conditionally

Calls: GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: ReturnAll

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
         GranularityLevel: Fine

Context: HighBidder

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress
         ShippingAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: SoldList

Calls: GetAllBidders
       GetHighBidders
Returned: Always

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setStateOrProvince()

The region of the user's address. Also applicable to Half.com (for GetOrders).

MaxLength: 64

# Argument: 'xs:string'

getStateOrProvince()

Calls: GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: ReturnAll

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetUserContactDetails
Returned: Always

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setStreet()

A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getStreet()

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

# Returns: 'xs:string'

setStreet1()

Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).

MaxLength: 100

# Argument: 'xs:string'

getStreet1()

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: ReturnAll

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'

setStreet2()

Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).<br> In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).

MaxLength: 100

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getStreet2()

Calls: GetBidderList
Returned: Conditionally
Context: ShippingAddress

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: RegistrationAddress

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: SellerContactDetails

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: ShippingAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Context: RegistrationAddress

Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: SellerPaymentAddress

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:string'