Inherits from NSObject
Conforms to PicoBindable
Declared in Trading_AddressType.h
Trading_AddressType.m

Overview

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.

@ingroup EBayAPIInterface

Tasks

  •   name

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

         property
  •   street

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

         property
  •   street1

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

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

         property
  •   cityName

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

         property
  •   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
  •   stateOrProvince

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

         property
  •   country

    The two-digit code representing the country of the user.



    If not provided as input for GetCart or SetCart, eBay uses the country associated
    with the SiteID in effect 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).

         property
  •   countryName

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

         property
  •   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.



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

         property
  •   phoneCountryCode

    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.

         property
  •   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
  •   phoneAreaOrCityCode

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

         property
  •   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
  •   phone2CountryCode

    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.

         property
  •   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
  •   phone2AreaOrCityCode

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

         property
  •   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
  •   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.



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

         property
  •   addressID

    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.

         property
  •   addressOwner

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

         property
  •   addressStatus

    PayPal address status.
    Not applicable to Half.com.

         property
  •   externalAddressID

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

         property
  •   internationalName

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

         property
  •   internationalStateAndCity

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

         property
  •   internationalStreet

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

         property
  •   companyName

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

         property
  •   addressRecordType

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

         property
  •   firstName

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

         property
  •   lastName

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

         property
  •   phone2

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

         property
  •   addressUsage

    This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

         property
  •   referenceID

    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”

         property
  •   any

    (public property)

         property

Properties

addressID

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.

@property (nonatomic, retain) NSString *addressID

Discussion

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.

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

addressOwner

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

@property (nonatomic, retain) NSString *addressOwner

Discussion

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

type: string constant in Trading_AddressOwnerCodeType.h

Declared In

Trading_AddressType.h

addressRecordType

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

@property (nonatomic, retain) NSString *addressRecordType

Discussion

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

type: string constant in Trading_AddressRecordTypeCodeType.h

Declared In

Trading_AddressType.h

addressStatus

PayPal address status.
Not applicable to Half.com.

@property (nonatomic, retain) NSString *addressStatus

Discussion

PayPal address status.
Not applicable to Half.com.

type: string constant in Trading_AddressStatusCodeType.h

Declared In

Trading_AddressType.h

addressUsage

This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

@property (nonatomic, retain) NSString *addressUsage

Discussion

This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

type: string constant in Trading_AddressUsageCodeType.h

Declared In

Trading_AddressType.h

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_AddressType.h

cityName

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

@property (nonatomic, retain) NSString *cityName

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

companyName

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

@property (nonatomic, retain) NSString *companyName

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

country

The two-digit code representing the country of the user.



If not provided as input for GetCart or SetCart, eBay uses the country associated
with the SiteID in effect 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).

@property (nonatomic, retain) NSString *country

Discussion

The two-digit code representing the country of the user.



If not provided as input for GetCart or SetCart, eBay uses the country associated
with the SiteID in effect 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).

type: string constant in Trading_CountryCodeType.h

Declared In

Trading_AddressType.h

countryName

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

@property (nonatomic, retain) NSString *countryName

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

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 (nonatomic, retain) NSString *county

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

externalAddressID

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

@property (nonatomic, retain) NSString *externalAddressID

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

firstName

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

@property (nonatomic, retain) NSString *firstName

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

internationalName

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

@property (nonatomic, retain) NSString *internationalName

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

internationalStateAndCity

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

@property (nonatomic, retain) NSString *internationalStateAndCity

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

internationalStreet

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

@property (nonatomic, retain) NSString *internationalStreet

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

lastName

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

@property (nonatomic, retain) NSString *lastName

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

name

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

@property (nonatomic, retain) NSString *name

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

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.



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

@property (nonatomic, retain) NSString *phone

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

phone2

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

@property (nonatomic, retain) NSString *phone2

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

phone2AreaOrCityCode

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

@property (nonatomic, retain) NSString *phone2AreaOrCityCode

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

phone2CountryCode

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.

@property (nonatomic, retain) NSString *phone2CountryCode

Discussion

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.

type: string constant in Trading_CountryCodeType.h

Declared In

Trading_AddressType.h

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 (nonatomic, retain) NSString *phone2CountryPrefix

Discussion

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.

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

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 (nonatomic, retain) NSString *phone2LocalNumber

Discussion

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.

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

phoneAreaOrCityCode

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

@property (nonatomic, retain) NSString *phoneAreaOrCityCode

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

phoneCountryCode

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.

@property (nonatomic, retain) NSString *phoneCountryCode

Discussion

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.

type: string constant in Trading_CountryCodeType.h

Declared In

Trading_AddressType.h

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 (nonatomic, retain) NSString *phoneCountryPrefix

Discussion

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.

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

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 (nonatomic, retain) NSString *phoneLocalNumber

Discussion

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.

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

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.



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

@property (nonatomic, retain) NSString *postalCode

Discussion

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.



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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

referenceID

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”

@property (nonatomic, retain) NSString *referenceID

Discussion

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”

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

stateOrProvince

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

@property (nonatomic, retain) NSString *stateOrProvince

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

street

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

@property (nonatomic, retain) NSString *street

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

street1

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

@property (nonatomic, retain) NSString *street1

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h

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

@property (nonatomic, retain) NSString *street2

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Trading_AddressType.h