事件分组事件标识
customerscustomers/create
当客户被创建时触发。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • X-Shopline-Topic string required
    事件的唯一标识。
    例子: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    该请求的签名。收到请求后,你需要对该签名进行 验签 以验证数据的真实性和完整性。
    例子: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    店铺的域名。
    例子: example.myshopline.com
  • X-Shopline-Shop-Id string required
    店铺 ID。
    例子: 1610418123456
  • X-Shopline-Merchant-Id string required
    商家 ID。
    例子: 2000001234
  • X-Shopline-API-Version string required
    API 版本号。
    例子: v20250601
  • X-Shopline-Webhook-Id string required
    该 Webhook 事件的 ID。
    例子: b54557e48a5fbf7d70bcd043
请求体
  • accepts_marketing boolean
    客户是否接受通过邮件订阅营销信息。
    • true:接受
    • false:不接受
    废弃
    该字段自 API 版本 v20250601 起已废弃。
  • accepts_marketing_updated_at string
    客户邮件营销订阅状态更新的日期和时间。格式:ISO 8601
    废弃
    该字段自 API 版本 v20250601 起已废弃。
    例子: 2022-12-16T11:06:11+08:00
  • accepts_mobile_marketing boolean
    客户是否接受通过短信订阅营销信息。
    • true:接受
    • false:不接受
    废弃
    该字段自 API 版本 v20250601 起已废弃。
  • accepts_mobile_marketing_updated_at string
    客户短信营销订阅状态更新的日期和时间。格式:ISO 8601
    废弃
    该字段自 API 版本 v20250601 起已废弃。
    例子: 2022-12-16T11:06:11+08:00
  • addressesobject[]
    客户地址列表。
  • address1 string
    客户地址第一行,通常是街道地址或邮政信箱编号等信息。
    例子: 7720 Cherokee Road
  • address2 string
    客户地址的第二行,通常是公寓、套房或单元等信息。
    例子: Apartment 2
  • city string
    地址中的城市。
    例子: Hagerman
  • company string
    客户所在的公司名称。
  • country string
    地址中的国家或地区。
    例子: United States
  • country_code string
    地址中国家或地区的二位码,遵循 ISO 3166-1 (alpha 2) 国际标准。
    例子: US
  • customer_id string
    客户的唯一标识符 ID。
    例子: 2007347234
  • default boolean
    该地址是否被设置为默认地址。
    • true:默认地址
    • false:非默认地址
  • first_name string
    客户名。
    例子: Bob
  • id string
    地址的唯一标识符 ID。
    例子: SL201UA4840334721187149827
  • last_name string
    客户姓。
    例子: James
  • phone string
    客户的手机号码。
    例子: 008613987985473
  • province string
    地址中的省或州。
    例子: Kentucky
  • province_code string
    省份或州的编码。值为自定义编号或 ISO 3166-2 国际编码中连字符(-)后的部分。例如,US-RI 中的 RIGB-ENG 中的 ENG
  • zip string
    地址的邮编信息。
    例子: 40202
  • asid string
    客户通过 Facebook 授权登录后生成的应用级用户唯一 ID。
  • attributesobject[]
    在注册时收集的客户的附加信息,属性以键值对的形式存储。
  • key string
    属性的键或名称。
    例子: plugin.membership.invite_code
  • value string
    属性的值。
    例子: WELCOME
  • birthday string
    客户出生日期。格式:yyyyMMdd
    例子: 20210831
  • created_at string
    客户创建的日期和时间。格式:ISO 8601
    例子: 2022-12-16T11:06:11+08:00
  • currency string
    客户下单币种。该字段值为三位币种码,遵循 ISO 4217 标准。
    例子: USD
  • default_addressobject
    默认地址。
  • address1 string
    客户地址第一行,通常是街道地址或邮政信箱编号等信息。
    例子: 7720 Cherokee Road
  • address2 string
    客户地址的第二行,通常是公寓、套房或单元等信息。
    例子: Apartment 2
  • city string
    地址中的城市。
    例子: Hagerman
  • company string
    客户所在的公司名称。
    例子: Joy
  • country string
    地址中的国家或地区。
    例子: United States
  • country_code string
    地址中国家或地区的二位码,遵循 ISO 3166-1 (alpha 2) 国际标准。
    例子: US
  • customer_id string
    客户的唯一标识符 ID。
    例子: 2007347234
  • default boolean
    该地址是否被设置为默认地址。
    • true:默认地址
    • false:非默认地址
  • first_name string
    客户名。
    例子: Bob
  • id string
    地址的唯一标识符 ID。
    例子: SL201UA4840334721187149827
  • last_name string
    客户姓。
    例子: James
  • phone string
    客户的手机号码。
    例子: 008613977865436
  • province string
    地址中的省或州。
    例子: Kentucky
  • province_code string
    省份或州的编码。值为自定义编号或 ISO 3166-2 国际编码中连字符(-)后的部分。例如,US-RI 中的 RIGB-ENG 中的 ENG
  • zip string
    地址的邮编信息。
    例子: 40202
  • email string
    客户邮箱。
    例子: steve@example.com
  • email_marketing_consentobject
    邮件营销订阅信息。
  • consent_collected_from string
    订阅信息来源。
    例子: extInfo
  • consent_updated_at string
    订阅状态更新的日期和时间。格式:ISO 8601
    例子: 2021-08-31T02:20:26+08:00
  • opt_in_level integer
    订阅方式。有效枚举值包含:
    • 0:未知
    • 1:直接订阅
    • 2:二次确认订阅
    默认值根据 SHOPLINE 商家后台中 设置 > 客户账户 > 营销内容订阅 下是否勾选 默认勾选订阅选项 而不同:
    • 勾选:默认值为 2
    • 未勾选:默认值为 1
  • state integer
    邮件订阅状态。有效枚举值包含:
    • 0:取消订阅
    • 1:已订阅
    • 2:未订阅
  • email_subscribe_flag integer
    邮件营销最终的订阅状态。值需根据 email_marketing_consent 相关入参信息确定。有效枚举值包含:
    • 0:取消订阅
    • 1:已订阅
    • 2:未订阅
  • first_name string
    客户名。
    例子: Bob
  • gender string
    客户性别。有效枚举值包含:
    • 0:未设置
    • 1:男
    • 2:女
    • 3:保密
  • id string
    客户的唯一标识符 ID。
    例子: 2007347234
  • language string
    客户所用语言。
    例子: en
  • last_name string
    客户姓。
    例子: James
  • last_order_id string
    最近一笔订单号。
    废弃
    该字段自 API 版本 v20250601 起已废弃。
    例子: 200066283289389
  • mobile_subscribe_flag integer
    短信营销最终的订阅状态。值需根据 sms_marketing_consent 相关入参信息确定。有效枚举值包含:
    • 0:取消订阅
    • 1:已订阅
    • 2:未订阅
  • multipass_identifier string
    用于 Multipass 登录的客户的唯一标识符。
    例子: extInfo
  • nick_name string
    客户的昵称。
    例子: Bob James
  • note string
    商家对客户的备注。
  • orders_count long
    订单数量。
    废弃
    该字段自 API 版本 v20250601 起已废弃。
  • phone string
    客户的手机号码。
    例子: 008613987675435
  • sms_marketing_consentobject
    短信营销订阅信息。
  • consent_collected_from string
    订阅信息来源。
    例子: extInfo
  • consent_updated_at string
    订阅状态更新的日期和时间。格式:ISO 8601
    例子: 2022-12-16T11:06:11+08:00
  • opt_in_level integer
    订阅方式。有效枚举值包含:
    • 0:未知
    • 1:直接订阅
    • 2:二次确认订阅
  • state integer
    短信订阅状态。有效枚举值包含:
    • 0:取消订阅
    • 1:已订阅
    • 2:未订阅
  • social_customer string
    客户在社媒的唯一标识 ID。
    废弃
    该字段自 API 版本 v20250601 起已废弃。
    例子: 7566553464365
  • state string
    客户状态。有效枚举值包含:
    • 0:已禁用账户
    • 1:待邀请账户
    • 2:已邀请账户
    • 3:已注册账户
  • tags string
    为客户添加的标签,多个标签之间使用英文逗号分隔。
  • total_spent string
    总花费金额。
    废弃
    该字段自 API 版本 v20250601 起已废弃。
  • updated_at string
    客户更新的日期和时间。格式:ISO 8601
    例子: 2022-09-07T10:53:31+08:00
  • verified_email boolean
    邮箱是否已验证。
    • true:已验证
    • false:未验证
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述
这篇文章对你有帮助吗?