Skip to main content

The type that defines the fields for an address.

Types that use Address

CoreItemItem

Calls that use Address

GET
/item/{item_id}
GET
/item/get_item_by_legacy_id
GET
/item/
GET
/item/get_items_by_item_group

Fields

Field
Type
Description
addressLine1
string
The first line of the street address.

Note: This is conditionally returned in the itemLocation field.
addressLine2
string
The second line of the street address. This field is not always used, but can be used for "Suite Number" or "Apt Number".
city
string
The city of the address.
country
CountryCodeEnum
The two-letter ISO 3166 standard code for the country of the address.
county
string
The county of the address.
postalCode
string
The postal code (or zip code in US) code of the address. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API.
stateOrProvince
string
The state or province of the address.

Note: This is conditionally returned in the itemLocation field.