订单支付成功
| 事件分组 | 事件标识 |
|---|---|
| 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_price string订单总额,以店铺币种金额展示。
- current_total_tax string税费金额总和,以店铺币种金额展示。
customerobject
买家信息。addressesobject
买家地址信息。address1 string买家地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string买家地址的第二行。通常是公寓、套房或单元等信息。city string买家地址中的城市。country string买家地址中的国家或区域。first_name string买家地址中收件人的名。last_name string买家地址中收件人的姓。name string买家的姓名。phone string买家的手机号码。province string买家地址中的省份。province_code string地址中省份或区域的编码,该编码为系统自动生成。zip string买家地址的邮编信息。area_code string国家或地区的手机区号。currency string三位币种码,遵循 ISO 4217 国际标准。email string买家的邮箱地址。first_name string买家的名。id string买家 ID。last_name string买家的姓。phone string买家的手机号。- customer_locale string买家语种编码 + 国家或地区码。语种编码遵循 ISO 639 标准。国家或地区码遵循 ISO 3166-1 标准。无法获取到语言信息时,仅返回国家或地区代码。
- deduct_member_point_amount string当前订单会员积分抵扣金额,以店铺币种展示。数值保留到小数点后两位。
discount_applicationsobject[]
折扣信息。allocation_method string折扣的范围。有效枚举值包括:across: 按照购买总数折扣each: 按照单个商品分别折扣
示例:如一次购买三个相同的商品,折扣为 10 元。如果allocation_method为across代表三个一起减 10 元;如果allocation_method为each代表每个减 10 元。code string折扣码。description string自定义折扣的描述。target_selection string折扣范围。有效枚举值包括:explicit:单个商品维度的折扣entitled:整个商品行维度的折扣all:若target_type为line_item,折扣适用于整单;若target_type为shipping_line,折扣适用于运费
target_type string折扣应用的对象。有效枚举值包含:line_item:作用在商品上的折扣shipping_line:作用在运费上的折扣
title string自动折扣的标 题。type string折扣类型。有效枚举值包含:manual:手动折扣automatic:自动折扣discount_code:折扣码
value string折扣的具体值,以店铺币种展示。- 当
value_type为fix_amount时,此字段值表示特定的折扣金额。例如,如果值为10,商店币种为人民币,则表示折扣为 10 元。 - 当
value_type为percentage时,此字段值的值表示特定的折扣百分比。例如,10表示订单金额的 10% 折扣。
value_type string折扣值的类型。有效枚举值包含:fix_amount:固定金额折扣。例如,如果value为10,则意味着折扣为 10 元。percentage:百分比折扣。例如,如果value为10,则表示订单金额的 10% 折扣。
discount_codesobject[]
优惠码信息列表。amount string优惠金额,以店铺币种展示,数值保留到小数点后两位。code string优惠码。type string优惠类型。有效枚举值包含:减金额:全场满 100 元立减 10 元打折:全场满 100 元打 9 折免运费:满 3 件免运费加价品:需要支付额外金额任意N件优惠价:任意买 3 件商品,只需 99 元A+B组合优惠价:同时买 A 商品和 B 商品,两件一起只需 88 元赠品:购买制定商品赠送额外商品固定售价:统一售价 29 元最低价商品免费:买 3 件商品,最便宜的那件免费打包价:多件商品组合以固定总价出售第N件打折:第 2 件打 8 折买x送y:满 2 件送 1 件自定义:自定义折扣
废弃:返回的值为中文。 该字段自 API 版本 v20250601 起已废弃。- draft_order_seq string草稿单号。
- email string买家邮箱。
- financial_status string订单付款状态。有效枚举值包含:
unpaid:未支付authorized:已授权pending:处理中partially_paid:部分付款paid:已付款partially_refunded:部分退款refunded:已退款
- fulfillment_status string发货状态。有效枚举值包含:
fulfilled:已发货partial:部分发货null:未发货
fulfillmentsobject[]
发货单信息列表。id string发货单 ID。line_itemsobject[]
商品列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - redfulfillable_quantity integer商品剩余可发货数量。fulfillment_service string物流商名称。fulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
grams double重量,单位:g。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。image_url string商品图片的 URL 地址。location_id string取货地点唯一编号。name stringSKU 标题,该字段值和title一致。price string商品售价,以店铺币种展示。数值保留到小数点后两位。product_id string款式对应商品的唯一标识 ID。quantity integer订单中的商品数量。requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU。tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。variant_id string款式的唯一标识 ID。variant_title string商品款式值,多个以/分割。vendor string供应商。name string发货单编码。order_id string订单号。shipment_status string发货单物流状态。有效枚举值包含:out_for_delivery:正在配送delivered:已送达faliure:配送失败picked_up:已取货
status string发货单状态。有效枚举值包含:success:已发货cancelled:已取消
tracking_company string物流公司名称。tracking_number string第三方物流单号。tracking_url string物流公司的域名。- id string订单号,系统自定义编号。
- landing_site string记录完整的订单归因落地页的链接。
line_itemsobject[]
订单商品快照信息列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - reddiscount_allocationsobject[]
营销折扣金额,分别以买家币种金额和店铺币种金额展示。amount string营销折扣金额,数值保留到小数点后两位。discount_application_index integer标明商品行应用的折扣在discount_applications中的位置。duteisobject[]
关税信息。harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。id string关税编号。tax_linesobject[]
税费信息列表。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。rate_percentage double税率,以百分比数值形式表示,数值保留到小数点后两位。如果税率为2%,该值为2.00。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。fulfillable_quantity integer剩余可发货数量。fulfillment_service string物流商名称。fulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
gift_card boolean是否为礼品卡商品。true:是礼品卡商品false:不是礼品卡商品
grams double重量,单位:g。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。image_url string商品图片的 URL 地址。location_id string本地配送地点编号或普通配送地点编号。name stringSKU 标题,该字段值和title一致。price string商品售价,以店铺币种金额展示,数值保留到小数点后两位。product_id string款式对应商品的唯一标识 ID。propertiesobject[]
商品定制信息列表。additional string定制商品附加字段,比如当name为文字,additional可以附加文字的字号、字体、颜色等。name string自定义属性名称。type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 列表。如果type是picture,可通过urls获取缩略图,如果type是link,那么超链接为urls的第一个。value string自定义属性值。quantity integer订单中的商品数量。requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU。tags string商品标签,多个以逗号隔开。tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。type string税费类型。有效枚举值包含:product_tax: 商品税shipping_tax: 运费税
taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。variant_id string款式的唯一标识 ID。variant_title string商品属性值,多个以/分割。vendor string供应商。locationsobject[]
到店取货地点地址信息列表。location_id string取货地点唯一编号。name string取货地址名称。type string地点类型。有效枚举值包含:posLocation:POS 渠道创建该订单的门店地点,后续将废弃。建议使用pos_location_id。pickupLocation:当订单的配送方式为自提时,自提的门店地点。productLocation:订单中商品的库存地点,后续将废弃。建议使用商品行中的location_id信息。
- name string商家自定义的订单号,从 1001 开始,可以设置前缀。
- note string商家备注内容。
note_attributesobject[]
商家备注日志。name string卖家标识,表明备注来源。value string备注内容。- order_source string订单来源渠道的 handle。handle 为语义化标识符。
- order_status_url string订单状态页 URL。
payment_detailsobject[]
支付单信息列表。hidden_order boolean订单是否为已归档订单。true:已归档订单false:未归档订单
pay_amount double支付金额,以店铺币种金额展示。数值保留到小数点后两位。pay_channel_deal_id string