个人资料
修改密码
退出
当前位置： 文档中心
接口名：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 | 否 | 入库单编号，默认RK开头 | |
扩展字段 | extendProps | String | 是 | 扩展字段，可传wdt_interface（必传） status（选传）,具体用法如下： wdt_interface: stockin (接口解析参数，stockin代表查询退货入库单) status: 不传默认获取 80 已完成单据，（10已取消20编辑中30待审核60待结算80已完成） sid：卖家账号（购买ERP时由旺店通分配给ERP购买方，请从ERP购买方获取） 示例：{"wdt_interface":"stockin","status":"80","sid":"apidevnew2"} | |
路由参数 | customerid | String | 是 | 路由参数，淘宝平台发起上线后由下游自定义维护 |
![]()
4.响应参数
4.1公共响应参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 错误码 | code | string | 40 | 是 | 状态码:0表示成功,其他表示失败 |
| 错误描述 | message | String | 是 | 错误描述 | |
| 响应结果 | status | String | 是 | 响应结果，success or failure | |
| 订单数据 | data | data[ ] | 是 | 返回信息 |
4.2 data[ ]响应参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 分页信息 | page | data[ ] | 是 | 分页信息 | |
| 单据明细信息 | orderReturnListGet | data[ ] | 是 | 单据明细信息 |
4.3 page[ ]响应参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 当前页码 | pageNo | Int | 是 | 当前页码 | |
| 分页大小 | pageSize | Int | 是 | 分页大小 | |
| 总页数 | pageTotal | Int | 是 | 总页数 | |
| 总条数 | totalResult | Int | 是 | 总条数 |
4.4 orderReturnListGet[ ]响应参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 系统退换单号 | return_order_sn | string | 是 | 系统退换单号，默认TK开头 | |
| 系统入库单号 | relating_order_sn | string | 是 | 系统入库单号，默认RK开头 | |
| 状态 | pay_status | string | 是 | 状态: 10 已取消 20 编辑中 30 待审核 60 待结算 80 已完成 | |
| 入库单号创建时间 | add_time | string | 是 | 入库单号创建时间 | |
| 最后更新时间 | last_update | string | 是 | 最后更新时间 | |
| 货款总额 | return_order_amount | string | 是 | 货款总额(未扣除优化) | |
| 物流单号 | return_shipping_code | string | 是 | 物流单号 | |
| 货款总额 | return_shop_goods_amount | string | 是 | 货款总额(未扣除优化) | |
| 店铺编号 | sd_code | string | 是 | 店铺编号 | |
| 入库单类型 | lylx_name | string | 是 | 入库单类型，示例：退货入库单 | |
| 退回物流单号 | return_shipping_sn | string | 是 | 退回物流单号 | |
| 物流名称 | return_shipping_name | string | 是 | 物流名称 | |
| 邮费 | return_shipping_fee | string | 是 | 邮费 | |
| 货品总金额 | return_market_goods_amount | string | 是 | 货品总金额 | |
| 折扣 | return_discount_fee | string | 是 | 折扣 | |
| 实际退款金额 | resend_payment | string | 是 | 实际退款金额 | |
扩展字段 | extendProps | string | 是 | 扩展字段 | |
入库明细商品信息 | orderReturnDetailGets | data[ ] | 是 | 入库明细商品信息 |
4.5 orderReturnDetailGets[ ]响应参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 商家编码 | goods_sn | string | 是 | 商家编码 | |
| 品牌编号 | brand_id | string | 是 | 品牌编号 | |
| 规格码 | size_code | string | 是 | 规格码 | |
| 规格名称 | size_name | string | 是 | 规格名称 | |
| 品牌名称 | brand_name | string | 是 | 品牌名称 | |
| 入库数量 | goods_number | string | 是 | 入库数量 | |
| 货品名称 | goods_name | string | 是 | 货品名称 | |
货品售价 | ckj | string | 是 | 订单明细价格 | |
| 折扣 | discount | string | 是 | 折扣 | |
| 入库总金额 | share_price | string | 是 | 入库总金额 | |
| 扩展字段 | extendProps | string | 是 | 扩展字段 |
5.响应示例
![]()
5.1 正常响应示例
{
"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": "ｍingxinyichu",
"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": "扩展信息"
}
]
}
} |