退款创建

事件分组事件标识
refundsrefunds/create
当订单上创建新退款时就会发生，与资金流动无关。
请求头
  • 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
请求体
  • created_at string
    退款单创建时间 （格式见IOS8601）
    例子: 2022-10-03T12:44:45-04:00
  • id string
    退款id
    例子: SL201AS4571669738589065294
  • note string
    退款备注
    例子: 备注
  • order_adjustmentsobject[]
    调整单信息
  • amount string
    调整单金额
    例子: 100
  • amount_setobject
    调整单金额
  • presentment_moneyobject
    展示金额
  • amount double
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    商铺金额
  • amount double
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • id string
    退款调整单id
    例子: 2309123221222208434
  • kind string
    调整单类型
    例子: shipping_refund
  • order_id string
    订单号
    例子: 21057168152571061289431726
  • reason string
    调整原因
    例子: reason msg
  • refund_id string
    退款单id
    例子: 27057168152571061289431726
  • tax_amount string
    调整单税费金额
    例子: 100
  • tax_amount_setobject
    调整单税费金额
  • presentment_moneyobject
    展示金额
  • amount double
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    商铺金额
  • amount double
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • order_id string
    订单号
    例子: 21057168152571061289431726
  • processed_at string
    更新时间 （格式见IOS8601）
    例子: 2022-10-03T12:44:45-04:00
  • refund_line_itemsobject[]
    退款商品信息。
  • id string
    退款单号
    例子: 27057168152571061289431726
  • line_itemobject
    商品行
  • attribute string
    商品属性：名称 - 属性值 多个以逗号", "分割 如：颜色 - 红色, 尺寸 - X
    例子: 尺寸 - X
  • fulfillable_quantity integer
    可发货数量
    例子: 1
  • fulfillment_quantity integer
    已发货数量
    例子: 1
  • fulfillment_service string
    物流商名称
    例子: 走四方
  • fulfillment_status string
    商品的发货状态， 发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
    例子: partial
  • grams double
    重量（克）
    例子: 1.2
  • id string
    商品快照表的id, 系统生成，与订单号唯一确认一个商品
    例子: 2655436734527560
  • price string
    商品售价，精度2
    例子: 100
  • price_setobject
    多币种售价
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
  • currency_code string
    币种
  • product_id string
    spu序列号
    例子: 18054488231146952151833534
  • quantity integer
    商品数量
    例子: 1
  • requires_shipping boolean
    是否需要发货
    例子: true
  • sku string
    商品码，barCode
    例子: SKU1234
  • tax_linesobject[]
    税费信息
  • price string
    税费，精度2
    例子: 100
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • rate double
    税率
    例子: 1.2
  • title string
    标题
    例子: 标题
  • type string
    税费类型，product_tax：商品税 ； shipping_tax：运费税
    例子: product_tax
  • taxable boolean
    是否收税
    例子: true
  • title string
    商品标题
    例子: T-short
  • variant_id string
    商品sku序列号
    例子: 18054488231146952151833534
  • variant_title string
    商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
    例子: 155 / 红色 / 大
  • vendor string
    供应商
    例子: 供应商
  • line_item_id string
    商品快照表的id, 系统生成，与订单号唯一确认一个商品
    例子: 23312553324324
  • quantity integer
    数量,商品数量
    例子: 1
  • restock_type string
    库存返还类型,no_restock-未返还，cancel-取消， return-返还 只有未返还
    例子: no_restock
  • subtotal double
    退款金额合计，精度2
    例子: 100
  • subtotal_setobject
    退款金额合计，多币种信息，卖家和买家侧相同
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • total_tax double
    退款商品的税额，精度2
    例子: 100
  • total_tax_setobject
    总税额，多币种信息
  • presentment_moneyobject
    卖家侧币种
  • amount string
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 100
  • currency_code string
    币种
    例子: USD
  • transactionsobject[]
    退款交易信息
  • amount string
    退款金额，精度2
    例子: 100
  • created_at string
    创建时间
    例子: 2022-10-03T12:44:45-04:00
  • currency string
    币种
    例子: USD
  • id string
    退款id
    例子: 10100112220607455014540963840
  • kind string
    交易类型（authorization， capture， sale， void， refund）
    例子: refund
  • order_id string
    订单号
    例子: 21056836827909126061559008
  • processed_at string
    创建时间
    例子: 2022-10-03T12:44:45-04:00
  • status string
    处理状态, pending, failure, success, and error
    例子: success
  • user_id string
    买家id
    例子: 4323434
  • transactions_v2object[]
    退款交易单列表。
  • amount string
    string 交易单金额。数值保留到小数点后两位。
    例子: 8.00
  • create_at string
    交易单创建时间。格式：ISO 8601。
    例子: 2021-08-16T08:27:57+00:00
  • currency string
    交易币种，三位币种码，遵循 ISO 4217 国际标准。
    例子: USD
  • error_code string
    渠道返回的支付失败原因码。
    例子: RISK_PENDING
  • error_msg string
    渠道返回的支付失败内容。
    例子: PENDING_REVIEW
  • gateway string
    支付渠道。
    例子: Mypay
  • id string
    交易单 ID。
    例子: 3201270375342377769857557605
  • kind string
    交易单类型：
    • sale: 自动入账类型交易单
    • authorization: 授权类型交易单
    • capture: 手动入账类型交易单
    • void: 已作废类型交易单
    • refund: 退款类型交易单
  • payment_detailsobject
    支付详情。
  • credit_cardobject
    信用卡付款的卡详细信息。
  • credit_card_bin string
    信用卡号码
    例子: 471110
  • credit_card_brand string
    信用卡品牌。
    例子: visa
  • credit_card_expire_month string
    信用卡到期月份。
    例子: 12
  • credit_card_expire_year string
    信用卡到期年份。
    例子: 30
  • credit_card_number string
    加密的信用卡号。
    例子: 471110******0000
  • pay_channel_deal_id string
    外部渠道支付流水号。
    例子: pi_3MI897Hezv8FxjBO1uGxMPhX
  • receipt_json string
    支付渠道返回的交易收据。不同支付渠道返回的收据不一定相同。当前只支持返回礼品卡支付方式的信息。
    例子: \"gift_card_id\":30170521219516412793210045
  • payment_method string
    支付方式。
    例子: Mypay
  • status string
    交易单状态：
    • created：交易单已创建
    • pending：交易单渠道处理中
    • success：交易单已成功处理
    • fail：交易单处理失败
  • user_id string
    用户id
    例子: 16576456
状态码
收到 SHOPLINE 发送的 Webhook 通知后，你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明，请参考 Webhook 概述。
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.