订单退款

需要 write_orders 权限点。

更多权限点使用信息，请参考：

POST https://{handle}.myshopline.com/admin/openapi/v20260301/order/refund.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

订单退款接口

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

notify boolean

是否发送消息通知（同现有B端退款消息发送逻辑）
例子: true
order_id string required

订单编号
例子: 21057520029298437725452511
processed_at string

退款单发起时间
例子: 格式：2023-04-12T22:59:52+08:00
refund_line_itemsobject[]

退款商品行信息，可关联多个商品行
type string required

当以商品进行退款时需要提供商品的发货状态 Unshipped：商品未发货，Returned：商品已退货
例子: Unshipped
line_item_id long

商品行id
例子: 601
location_id string

商品库存回退的地点
例子: 5409714787218633772
quantity long

试算退款商品数量
例子: 1
restock_type string

商品库存处理
例子: return
shippingobject

运费金额的退款策略
amount string

指定退款金额
例子: 1.23
full_refund boolean

是否退完剩余运费
例子: true
transactionsobject[] required

支付单退款信息
amount string

退款金额，支付单对应的结算币种金额
例子: 2.34
currency string

支付单对应的结算币种，非必填币种没传，应用会校验该笔支付单结算币种是否为店铺币种，如果不是店铺币种，就会报错，提示必须传结算币种："the input currency must be the settlement currency of the payment: X" 币种有传，则校验币种是否为该支付单的结算币种，如果不是会报错，提示："the input currency must be the settlement currency of the payment: X"
例子: USD
gateway string

支付渠道
例子: Paypal
id string

支付单号,230开头
例子: 23057520029306658561302511
kind string

支付单类型
例子: refund
type boolean

退款类型,ture:原路退款
例子: true
currency string

该退款对应订单的结算币种，非必填币种没传，应用会校验订单结算币种是否为店铺币种，如果不是店铺币种，就会报错，提示必须传结算币种："currency must be X" 币种有传，则校验币种是否为该订单的结算币种，如果不是会报错，提示："currency must be X"
例子: USD
note string

退款备注
例子: 退款

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

dataobject

数据返回体
total_duties_setobject

退款总关税
presentment_moneyobject

买家侧金额信息
amount string

金额
例子: 8.88
currency_code string

币种
例子: USD
shop_moneyobject

卖家侧金额信息
currency_code string

币种
例子: USD
amount string

金额
例子: 8.88
transactionsobject[]

退款支付单信息
processed_at string

退款单更新时间
例子: 1673404700862
status string

处理状态, pending, failure, success, and error
例子: pending
amount long

退款支付单结算币种对应的退款金额，精度2
create_at string

创建时间
例子: 1673404700862
currency string

支付币种，支付单对应的结算币种
例子: USD
id string

支付单号
例子: 23057520029306658561302511
kind string

支付单类型，此处仅为refund
例子: refund
order_id string

该调整单关联的订单号
例子: 21057520029298437725452511
create_at string

退款单创建时间
例子: 1673404700862
id string

退款单ID，唯一识别
例子: 2605755870074105241861
note string

退款备注
例子: 备注
order_adjustmentsobject[]

调整单信息
amount_setobject

按照店铺币种和交易币种计价的调整单金额
presentment_moneyobject

市场金额信息
amount string

市场金额
例子: 2.34
currency_code string

市场货币
例子: USD
shop_moneyobject

店铺金额信息
amount string

店铺金额
例子: 2.34
currency_code string

店铺货币
例子: USD
kind string

调整单类型：refund_discrepancy、shipping_refund
例子: refund_discrepancy
id string

调整单号
refund_id string

退款单ID，唯一识别
amount string

调整单金额
例子: 2.34
order_id string

该调整单关联的订单号
例子: 21057520029298437725452511
tax_amount string

调整单税费金额
例子: 978
tax_amount_setobject

按照店铺币种和交易币种计价的调整单税费金额
presentment_moneyobject

市场金额信息
amount string

市场金额信息
例子: 2.34
currency_code string

市场货币
例子: USD
shop_moneyobject

店铺金额信息
amount string

店铺金额
例子: 3.45
currency_code string

店铺货币
例子: USD
reason string

调整原因：Refund discrepancy、shipping_refund
例子: refund_discrepancy
order_id string

该退款单关联的订单号
例子: 21057520029298437725452511
refund_line_itemsobject[]

退款相关的商品行信息
subtotal string

退款商品行总金额，精度2
例子: 3.45
subtotal_setobject

按照店铺币种和交易币种计价的退款商品行总金额
presentment_moneyobject

市场金额信息
currency_code string

市场货币
例子: USD
amount string

市场金额
例子: 1.23
shop_moneyobject

店铺币种金额信息
amount string

店铺金额
例子: 2.36
currency_code string

店铺货币
例子: USD
total_tax string

退款商品行税费总金额，精度2
例子: 4.56
total_tax_setobject

按照店铺币种和交易币种计价的退款商品行税费总金额
shop_moneyobject

店铺币种金额信息
amount string

店铺金额
例子: 6.14
currency_code string

店铺货币
例子: USD
presentment_moneyobject

市场金额信息
amount string

店铺金额
例子: 3.24
currency_code string

店铺货币
例子: USD
id long

商品行id
line_item_id long

商品快照表的id, 系统生成，与订单号唯一确认一个商品
例子: 601
quantity long

退款商品数量
例子: 1
restock_type string

return-返还只有未返还
例子: return

API Explorer

调试台

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

Body

Body required

{
  "notify": true,
  "order_id": "21057520029298437725452511",
  "processed_at": "格式：2023-04-12T22:59:52+08:00",
  "refund_line_items": [
    {
      "location_id": "5409714787218633772",
      "quantity": 1,
      "restock_type": "return",
      "type": "Unshipped",
      "line_item_id": 601
    }
  ],
  "shipping": {
    "amount": "1.23",
    "full_refund": true
  },
  "transactions": [
    {
      "currency": "USD",
      "gateway": "Paypal",
      "id": "23057520029306658561302511",
      "kind": "refund",
      "type": true,
      "amount": "2.34"
    }
  ],
  "currency": "USD",
  "note": "退款"
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/order/refund.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议