当前位置: 文档中心


接口名:taobao.crm.order.returndetail.get(查询退换管理)    

 ¥标准    

1.接口说明  

1.1 接口描述:增量查询退换管理信息。                
1.2 适用版本:客户端 V2.4.5.0及以上版本
1.3 全量获取:该接口是增量获取退换管理数据(包含淘系数据)                            
1.4 接口说明:该接口与查询退货入库单method相同,通过扩展字段extendProps进行区分,具体查看字段说明。

2.调用场景 

  2.1 暂无                            

3.请求参数说明        

  3.1 请求地址  

环境         HTTP地址            
测试环境            http://qimen.api.taobao.com/router/qmtest          
正式环境            http://qimen.api.taobao.com/router/qm      

   3.2 公共请求参数

名称字段类型长度必须描述

奇门授权应用

app_key

String


奇门授权应用,TOP分配给应用的Appkey

接口名

method

String           


API接口名称,同上面接口名说明(固定值):taobao.crm.order.returndetail.get

目标appkey

target_app_key

String          


目标appkey,由旺店通提供

签名

sign

String 


API输入参数签名结果,签名算法介绍请点击这里

授权信息

session

String 


用户登录授权成功后,TOP颁发给应用的授权信息,详细介绍请点击这里

时间戳

timestamp

String 


时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8。淘宝API服务端允许客户端请求最大时间误差为10分钟

响应格式

format

String 


响应格式(固定值):json

API协议版本

v

String 


API协议版本(固定值):2.0

  3.3 业务请求参数

名称字段类型长度必须描述

开始时间

startModified

String


开始时间,示例:2020-01-01 00:00:00

结束时间

endModified

String


结束时间,示例:2020-01-01 00:00:00

页号

pageNo

Int


页号,分页查询的页码

分页大小

pageSize

Int



分页大小,分页查询每页数据条数

店铺编号

sd_code

String


店铺编号

退换单编号

return_order_sn

String


退换单编号,默认TK开头

扩展字段

extendProps

String



扩展字段,可传wdt_interface(必传) status(选传),具体用法如下:

wdt_interface: refund (接口解析参数,refund代表查询退换单)

