查询客户分组下的所有顾客
GET https://{handle}.myshopline.com/admin/openapi/v20260301/customer_saved_searches/:id/customers.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。查询某个分组下的客户列表
路径参数
- id string required分组id例子:
GROUP5702780975899485252
查询参数
- order string排序规则 1:根据最后下单时间倒序(默认) 2:根据订单数倒序例子:
1 - page_info string分页查询的唯一标识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/customer_saved_searches/:id/customers.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。例子:eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjEsXCJzb3J0XCI6W1widWlkOmRlc2NcIl0sXCJzdG9yZUlkXCI6XCIxNjM5NjQwNTgxMzQ2XCIsXCJ1aWRcIjpcIjBcIixcImNyZWF0ZVRpbWVcIjpcIjw9MTY0OTg1NTYwMDAwMFwiLFwidXBkYXRlVGltZVwiOlwiXCJ9Iiwic2luY2VJZExpc3QiOlsiNDIwMTY4MDE5NSJdLCJwYWdlIjoyLCJzaXplIjoxLCJpbml0U29ydCI6WyJ1aWQ6ZGVzYyJdLCJzb3J0IjpbInVpZDpkZXNjIl0sImRpcmVjdGlvbiI6Im5leHQifQ - fields string限定返回的对象的字段例子:
id - limit string查询数量限制,默认50,不能超过250例子:
10
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
link
提供分页数据的 URL 链接。你可以获取该字段值中的page_info信息用于下一次分页请求中。当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制。traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
customersobject[]
客户列表accepts_marketing boolean是否接受邮件营销例子:trueaccepts_marketing_updated_at string邮件订阅时间例子:2022-05-31T15:32:46+08:00addressesobject[]
客户地址列表address1 string地址1例子:7720 Cherokee Roadaddress2 string地址2例子:Apartment 2city string三级地址例子:Hagermancountry string一级地址例子:United Statescountry_code string一级地址编码例子:UScustomer_id string使用该地址的客户id例子:4201825054default boolean是否是默认地址例子:truefirst_name string客户的名例子:Bobid string地址id例子:207119551last_name string客户的姓例子:Normanphone string电话号码例子:008615834564475province string二级地址例子:Kentuckyprovince_code string二级地址编码例子:KYzip string邮编例子:40202created_at string客户信息创建于例子:2022-09-07T10:53:31+08:00currency string币种例子:USDemail string邮件例子:123@qq.comemail_subscribe_flag integer邮箱订阅状态 0:取消订阅,1:已订阅,2:未订阅,3:确认中,4:无效,5:被删除例子:1first_name string客户用户名例子:Bobid string客户id例子:4201825054last_name string客户用户名例子:Normanlast_order_id string最近一笔订单号例子:2005473211984312275741last_order_name string最近一笔订单名称例子:order1last_order_time string最近一笔订单时间例子:2022-09-07T10:53:31+08:00mobile_subscribe_flag string手机订阅状态 0:取消订阅,1:已订阅,2:未订阅,3:确认中,4:无效,5:被删除例子:1nick_name string用户全名例子:Bob Normannote string客户备注例子:Placed an order that had a fraud warningorders_count long客户累计订单数例子:12phone string手机号例子:008615834564475state integer客户状态。0 已禁用账户;1 待启用账户;2 已邀请账户;3 有效账户例子:2tags string客户标签 英文逗号拼接例子:loyaltotal_spent string客户累计消费金额例子:100updated_at string客户信息更新于例子:2022-09-07T10:53:31+08:00verified_email boolean是否验证邮件
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?