订单支付成功
| 事件分组 | 事件标识 |
|---|---|
| orders | orders/paid |
当订单支付成功时触发。
请求头
- 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 requiredAPI 版本号。例子:
v20250601 - X-Shopline-Webhook-Id string required该 Webhook 事件的 ID。例子:
b54557e48a5fbf7d70bcd043
请求体
- adjust_price stringPOS 交易场景下因金额四舍五入带来的差额金额,用店铺币种。
billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string账单地址的第二行。通常是公寓、套房或单元等信息。city string账单地址中的城市。company string账单收件人所在的公司名称。country string账单地址中的国家或区域。first_name string账单收件人的名。last_name string账单收件人的姓。name string账单收件人的全名。phone string账单收件人的手机号。province string账单地址中的省份。province_code string地址中省份或区域的编码,该编码为系 统自动生成。standard_province_code stringzip string账单地址的邮编信息。- browser_ip string买家下单时的浏览器 IP 地址。
- buyer_note string买家留言。
- cancel_reason string卖家取消原因。
- cart_token string购物车数据的唯一标识。
- checkout_id string弃单 ID。
- checkout_token string弃单数据的唯一标识,C 端用户发起结算,会生成弃单 。
client_detailsobject
客户端详细信息。browser_ip string买家下单时的浏览器 IP 地址。session_hash string会员会话加密信息。user_agent string客户端代理。uuid stringSHOPLINE 提供的客户客户端 ID。credit_limitobject
信用支付信息。credit_limit_currency string信用额度币种,与店铺币种相同。三位币种码,遵循 ISO 4217 国际标准。is_credit_limit boolean订单是否使用了信用支付。true:有使用false:未使用
outstanding_credit_limit string占用的信用额度总和。初始和total_credit_limit相等,如果后续有类似还款操作,占用的额度则相应减少。total_credit_limit string使用的信用额度总和,即该笔订单用了多少信用额度支付。- current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。
- current_total_discounts string折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,以店铺币种展示。
current_total_discounts_setobject
折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,分别以买家币种金额和店铺币种金额展示。current_total_duties_setobject