Class AddressType


class AddressType
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.

Defined in com/ebay/shoppingservice/AddressType.js

Property Summary
String addressID
ID assigned to the address in the eBay database.
String cityName
The name of the user's city.
String companyName
User's company name.
String countryName
The name of the user's country.
String county
County information for the user.
ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner).
String firstName
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
Seller's international name that is associated with the payment address.
International state and city for the seller's payment address.
Seller's international street address that is associated with the payment address.
String lastName
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
String name
User's name for the address.
String phone
User's primary phone number.
Area or City Code of a user's secondary phone number.
Country prefix of a user's secondary phone number.
The local number portion of the user's secondary phone number.
Area or City Code of a user's primary phone number.
Country Prefix of the secondary phone number.
The local number portion of the user's primary phone number.
String postalCode
User's postal code.

If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.

Also applicable to Half.com (for GetOrders).
The region of the user's address.
String street
A concatenation of Street1 and Street2, primarily for RegistrationAddress.
String street1
Line 1 of the user's street address.
String street2
Line 2 of the user's address (such as an apartment number).

Constructor Summary
AddressType(Object props)

Property Details

property String addressID

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


property String cityName

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


property String companyName

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


property String countryName

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


property String county

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


property String externalAddressID

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


property String firstName

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


property String internationalName

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


property String internationalStateAndCity

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


property String internationalStreet

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


property String lastName

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


property String name

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


property String phone

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


property String phone2AreaOrCityCode

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


property String phone2CountryPrefix

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.


property String phone2LocalNumber

The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only.
Note: 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.


property String phoneAreaOrCityCode

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


property String phoneCountryPrefix

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.


property String phoneLocalNumber

The local number portion of the user's primary phone number. This field applies to Classified Ad format listings only.
Note: 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.


property String postalCode

User's postal code.

If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.

Also applicable to Half.com (for GetOrders).


property String stateOrProvince

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


property String street

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


property String street1

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


property String street2

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).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).


Constructor Details

constructor AddressType

AddressType(Object props)

Parameters:
props