AddressInfo

  • The address proximity criterion utilizes several fields to define a location, including postal code, province/state code and name, country code, street addresses (two lines, the second being write-only), and city name.

  • The second street address field (street_address2) is specifically used for calculating geographical coordinates (longitude and latitude) if a geo-point is not provided.

Address for proximity criterion.

Fields

postal_code

string

Postal code.

province_code

string

Province or state code.

country_code

string

Country code.

province_name

string

Province or state name.

street_address

string

Street address line 1.

street_address2

string

Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.

city_name

string

Name of the city.