status: 不传默认按照结算时间获取单据,(5 补款 10已取消 20待审核 30已同意 40已拒绝 50待财审 60待收货 63待推送 64推送失败 65委外待收货 69待收货(已结算) 70部分到货 71部分到货(已结算) 80待结算 90已完成

sid:卖家账号(购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取)

示例:{"wdt_interface":"refund","status":"90","sid":"apidevnew2"}

路由参数

customerid

String



路由参数,淘宝平台发起上线后由下游自定义维护

4.响应参数

  4.1公共响应参数

名称字段类型长度必须描述
错误码            code            String            40            是            状态码:0表示成功,其他表示失败            
错误描述messageString

错误描述  
响应结果              status
String      

响应结果,success or failure
订单数据
datadata[ ]        

是            返回信息

   4.2 data[ ]响应参数

名称字段类型长度必须描述
分页信息                  
pagedata[ ]
是             
分页信息
单据明细信息            
orderReturnListGet
data[ ]

是        
单据明细信息

 

4.3 page[ ]响应参数

名称字段类型长度必须描述
当前页码                  
pageNoInt

是       
当前页码
分页大小                  
pageSizeInt

是       
分页大小
总页数
pageTotalInt

是       
总页数
总条数
totalResult                  
Int

是       
总条数

4.4 orderReturnListGet[ ]响应参数

名称字段类型长度必须描述
系统退换单号
return_order_sn          
string

是       
系统退换单号,默认TK开头
原始订单号            
deal_codestring             

是       
原始订单号
退换单状态
pay_statusInt

是       
退换单状态(5 补款 10已取消 20待审核 30已同意 40已拒绝 50待财审 60待收货 63待推送 64推送失败 65委外待收货 69待收货(已结算) 70部分到货 71部分到货(已结算) 80待结算 90已完成
店铺编号
sd_code
string

是       
店铺编号
收件人姓名
receiver_name
string

是       
收件人姓名
退回地址
receiver_address
string

是       
退回地址
退回收件人电话
receiver_tel
string

是       
退回收件人电话
退回物流单号
return_shipping_sn     
string

是       
退回物流单号
物流名称
return_shipping_name                             
string

是       
物流名称
邮费
return_shipping_fee   
string

是       
邮费
最后更新时间
last_update
string

是       
最后更新时间
货品总金额
return_shop_goods_amount
string

是       
货品总金额
入库时间
add_time
string

是       
入库时间
国家
receiver_country
string

是       
国家,标准地址码
省份
receiver_province
string

是       
省份,标准地址码
城市
receiver_city
string

是       
城市,标准地址码
区县
receiver_district
string

是       
区县,标准地址码
实际退款金额
resend_payment
string

是       
实际退款金额
退货金额return_market_goods_amountstring
退货金额
买家申请退款金额return_order_amountstring
买家申请退款金额

扩展字段

extendProps
string

是       
扩展字段

退货明细商品信息

orderReturnDetailGets
data[ ]

是       
退货明细商品信息

换货明细商品信息

orderReturnResendDetailGets
data[ ]

是       
换货明细商品信息

4.5 orderReturnDetailGets[ ]响应参数

名称字段类型长度必须描述
商家编码                 
goods_snstring

是       
商家编码
规格码
size_codestring

是       
规格码
规格名称
size_namestring

是       
规格名称
申请退款数量           
goods_numberstring

是       
申请退款数量
货品名称goods_namestring
货品名称

货品售价                 

ckj
string

是       
订单明细价格
价格
goods_price
string

是       
价格
折扣
discount
string

是       
折扣
实收金额          
payment
string

是       
实收金额
明细退款金额
share_price
string

是       
明细退款金额
扩展字段
extendProps
string

是       
扩展字段

4.6 orderReturnResendDetailGets[ ]响应参数

名称字段类型长度必须描述
商家编码                 
goods_snstring

是       
商家编码
零售价                 
goods_pricestring

是       
零售价
换出数量
goods_numberstring

是       
换出数量
货品名称goods_namestring
货品名称
组合装或单品id
color_name
string

是       
组合装或单品id
规格码
size_code
string

是       
规格码
规格名称
size_name
string

是       
规格名称
换出货品类型
color_code
string

是       
换出货品类型

货品售价                 

ckj
string

是       
订单明细价格
实收金额          
payment
string

是       
实收金额
扩展字段
extendProps
string

是       
扩展字段

5.响应示例

   5.1 正常响应示例 

JSON
{
  "status": "success",
  "code": "0",
  "message": "invalid appkey",
  "data": {
    "page": {
      "totalResult": "1",
      "pageSize": "10",
      "pageNo": "1",
      "pageTotal": "1"
    },
    "orderReturnListGet": [
      {
        "return_order_sn": "96033100002",
        "relating_order_sn": "1603310000341",
        "deal_code": "145922643038648",
        "pay_status": "0",
        "lylx": "51",
        "return_shipping_code": "xxxxx",
        "return_shipping_sn": "xxxxxx",
        "return_shipping_name": "xxxxx",
        "return_shipping_fee": "0.00",
        "sd_code": "mingxinyichu",
        "last_update": "2016-07-11 14:12:39",
        "fhck": "000",
        "qd_code": "000",
        "qd_name": "总部",
        "add_time": "2016-03-29 12:40:30",
        "tbfx_id": "111",
        "return_user_name": "joyce",
        "receiver_name": "joyce",
        "receiver_address": "峨山路91弄",
        "receiver_tel": "13411034772",
        "receiver_mobile": "13411034772",
        "orderReturnDetailGets": [
          {
            "goods_sn": "DW16C8405A",
            "goods_number": "2",
            "brand_id": "2",
            "return_reason": "七天无理由退货",
            "return_reason_ex": "退货",
            "goods_price": "94.00",
            "goods_name": "测试商品",
            "barcode": "DW16C8405AA00240",
            "color_code": "E69",
            "color_name": "红色",
            "size_code": "000",
            "size_name": "大码",
            "brand_name": "未定义",
            "ckj": "200.0",
            "discount": "0.8",
            "payment": "200.0",
            "share_price": "198.8",
            "extendProps": "扩展信息"
          }
        ],
        "lylx_name": "淘宝",
        "return_shop_goods_amount": "200.0",
        "receiver_country": "中国",
        "receiver_province": "浙江",
        "receiver_city": "杭州",
        "receiver_district": "余杭",
        "return_order_amount": "200.0",
        "return_market_goods_amount": "250.0",
        "resend_payment": "200.0",
        "return_discount_fee": "0.8",
        "extendProps": "扩展信息"
      }
    ]
  }
}