获取顾客列表

GET /openapi/2023-10/customers

权限:read_customers

Query参数

参数名	说明	必填	类型	限制	示例
page	页码	否	[string]		1
page_size	每页数量	否	[string]		25
sort	排序	否	[string]	total / count	-total
filter[subscribed]	是否已订阅	否	[integer]	1 / 0	1
filter[type]	用户类型	否	[string]	registered / unregistered	registered
filter[date]	筛选用户注册日期	否	[string]		2019-12-14,2020-02-05
filter[country]	归属国家	否	[string]		CN
filter[search]	模糊匹配姓名、邮箱、手机	否	[string]		showme
filter[order_count]	筛选指定订单数范围	否	[string]		1,5
filter[order_total]	筛选指定订单金额范围	否	[string]		100,1000
filter[updated_date]	按时间匹配,格式如:filter[updated_date]=2019-12-14,2020-02-05，根据gmt时间匹配，自动转化店铺时区	否	[string]

示例响应内容

{
    "data": [
        {
            "ID": 177,
            "user_login": "[email protected]",
            "user_nickname": "See",
            "user_email": "[email protected]",
            "user_registered": "2021-08-13 20:29:37",
            "user_status": 2,
            "display_name": "See W",
            "first_name": "See",
            "last_name": "W",
            "phone": "210 2345 6789",
            "type": "unregistered",
            "country": "CN",
            "subscribed": false,
            "address_book": [
                {
                    "first_name": "See",
                    "last_name": "W",
                    "city": "City",
                    "address_1": "Back Street",
                    "address_2": "No.123",
                    "country": "CN",
                    "state": "State",
                    "postcode": "350000",
                    "phone": "210 2345 6789",
                    "state_name": "State Name",
                    "default": true,
                    "id": "611b580559d22"
                }
            ],
            "billing_address": {
                "country": "CN",
                "first_name": "See",
                "last_name": "W",
                "city": "City",
                "address_1": "Back Street",
                "address_2": "No.123",
                "state": "State",
                "postcode": "350000",
                "phone": "210 2345 6789",
                "state_name": "State Name"
            },
            "shipping_address": {
                "first_name": "See",
                "last_name": "W",
                "city": "City",
                "address_1": "Back Street",
                "address_2": "No.123",
                "country": "CN",
                "state": "State",
                "postcode": "350000",
                "phone": "210 2345 6789",
                "state_name": "State Name"
            },
            "order_count": "4",
            "order_total": "769.51",
            "timezone": "Asia/Shanghai",
            "billing_country": null,
            "updated_at_gmt": "2021-12-13 00:20:33"
        }
    ],
    "links": {
        "first": "https://example.hotishop.com/openapi/2023-10/customers?page=1",
        "last": "https://example.hotishop.com/openapi/2023-10/customers?page=163",
        "prev": null,
        "next": "https://example.hotishop.com/openapi/2023-10/customers?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 163,
        "path": "https://example.hotishop.com/openapi/2023-10/customers",
        "per_page": "1",
        "to": 1,
        "total": 163
    }
}