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:
AdFormatLeadType, BusinessSellerDetailsType, BuyerType, GetUserContactDetailsResponseType, ItemType, MultiLegShipmentType, OrderType, SellerPaymentPreferencesType, SellerType, UserType
Calls that use AddressType:
AddItem, AddItems, GetAdFormatLeads, GetAllBidders, GetBestOffers, GetItem, GetItemTransactions, GetMyeBaySelling, GetOrders, GetSellerList, GetSellerTransactions, GetUser, GetUserContactDetails, GetUserPreferences, RelistItem, ReviseItem, SetUserPreferences, VerifyAddItem, VerifyRelistItem
Fields
AddressRecordType ( AddressRecordTypeCodeType )
AddressStatus ( AddressStatusCodeType )
CompanyName ( string )
CountryName ( string )
PostalCode ( string )
ReferenceID ( string )
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.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
See the Field Index to learn which calls use AddressAttribute.
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. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
See the Field Index to learn which calls use AddressID.
AddressOwner ( AddressOwnerCodeType ) [0..1]
This enumeration value returned here indicates the company that has the address on file. The value returned here should always be
eBay.
See the Field Index to learn which calls use AddressOwner.
AddressRecordType ( AddressRecordTypeCodeType ) [0..1]
Not used by any call.
See the Field Index to learn which calls use AddressRecordType.
AddressStatus ( AddressStatusCodeType ) [0..1]
Not used by any call.
See the Field Index to learn which calls use AddressStatus.
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. See the Field Index to learn which calls use CityName.
User's company name. This field should only be passed in or returned if applicable/defined.
See the Field Index to learn which calls use CompanyName.
Country ( CountryCodeType ) [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.
If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.
See the Field Index to learn which calls use Country.
The full name of the country associated with an address on file with eBay.
See the Field Index to learn which calls use CountryName.
The county associated with an address on file with eBay. This field should only be passed in or returned if applicable/defined.
See the Field Index to learn which calls use County.
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType value is
Commercial.
See the Field Index to learn which calls use FirstName.
Seller's international name that is associated with the payment address. This field is only applicable to seller payment/billing addresses.
See the Field Index to learn which calls use InternationalName.
International state and city that is associated with the seller's payment address. This field is only applicable to seller payment/billing addresses.
See the Field Index to learn which calls use InternationalStateAndCity.
Seller's international street address that is associated with the payment address. This field is only applicable to seller payment/billing addresses.
See the Field Index to learn which calls use InternationalStreet.
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.
The eBay user's name associated with an address on file with eBay.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
See the Field Index to learn which calls use Name.
User's primary phone number. This may return a value of
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.
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.
See the Field Index to learn which calls use Phone.
Secondary Phone number of the lead. Not returned if information is unavailable.
See the Field Index to learn which calls use Phone2.
Area or City Code of a user's primary phone number. This field applies to Classified Ad listings only.
See the Field Index to learn which calls use PhoneAreaOrCityCode.
PhoneCountryCode ( CountryCodeType ) [0..1]
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.
See the Field Index to learn which calls use PhoneCountryCode.
Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad listings only.
See the Field Index to learn which calls use PhoneCountryPrefix.
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.
Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix.
See the Field Index to learn which calls use PhoneLocalNumber.
User's postal code.
See the Field Index to learn which calls use PostalCode.
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" Note: International orders being sent through eBay International Shipping also contain reference IDs, but reference IDs for eBay International Shipping will be returned in the Street2 field instead.
Example: "Reference #1234567890123456" Note: International orders being sent through eBay International Shipping also contain reference IDs, but reference IDs for eBay International Shipping will be returned in the Street2 field instead.
See the Field Index to learn which calls use ReferenceID.
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.
See the Field Index to learn which calls use StateOrProvince.
A concatenation of Street1 and Street2, primarily used for a registration address.
See the Field Index to learn which calls use Street.
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.
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.
See the Field Index to learn which calls use Street1.
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.
Note: 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. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456"
Returned if the user specified a second street value for their address.
Note: 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. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456"
See the Field Index to learn which calls use Street2.