eBay Trading API893

AddressType

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.

Types that use AddressType:

Calls that use one or more fields of AddressType:

Fields



AddressAttribute ( AddressAttributeType (string) ) [0..*]
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.
See the Field Index to learn which calls use AddressAttribute.

AddressID ( string ) [0..1]
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.
See the Field Index to learn which calls use AddressID.

AddressOwner ( see AddressOwnerCodeType for possible values ) [0..1]
The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.
See the Field Index to learn which calls use AddressOwner.

AddressRecordType ( see AddressRecordTypeCodeType for possible values ) [0..1]
Not used by any call.

Indicates the nature of the address (e.g., residential or business). Not applicable to Half.com.
See the Field Index to learn which calls use AddressRecordType.

AddressStatus ( see AddressStatusCodeType for possible values ) [0..1]
Not used by any call.

PayPal address status. Not applicable to Half.com.
See the Field Index to learn which calls use AddressStatus.

AddressUsage ( see AddressUsageCodeType for possible values ) [0..1]
This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.
See the Field Index to learn which calls use AddressUsage.

CityName ( string ) [0..1]
The name of the user's city. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use CityName.

CompanyName ( string ) [0..1]
User's company name. Only returned if available. Not applicable to Half.com.
See the Field Index to learn which calls use CompanyName.

Country ( see CountryCodeType for possible values ) [0..1]
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.

Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Country.

CountryName ( string ) [0..1]
The name of the user's country. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use CountryName.

County ( string ) [0..1]
County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com.
See the Field Index to learn which calls use County.

ExternalAddressID ( string ) [0..1]
ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ExternalAddressID.

FirstName ( string ) [0..1]
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
See the Field Index to learn which calls use FirstName.

InternationalName ( string ) [0..1]
Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
See the Field Index to learn which calls use InternationalName.

InternationalStateAndCity ( string ) [0..1]
International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
See the Field Index to learn which calls use InternationalStateAndCity.

InternationalStreet ( string ) [0..1]
Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
See the Field Index to learn which calls use InternationalStreet.

LastName ( string ) [0..1]
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
See the Field Index to learn which calls use LastName.

Name ( string ) [0..1]
User's name for the address. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Name.

Phone ( string ) [0..1]
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.

Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Phone.

Phone2 ( string ) [0..1]
Secondary Phone number of the lead. Not returned if information is unavailable.
See the Field Index to learn which calls use Phone2.

Phone2AreaOrCityCode ( string ) [0..1]
Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only.
See the Field Index to learn which calls use Phone2AreaOrCityCode.

Phone2CountryCode ( see CountryCodeType for possible values ) [0..1]
Standard ISO code for the country of a user's secondary telephone phone number. For Classified 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.
See the Field Index to learn which calls use Phone2CountryCode.

Phone2CountryPrefix ( string ) [0..1]
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.
See the Field Index to learn which calls use Phone2CountryPrefix.

Phone2LocalNumber ( string ) [0..1]
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.
See the Field Index to learn which calls use Phone2LocalNumber.

PhoneAreaOrCityCode ( string ) [0..1]
Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only.
See the Field Index to learn which calls use PhoneAreaOrCityCode.

PhoneCountryCode ( see CountryCodeType for possible values ) [0..1]
Standard ISO code for the country of the user's primary telephone phone number. For Classified 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.
See the Field Index to learn which calls use PhoneCountryCode.

PhoneCountryPrefix ( string ) [0..1]
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.
See the Field Index to learn which calls use PhoneCountryPrefix.

PhoneLocalNumber ( string ) [0..1]
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.
See the Field Index to learn which calls use PhoneLocalNumber.

PostalCode ( string ) [0..1]
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.

Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use PostalCode.

ReferenceID ( string ) [0..1]
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"
See the Field Index to learn which calls use ReferenceID.

StateOrProvince ( string ) [0..1]
The region of the user's address. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use StateOrProvince.

Street ( string ) [0..1]
A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.
See the Field Index to learn which calls use Street.

Street1 ( string ) [0..1]
Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Street1.

Street2 ( string ) [0..1]
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).
See the Field Index to learn which calls use Street2.