创建退货单

需要 write_return 权限点。

更多权限点使用信息,请参考:

[]

访问权限

POST https://{handle}.myshopline.com/admin/openapi/v20250601/return/create.json

[]

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

[]

创建退货单开放接口

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

notify_customer boolean required
[]
是否将退货消息通知消费者 true（通知）\false（不通知）
[]
Example: true
order_seq string required
[]
订单号
[]
Example: 2132131231232
processed_at string
[]
退货实际发生时间,,格式：2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
return_line_itemsobject[] required
[]
退货商品行信息
fulfillment_id string required
[]
发货单号
[]
Example: 23131
line_item_id string required
[]
商品行ID
[]
Example: 12321
quantity integer required
[]
退货商品数量
[]
Example: 2
return_reason string
[]
商品行的退货原因： COLOR 颜色问题 DEFECTIVE 商品损坏或有缺陷 NOT_AS_DESCRIBED 商品与描述不符 OTHER 其他原因 SIZE_TOO_LARGE 尺寸太大 SIZE_TOO_SMALL 尺寸太小 STYLE 款式问题 UNWANTED 客户改变了主意 WRONG_ITEM 收到了错误的商品
[]
Example: NOT_AS_DESCRIBED
return_reason_note string
[]
商品行退货原因详细信息备注，最大支持128字符
[]
Example: Product does not match the description
return_reason string
[]
退货原因
[]
Example: 7天无理由

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

traceId
[]
traceId

响应体

returnobject
[]
退货单信息
created_at string
[]
退货单创建时间
[]
Example: 2022-11-04T10:18:46+00:00
id string
[]
退货单ID
[]
Example: 2605860580357012238342
order_id string
[]
订单ID
[]
Example: 21058605762597644309430942
return_line_itemsobject[]
[]
退货商品信息
fulfillment_id string
[]
退货单关联的发货单号
[]
Example: 22058605790725653626950942
fulfillment_line_itemobject
[]
退货单关联的发货单信息
line_itemobject
[]
发货单商品行信息
attribute string
[]
商品属性信息：名称 - 属性值，多个属性值时以逗号
[]
Example: 颜色 - 红色, 尺寸 - X
fulfillable_quantity integer
[]
剩余需要履约的商品数量
[]
Example: 1
fulfillment_service string
[]
物流商名称
[]
Example: 顺丰国际
fulfillment_status string
[]
商品行发货状态： fulfilled-已发货; partial-部分发货； null-未发货
[]
Example: fulfilled
gift_card boolean
[]
是否为礼品卡商品：false、true
[]
Example: true
grams double
[]
商品重量（克）
[]
Example: 1
id string
[]
商品行id
[]
Example: 405
image_url string
[]
商品图片链接url
[]
Example: https://image.shopline.com/abc.jpg
location_id string
[]
1）本地配送场景下取货地点唯一编号 2）非本地场景下商品地点信息
[]
Example: 5327026538935748524
name string
[]
sku标题,同title
[]
Example: 这是个好商品
price string
[]
商品售价，商品详情页销售价格
[]
Example: 100.0
product_id string
[]
spu序列号，商品唯一识别号
[]
Example: 16056898121352174690861487
propertiesobject[]
[]
商品定制信息
name string
[]
定制信息对象
[]
Example: 文字
type string
[]
定制信息类型：text、picture、link 1）当type为text时，取name和value； 2）当type为picture时，展示类型取name，同时取urls获取商品的详情缩略图 3）当type为link时，支持点击urls获取详情
[]
Example: text
urls array
[]
地址链接信息
[]
Example: https://image.shopline.com
value string
[]
定制信息内容
[]
Example: 自由
quantity string
[]
商品数量
[]
Example: 1
requires_shipping string
[]
商品是否需要发货：false、true
[]
Example: true
sku string
[]
商户自定义编号
[]
Example: SKU1234
tags string
[]
商品标签，当存在多个时用逗号分隔
[]
Example: sales
tax_linesobject[]
[]
商品税费详细信息
price string
[]
税费金额
[]
Example: 18.00
price_setobject
[]
按照店铺币种和交易币种计价的税费金额
presentment_moneyobject
[]
交易币种
amount string
[]
税费金额
[]
Example: 18.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
店铺币种
amount string
[]
税费金额
[]
Example: 18.00
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 10
title string
[]
税费名称
[]
Example: CNMP
taxable boolean
[]
商品是否含税：false、true
[]
Example: true
title string
[]
spu商品标题
[]
Example: 这是个好商品
variant_id string
[]
商品sku序列号
[]
Example: 18056898121355865678441487
variant_title string
[]
商品属性值, 多个以" / "分割
[]
Example: L/Red
vendor string
[]
商品供应商
[]
Example: 商品供应商
quantity integer
[]
发货单发货数量
[]
Example: 2
id string
[]
退货商品行号
[]
Example: RDP5860580372212396041
quantity integer
[]
退货单商品退货数量
[]
Example: 1
return_reason string
[]
退货原因
[]
Example: no reason
status string
[]
退货单状态；OPEN（退货中），CLOSED（退货完成且已退款完成）
[]
Example: OPEN

API Explorer

调试台

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "notify_customer": true,
  "order_seq": "2132131231232",
  "processed_at": "2023-04-12T22:59:52+08:00",
  "return_line_items": [
    {
      "fulfillment_id": "23131",
      "line_item_id": "12321",
      "quantity": 2,
      "return_reason": "NOT_AS_DESCRIBED",
      "return_reason_note": "Product does not match the description"
    }
  ],
  "return_reason": "7天无理由"
}

Language

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

这篇文章对你有帮助吗？

SHOPLINE

条款协议