AppsThemesSupport

Customer Properties

🔒

Requires customer access scope.

Customer properties

FieldsTypeDesc
idstring
emailstring
first_namestring
last_namestring
phonestring
created_atstringCreation time, formatted as ISO-8601
updated_atstringLast modification time, formatted as ISO-8601
orders_countintegerHistorical order total.
total_spentstringCumulative spending amount.

Example

{
    "customer": {
        "id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
        "first_name": "ryan",
        "last_name": "zhang",
        "name": "ryan zhang",
        "email": "[email protected]",
        "phone": "+8615014471143",
        "phone_area_code": null,
        "contact_type": "email",
        "accepts_marketing": true,
        "source": null,
        "free_tax": false,
        "registered": false,
        "orders_count": 0,
        "last_order_at": null,
        "total_spent": "0.00",
        "tags": "New Customer",
        "created_at": "2024-04-17T11:10:33Z",
        "updated_at": "2024-04-17T11:10:33Z",
        "subscribed_flag": 5,
        "sms_subscribed_flag": 5,
        "accepts_sms_marketing": true,
        "default_address": {
            "id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
            "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
            "first_name": "test",
            "last_name": "test",
            "company": "",
            "city": "深圳",
            "province": "",
            "country": "Aland lslands",
            "zip": "515300",
            "province_code": "",
            "country_code": "AX",
            "gender": "",
            "phone": "+86 150 1447 1143",
            "phone_area_code": null,
            "area": "",
            "email": "[email protected]",
            "name": "test test",
            "address1": "6 三聖街",
            "address2": "1111",
            "country_name": "Aland lslands",
            "default": true
        },
        "addresses": [
            {
                "id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
                "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
                "first_name": "test",
                "last_name": "test",
                "company": "",
                "city": "深圳",
                "province": "",
                "country": "Aland lslands",
                "zip": "515300",
                "province_code": "",
                "country_code": "AX",
                "gender": "",
                "phone": "+86 150 1447 1143",
                "phone_area_code": null,
                "area": "",
                "email": "[email protected]",
                "name": "test test",
                "address1": "6 三聖街",
                "address2": "1111",
                "country_name": "Aland lslands",
                "default": true
            }
        ]
    }
}