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

Overview

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.

@ingroup ShoppingInterface

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

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




    Also applicable to Half.com (for GetOrders).

         property
  •   addressID

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

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

    (public property)

         property

Properties

addressID

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

@property (nonatomic, retain) NSString *addressID

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Shopping_AddressType.h

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Shopping_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

Shopping_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

Shopping_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

Shopping_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

Shopping_AddressType.h

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

Discussion

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

type : NSString, wrapper for primitive string

Declared In

Shopping_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

Shopping_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

Shopping_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

Shopping_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

Shopping_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

Shopping_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

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

type : NSString, wrapper for primitive string

Declared In

Shopping_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

Shopping_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

Shopping_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

Shopping_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

Shopping_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

Shopping_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

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




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.




Also applicable to Half.com (for GetOrders).

type : NSString, wrapper for primitive string

Declared In

Shopping_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

Shopping_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

Shopping_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

Shopping_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

Shopping_AddressType.h