需要 read_customers 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/v2/customers.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
顾客信息列表查询v2
查询参数
  • created_at_max string
    返回某个时间前创建的对象(格式见ISO8601)
    Example: 2022-04-13T21:13:20+08:00
  • created_at_min string
    返回某个时间后创建的对象(格式见ISO8601)
    Example: 2022-04-13T21:13:20+08:00
  • fields string
    限定返回的对象的字段
    Example: id
  • ids string
    客户ids,不同的客户id用逗号隔开
    Example: 4201825024
  • limit integer
    查询数量限制,默认50,不能超过250
    Example: 10
  • page_info string
    加密后的请求参数,用于上一页、下一页,直接取该字段解析访问
    Example: eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjEsXCJzb3J0XCI6W1widWlkOmRlc2NcIl0sXCJzdG9yZUlkXCI6XCIxNjM5NjQwNTgxMzQ2XCIsXCJ1aWRcIjpcIjBcIixcInVwZGF0ZVRpbWVcIjpcIlwifSIsInNpbmNlSWRMaXN0IjpbIjU1NTUiXSwicGFnZSI6Miwic2l6ZSI6MSwiaW5pdFNvcnQiOlsidWlkOmRlc2MiXSwic29ydCI6WyJ1aWQ6ZGVzYyJdLCJkaXJlY3Rpb24iOiJuZXh0In0
  • since_id string
    要查询的数据的起始位置(客户id取值)
    Example: 4201825024
  • updated_at_max string
    返回某个时间前更新的对象(格式见ISO8601)
    Example: 2022-04-13T21:13:20+08:00
  • updated_at_min string
    返回某个时间后更新的对象(格式见ISO8601)
    Example: 2022-04-13T21:13:20+08:00
请求头
  • Content-Type required
    字段值固定为application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
更多状态码信息请参考 HTTP 状态码

响应头
  • link
    包含上一页、下一页的请求参数
  • traceId
    traceId
响应体
  • customersobject[]
    客户列表
  • accepts_marketing boolean
    是否邮件订阅
    Example: true
  • accepts_marketing_updated_at string
    邮件订阅时间(格式见ISO8601)
    Example: 2022-04-13T21:13:20+08:00
  • accepts_mobile_marketing boolean
    是否接受电话营销
    Example: true
  • accepts_mobile_marketing_updated_at string
    电话订阅时间(格式见ISO8601)
    Example: 2022-04-13T21:13:20+08:00
  • addressesobject[]
    客户地址列表
  • address1 string
    地址1
    Example: 7720 Cherokee Road
  • address2 string
    地址2
    Example: Apartment 2
  • city string
    城市
    Example: Hagerman
  • company string
    公司
    Example: joyy
  • country string
    国家
    Example: United States
  • country_code string
    国家编码
    Example: US
  • customer_id string
    客户id
    Example: 4201825054
  • default boolean
    是否默认地址
    Example: true
  • first_name string
    名称
    Example: Bob
  • id string
    地址id
    Example: 207119551
  • last_name string
    Example: Norman
  • phone string
    电话号码
    Example: 008615834564475
  • province string
    Example: Kentucky
  • province_code string
    省编码
    Example: KY
  • zip string
    邮政编码
    Example: 40202
  • asid string
    FB登录id
    Example: 481007156599455
  • birthday string
    客户生日 格式为:YYYYMMDD
    Example: 19970102
  • created_at string
    创建时间(格式见ISO8601)
    Example: 2022-09-07T10:53:31+08:00
  • currency string
    币种
    Example: USD
  • default_addressobject
    默认地址
  • address1 string
    地址1
    Example: 7720 Cherokee Road
  • address2 string
    地址2
    Example: Apartment 2
  • city string
    城市
    Example: Hagerman
  • company string
    公司
    Example: joyy
  • country string
    国家
    Example: United States
  • country_code string
    国家编码
    Example: US
  • customer_id string
    客户id
    Example: 4201825054
  • default boolean
    是否默认地址
    Example: true
  • first_name string
    名称
    Example: Bob
  • id string
    地址id
    Example: 207119551
  • last_name string
    Example: Norman
  • phone string
    电话号码
    Example: 008615834564475
  • province string
    Example: Kentucky
  • province_code string
    省编码
    Example: KY
  • zip string
    邮政编码
    Example: 40202
  • email string
    邮箱
    Example: gungcherny@gamil.com
  • email_marketing_consentobject
    邮件营销订阅信息
  • consent_collected_from string
    订阅信息来源
    Example: pop
  • consent_updated_at string
    订阅变更时间
    Example: 2022-09-07T10:53:31+08:00
  • opt_in_level integer
    订阅方式(0
    ;1
    ;2
    )
    Example: 1
  • state integer
    订阅状态(0:取消订阅;1:已订阅;2:未订阅;3:订阅确认中)
    Example: 1
  • email_subscribe_flag integer
    邮箱订阅状态 0:取消订阅,1:已订阅,2:未订阅,3:订阅确认中,5:无效(个人信息被删除后的状态记录)
    Example: 1
  • first_name string
    用户名字
    Example: Bob
  • gender string
    性别:male / female / others/secret
    Example: female
  • id string
    客户id
    Example: 4201825054
  • language string
    客户所用语言
    Example: en
  • last_name string
    用户姓氏
    Example: Norman
  • last_order_id string
    最近一笔订单号
    Example: 2005473211984312275741
  • last_order_name string
    最近一笔自定义单号
    Example: #20279M
  • mobile_subscribe_flag integer
    手机订阅状态0:取消订阅,1:已订阅,2:未订阅
  • multipass_identifier string
    multipass标记
    Example: multipassIdentifier
  • nick_name string
    昵称
    Example: BobNorman
  • note string
    备注
    Example: Placed an order that had a fraud warning
  • orders_count long
    订单数量
    Example: 12
  • phone string
    手机号
    Example: 008615834564475
  • sms_marketing_consentobject
    短信营销订阅信息
  • consent_collected_from string
    订阅信息来源
    Example: pop
  • consent_updated_at string
    订阅变更时间
    Example: 2022-09-07T10:53:31+08:00
  • opt_in_level integer
    订阅方式(0
    ;1
    ;2
    )
    Example: 1
  • state integer
    订阅状态(0:取消订阅;1:已订阅;2:未订阅)
    Example: 1
  • social_customer array
    社媒用户id
    Example: [6612273988815231]
  • state integer
    客户状态【0 : 已禁用账户,1:待启用账户,2:已邀请账户,3:有效账户】
    Example: 2
  • tags string
    客户标签
    Example: loyal
  • total_spent string
    总花费金额
    Example: 100
  • updated_at string
    更新时间(格式见ISO8601)
    Example: 2022-09-07T10:53:31+08:00
  • verified_email boolean
    是否验证邮件
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

header required
query
query
query
query
query
query
query
query
query

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/v2/customers.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
这篇文章对你有帮助吗?

Error loading component.

Error loading component.