Address Properties


Requires customer access scope.

Address Properties

namestringName of consignee.
first_namestringFirst name of consignee.
last_namestringLast name of consignee.
genderstringGender of consignee, acceptable value: female, male
address1stringStreet address, for example: 1 Rue des Carrieres
address2stringApartment/floor/room number, for example: Suite 1234
companystringCompany, for example: ABC Limited
countrystringCountry, for example: United States
country_codestringCountry code, for example: US
country_namestringCountry name, for example: United States
provincestringProvince, for example: New Mexico
province_codestringProvince Code, for example: NM
citystringCity, for example: SAN JOSE
llatitudestringLatitude of the delivery address, for example: 22.54
longitudestringLongitude of the delivery address, for example: 114.06
phonestringPhone number, for example: +86 150 1447 1143
phone_area_codestringArea code, for example: +86
zipstringZIP code, for example: 87036
areastringArea, for example: Bay area
defaultbooleanDefault address or not
extra_infoobjectEtend information
extra_info.cpfstringTax id
extra_info.id_numberstringID number
extra_info.id_number_textstringID number text
extra_info.tax_textstringTax id text


    "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