Customer Properties

🔒
Requires customer access scope.

Customer properties

Fields	Type	Description
`id`	string	Unique identifier for the customer.
`email`	string	Customer’s email address.
`created_at`	string	The `created_at` field records the creation time in UTC (0 timezone), formatted as ISO-8601.
`updated_at`	string	The `updated_at` field records the last update time in UTC (0 timezone), formatted as ISO-8601.
`store_id`	string	Identifier for the store associated with the customer.
`first_name`	string	Customer’s first name.
`last_name`	string	Customer’s last name.
`phone`	string	Customer’s phone number.
`tags`	string	Comma-separated tags assigned to the customer.
`deleted_at`	string	The `deleted_at` field records the deletion time in UTC (0 timezone), formatted as ISO-8601 .
`subscribed`	integer	Subscription status of the customer. 0 = Not Subscribed, 1 = Subscribed.
`registered_at`	string	The `registered_at` field records the last creation time in UTC (0 timezone), formatted as ISO-8601 .
`name`	string	Customer's full name.
`phone_area_code`	string	Phone area code associated with the customer.
`note`	string	Additional notes for the customer.
`noted_at`	string	The `noted_at` field records the last creation time in UTC (0 timezone), formatted as ISO-8601 .
`contact`	string	Contact information for the customer.
`contact_type`	string	Type of contact, e.g., `email` or `phone`.
`created_by`	string	Method of creation: Default is `default`.
`subscribed_flag`	integer	Indicates the email marketing subscription status, with values representing the source of the action. Subscription flag: 1 = Unsubscribed by business users (B-side),2 = Unsubscribed by individual users (C-side),3 = Subscribed by business users (B-side),4 = Subscribed by individual users (C-side).
`sms_subscribed_flag`	integer	Indicates the SMS marketing subscription status, with values representing the source of the action. SMS subscription flag: Values indicate the subscription state:1 = Business-side unsubscribed,2 = Individual-side unsubscribed,3 = Business-side subscribed,4 = Individual-side subscribed,5 = Subscribed via OpenAPI,6 = Unsubscribed via OpenAPI.
`customer_source`	string	Source of the customer creation.
`tax_free`	integer	Tax exemption flag: 0 = Not Exempt, 1 = Exempt.
`location_id`	string	Address ID associated with the customer.
default_address	`[address](https://www.shoplazza.dev/reference/address-properties-1#address-properties)`	Default address object for the customer.
addresses	array of `[address](https://www.shoplazza.dev/reference/address-properties-1#address-properties)`	List of all customer addresses.

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
            }
        ]
    }
}

🔒Requires customer access scope.

Customer properties

Example

🔒
Requires `customer` access scope.