🔒
Requires customer access scope.

Address Properties

Fields	Type	Desc
name	string	Name of consignee.
first_name	string	First name of consignee.
last_name	string	Last name of consignee.
gender	string	Gender of consignee, acceptable value: `female`, `male`
address1	string	Street address, for example: `1 Rue des Carrieres`
address2	string	Apartment/floor/room number, for example: `Suite 1234`
company	string	Company, for example: `ABC Limited`
country	string	Country, for example: `United States`
country_code	string	Country code, for example: `US`
country_name	string	Country name, for example: `United States`
province	string	Province, for example: `New Mexico`
province_code	string	Province Code, for example: `US-NM`
city	string	City, for example: `SAN JOSE`
llatitude	string	Latitude of the delivery address, for example: `22.54`
longitude	string	Longitude of the delivery address, for example: `114.06`
phone	string	Phone number, for example: `+861231231234`
phone_area_code	string	Area code, for example: `+86`
zip	string	ZIP code, for example: `87036`
email	string
area	string	Area, for example: `Bay area`
default	boolean	Default address or not
extra_info	object	Etend information
extra_info.cpf	string	Tax id
extra_info.id_number	string	ID number
extra_info.id_number_text	string	name of the ID
extra_info.tax_text	string	Tax id text

Example

{
    "address": {
        "id": "2490dc6a-d511-4e5e-bbcb-d58e913243ad",
        "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
        "first_name": "Ryan",
        "last_name": "zhang",
        "company": "ABC Limited",
        "city": "SAN JOSE",
        "province": "New Mexico",
        "country": "United States",
        "zip": "87036",
        "province_code": "NM",
        "country_code": "US",
        "gender": "male",
        "phone": "+8615015570043",
        "phone_area_code": "+86",
        "area": "Bay area",
        "email": "[email protected]",
        "name": "Ryan zhang",
        "address1": "1 Rue des Carrieres",
        "address2": "Suite 1234",
        "country_name": "United States",
        "default": true
    }
}

🔒Requires customer access scope.

Address Properties

Example

🔒
Requires `customer` access scope.