版权所有©,上海海鼎信息工程股份有限公司,2016-2025,保留所有权利。
1. 接口定义
1.1. 退单服务
1.1.1. 提交退单
POST /{tenant_id}/soms/returnservice/rtn
1.1.1.1. 说明
提交退单,只支持新增退单,不支持修改退单,新增状态:confirmed,仅退款:type=refund,退款退货:type=refundAndRtn,默认type=refundAndRtn
1.1.1.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
rtn |
退单 |
1.1.1.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.1.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn?operator=string
请求 body
{
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
}
1.1.1.5. HTTP响应示例
响应 200
{
"id" : "string"
}
1.1.2. 根据平台退单号取单个有效退单
GET /{tenant_id}/soms/returnservice/rtn/front/{rtn_id}
|
operation.deprecated |
1.1.2.1. 说明
不建议使用,根据平台退单号取单个有效退单,建议使用:根据平台退单号取多个退单
1.1.2.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
rtn_id |
前端退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
parts |
需要返回的部分,多个“,”隔开,items(商品详情)、item.details(商品组合详情)、paymentDetails(退款支付明细) |
string |
Query |
platform_id |
平台ID |
string |
1.1.2.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.2.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/front/string?parts=string&platform_id=string
1.1.2.5. HTTP响应示例
响应 200
{
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
}
1.1.3. 提交退单(新版)
POST /{tenant_id}/soms/returnservice/rtn/submit
1.1.3.1. 说明
新旧提交退单接口,只有返回结果格式差异,其它逻辑一致
1.1.3.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
rtn |
退单 |
1.1.3.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.3.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/submit?operator=string
请求 body
{
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
}
1.1.3.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string",
"rtn_id" : "string"
}
1.1.4. 取指定退单
GET /{tenant_id}/soms/returnservice/rtn/{id}
1.1.4.1. 说明
取指定退单
1.1.4.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
parts |
需要返回的部分,多个“,”隔开,items(商品详情)、item.details(商品组合详情)、paymentDetails(退款支付明细)、crm(营销信息)、prom(促销详情)、item.traceCodes(溯源码) |
string |
1.1.4.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.4.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string
1.1.4.5. HTTP响应示例
响应 200
{
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
}
1.1.5. 审核退单
POST /{tenant_id}/soms/returnservice/rtn/{id}/action/approve
1.1.5.1. 说明
审核退单,审核通过:approve_state=serviceApproved,审核不通过:approve_state=serviceRefuse
1.1.5.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
退单审核请求 |
1.1.5.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.5.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/approve?operator=string
请求 body
{
"reason" : "已发货,不能退",
"approve_state" : "serviceApproved",
"operator_role" : "platform",
"turn_to_type" : "refundAndRtn",
"item_infos" : [ {
"item_id" : "string",
"order_item_id" : "string",
"item_no" : "string",
"sku_id" : "string",
"real_quantity" : 0.0,
"detail_infos" : [ {
"real_quantity" : 0.0,
"sku_id" : "string"
} ]
} ]
}
1.1.5.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.6. 取消退单
POST /{tenant_id}/soms/returnservice/rtn/{id}/action/cancel
1.1.6.1. 说明
取消退单
1.1.6.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.6.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.6.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/cancel?operator=string
请求 body
{
"sellerInfo" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"reason" : "我不想要了",
"operator_role" : "string",
"approve_state" : "none"
}
1.1.6.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.7. 修改退单的退回门店
POST /{tenant_id}/soms/returnservice/rtn/{id}/action/changestation
1.1.7.1. 说明
修改退单的退回门店
1.1.7.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.7.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.7.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/changestation?operator=string
请求 body
{
"new_station_id" : "12435453"
}
1.1.7.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.8. 确认退货状态
POST /{tenant_id}/soms/returnservice/rtn/{id}/action/deliver
1.1.8.1. 说明
确认退货状态,更新消费者退货发货return_state=customerShipped,更新商家退货收货return_state=received
1.1.8.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
退货请求对象 |
1.1.8.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.8.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/deliver?operator=string
请求 body
{
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"return_state" : "none",
"waybill_id" : "1243566215",
"carrier_note" : "note",
"operator_role" : "platform"
}
1.1.8.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.9. 修改退单
POST /{tenant_id}/soms/returnservice/rtn/{id}/action/modify
1.1.9.1. 说明
修改退单
1.1.9.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.9.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.9.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/modify?operator=string
请求 body
{
"rtnId" : "4356465768",
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"freight" : 12.03,
"modify_item_detail" : false,
"apply_reason" : "不想要了",
"customer_note" : "haha",
"voucher_urls" : [ "string" ],
"settle_amount" : 12.03,
"settle_commission" : 12.03,
"refund_extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"package_total" : 12.03,
"address_change_fee" : 10.01,
"carrier_type" : "self"
}
1.1.9.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.10. 通知仓库
POST /{tenant_id}/soms/returnservice/rtn/{id}/action/notifywrh
1.1.10.1. 说明
通知仓库
1.1.10.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.10.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.10.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/notifywrh?operator=string
1.1.10.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.11. 确认退款
POST /{tenant_id}/soms/returnservice/rtn/{id}/action/refund
1.1.11.1. 说明
确认退款
1.1.11.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.11.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.11.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/refund?operator=string
请求 body
{
"refundState" : "refunded",
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"operator_role" : "platform"
}
1.1.11.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.12. 修改退单权益接口
POST /{tenant_id}/soms/returnservice/rtn/{id}/mod/crminfo
1.1.12.1. 说明
修改退单权益接口
1.1.12.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
权益请求 |
1.1.12.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.12.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/mod/crminfo?operator=string
请求 body
{
"score" : 0.0
}
1.1.12.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.13. 修改退单的退款信息
POST /{tenant_id}/soms/returnservice/rtn/{id}/refund/update
1.1.13.1. 说明
修改退单的退款信息
1.1.13.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.13.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.13.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/refund/update?operator=string
请求 body
{
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ]
}
1.1.13.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.14. 修改退单的结算信息
POST /{tenant_id}/soms/returnservice/rtn/{id}/settleinfo/update
1.1.14.1. 说明
修改退单的结算信息
1.1.14.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.14.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.14.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/settleinfo/update?operator=string
请求 body
{
"settlable" : true,
"settle_date" : "2020-06-17 10:00:00"
}
1.1.14.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.15. 修改退单的溯源码信息
POST /{tenant_id}/soms/returnservice/rtn/{id}/tracecode/update
1.1.15.1. 说明
修改退单的溯源码信息
1.1.15.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.15.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.15.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/tracecode/update?operator=string
请求 body
{
"items" : [ {
"details" : [ {
"id" : "string",
"trace_code_list" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"item_no" : "string",
"sku_id" : "string",
"item_id" : "string",
"trace_code_list" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ]
}
1.1.15.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.16. 修改退回物流信息
POST /{tenant_id}/soms/returnservice/rtn/{id}/updatertndelivery
1.1.16.1. 说明
修改退回物流信息
1.1.16.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
id |
退单id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
请求对象 |
1.1.16.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.16.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/updatertndelivery?operator=string
请求 body
{
"state" : "received",
"carrier" : {
"id" : "string",
"name" : "string"
},
"mobile" : "18859540085",
"waybill_id" : "43444444444232323"
}
1.1.16.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.17. 根据销售退申请单号取退单
GET /{tenant_id}/soms/returnservice/rtn/{rtn_req_id}/getsByRtnReq
1.1.17.1. 说明
根据销售退申请单号取退单
1.1.17.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
rtn_req_id |
销售退申请单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
parts |
需要返回的部分,取值范围:items(商品详情) |
string |
1.1.17.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.17.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/getsByRtnReq
1.1.17.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
} ]
}
1.1.18. 批量取退单
GET /{tenant_id}/soms/returnservice/rtns
1.1.18.1. 说明
批量取退单
1.1.18.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
parts |
需要返回的部分,多个“,”隔开,items(商品详情)、item.details(商品组合详情)、paymentDetails(退款支付明细) |
string |
Query |
rtnIds |
退单订单号集合,最多100个 |
< string > array(multi) |
1.1.18.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.18.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns?rtnIds=string
1.1.18.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
} ]
}
1.1.19. 根据平台退单号取多个退单
GET /{tenant_id}/soms/returnservice/rtns/front/{front_rtn_id}
1.1.19.1. 说明
根据平台退单号取多个退单
1.1.19.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
front_rtn_id |
前端退单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
parts |
需要返回的部分,多个“,”隔开,items(商品详情)、item.details(商品组合详情)、paymentDetails(退款支付明细) |
string |
Query |
platform_id |
平台ID |
string |
1.1.19.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.19.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/front/string?parts=string&platform_id=string
1.1.19.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
} ]
}
1.1.20. 查指定平台订单的退单
GET /{tenant_id}/soms/returnservice/rtns/frontorder
1.1.20.1. 说明
查指定平台订单的退单
1.1.20.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
order_id |
订单ID |
string |
Query |
platform_id |
平台ID |
string |
1.1.20.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.20.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/frontorder?order_id=string&platform_id=string
1.1.20.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
} ]
}
1.1.21. 查指定订单的退单
GET /{tenant_id}/soms/returnservice/rtns/order
1.1.21.1. 说明
查指定订单的退单,默认不返回退单商品明细等关联信息,需要取关联信息,传parts
1.1.21.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
order_id |
订单ID |
string |
Query |
parts |
需要返回的部分,多个“,”隔开,items(商品详情)、item.details(商品组合详情)、paymentDetails(退款支付明细) |
string |
1.1.21.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.21.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/order?order_id=string
1.1.21.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
} ]
}
1.1.22. 查指定订单的退单
POST /{tenant_id}/soms/returnservice/rtns/orders
1.1.22.1. 说明
查指定订单的退单
1.1.22.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
parts |
需要返回的部分,多个“,”隔开,items(商品详情)、item.details(商品组合详情)、paymentDetails(退款支付明细) |
string |
Body |
order_id |
订单ID |
< string > array |
1.1.22.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.22.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
} ]
}
1.1.23. 批量获取退单打印(JPOS打印方)
GET /{tenant_id}/soms/returnservice/rtns/printbills
|
operation.deprecated |
1.1.23.1. 说明
批量获取退单打印(JPOS打印方)
1.1.23.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
ids |
退单号集合 |
< string > array(multi) |
Query |
name |
打印联的名称,为空则打印全部联。取值有:外卖退单 |
string |
1.1.23.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.23.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/printbills?ids=string
1.1.23.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"time" : "2016-03-02 12:00:01",
"rtn_id" : "20160122000006",
"front_rtn_id" : "20160122000006"
} ]
}
1.1.24. 查询退单(ES查询)
POST /{tenant_id}/soms/returnservice/rtns/query
1.1.24.1. 说明
查询退单(ES查询,推荐使用),注意避免深度分页
1.1.24.2. 参数
| 类型 | 名称 | 说明 | 类型 |
|---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
desc |
倒序 |
boolean |
Query |
page |
页码 |
integer (int32) |
Query |
page_size |
分页大小 |
integer (int32) |
Query |
sort_key |
排序字段 created、modified、front_created |
string |
Body |
filter |
查询条件 |
1.1.24.3. 响应
| HTTP代码 | 说明 | 类型 |
|---|---|---|
200 |
successful operation |
1.1.24.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/query?desc=true&page=0&page_size=0
请求 body
{
"appeal" : false,
"platform_id" : "jdo2o",
"platform_ids" : "jdo2o",
"order_id" : "123456",
"order_id_in" : "123456",
"rtn_Id" : "123456",
"shop_id" : "12348522",
"station_id" : "12345",
"front_order_id" : "323434",
"front_rtn_id" : "3232434",
"customer_Name" : "张三",
"customer_Mobile" : "18587887789",
"customer_mobile_like" : "7789",
"types" : [ "refund" ],
"states" : [ "confirmed" ],
"carrier_states" : [ "initial" ],
"carrier_types" : [ "self" ],
"approve_states" : [ "none" ],
"return_states" : [ "none" ],
"refund_states" : [ "none" ],
"station_ids" : [ "string" ],
"product_contains" : "sku2323",
"front_created_start" : "2016-03-02 12:00:02",
"front_created_end" : "2016-03-02 12:00:02",
"created_start" : "2016-03-02 12:00:02",
"created_end" : "2016-03-02 12:00:02",
"deliver_rtn_start" : "2016-03-02 12:00:02",
"deliver_rtn_end" : "2016-03-02 12:00:02",
"waybill_id" : "32323434",
"index_modified_start" : "2016-03-02 12:00:02",
"index_modified_end" : "2016-03-02 12:00:02",
"pre_page" : 1,
"has_exception" : false,
"front_sku_id" : "3234",
"rtn_ids" : [ "string" ],
"sku_id" : "232323",
"has_billing" : false,
"bill_id_like" : "3454545",
"bill_id_eq" : "32323434",
"app_id_eq" : "3232323",
"front_station_order_no_eq" : "3232323",
"pick_info_operator_id_eq" : "string",
"pick_info_operator_id_in" : [ "string" ],
"pick_info_operator_name_like" : "string",
"vendor_code_eq" : "3232323",
"vendor_code_start_with" : "3232323",
"vendor_code_in" : "3232323",
"wrh_id_start_with" : "3232323",
"wrh_id_in" : "3232323",
"station_type" : "wrh",
"refund_phase" : "aftersale",
"fake_refund_date" : "2016-03-02"
}
1.1.24.5. HTTP响应示例
响应 200
{
"total" : 0,
"page" : 0,
"rtns" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "0002",
"shop" : {
"id" : "string",
"name" : "string"
},
"type" : "refund",
"state" : "confirmed",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
}
},
"delivery" : {
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"state" : "none",
"returner" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "张*红",
"private_mobile" : "189****0000"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"expected_logistics_type" : "crowdsourcing",
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"station_type" : "string",
"carrier_note" : "note",
"wrh_rtn_id" : "XXXXXXXXX",
"waybill_id" : "XXXXXXXXX",
"return_mobile" : "18856556655"
},
"refund" : {
"state" : "none",
"freight" : 12.03,
"amount" : 12.03,
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"payments" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"amount" : 12.33,
"score" : 100.0,
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"classification" : "normal",
"refund_phase" : "aftersale",
"part_refund" : false,
"settle_fieight" : 12.03,
"settle_amount" : 12.03,
"package_total" : 12.03,
"settle_commission" : 2.0,
"shop_amount" : 120.01
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:02",
"modified" : "2016-03-02 12:00:02",
"state" : "已退货",
"stationName" : "254145",
"creator" : "254145",
"source" : "平台生成:platform、商家发起:shop",
"rtn_id" : "123456",
"return_state" : "string",
"station_id" : "254145",
"order_finished" : "2020-06-17 10:00:00"
},
"appeal" : false,
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 2.0,
"total" : 12.03,
"details" : [ {
"id" : "01123",
"title" : "01123",
"quantity" : 0.01,
"ratio" : 2.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"item_no" : "1",
"sku_id" : "123456",
"product_id" : "2123",
"item_title" : "冰红茶",
"real_qty" : 0.0,
"unit_price" : 12.03,
"purchase_price" : 12.0,
"refund_amount" : 12.03,
"settle_price" : 12.03,
"settle_total" : 12.03,
"front_sku_id" : "e235346ger545",
"front_item_id" : "052700601",
"image_url" : "http://1213323.png",
"front_unit" : "string",
"origin_sku_id" : "e235346ger545",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_spec" : "122.22",
"orig_unit" : "122.22",
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221"
},
"shop_price" : 11.22,
"shop_total" : 11.22,
"item_id" : "22323232323",
"is_collocation" : false,
"relation_item_id" : "2123",
"order_item_id" : "1",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"relation_sku_id" : "2123",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"trace_code_details" : [ {
"type" : "normal(普通),expDate(效期)",
"barcode" : "123",
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"orig_mas_sku_id" : "string",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]",
"extra_info" : "{\"thirdType\": \"42\"}"
} ]
},
"tags" : [ {
"name" : "首单"
} ],
"member_info" : {
"card_no" : "22323"
},
"apply_id" : "0002",
"apply_system" : "shop(商家)、customer(消费者)",
"customer_note" : "haha",
"order_id" : "3232320003",
"approve_state" : "none",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"apply_reason" : "不想要了",
"cancel_reason" : "又想要了",
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "异常说明",
"exception_time" : "2020-11-11 12:11:21",
"seller_info" : {
"seller_note" : "收货失败原因",
"seller_voucher_urls" : "卖家收货失败凭证:图片地址"
},
"voucher_urls" : [ "string" ],
"sku_quantity" : 1.0,
"crm_info" : {
"coupon_info" : {
"details" : "[]",
"use_total" : 1.0
},
"score_info" : {
"total" : 1.0,
"balance" : 100.0
}
},
"wrh_state" : "initial",
"wrh_id" : "string",
"print_bills" : [ {
"name" : "外卖订单",
"title" : "外卖订单",
"content" : "内容",
"created" : "2020-06-17 10:00:00",
"printer" : "string",
"outerId" : "string",
"deleted" : true,
"type" : "string",
"ticket_type" : "小票",
"deleted_time" : "2020-06-17 10:00:00",
"sku_id" : "string"
} ],
"settle_info" : {
"settlable" : true,
"settle_date" : "2022-08-25 00:00:00",
"station_settle_mode" : "online"
},
"rtn_req_id" : "string",
"req_id" : "string",
"address_change_fee" : 120.01,
"settle_unit" : {
"type" : "store",
"code" : "0001",
"name" : "门店1"
}
} ],
"page_count" : 0,
"page_size" : 0
}
2. 定义
2.1. ActionResult
| 名称 | 说明 | 类型 |
|---|---|---|
code |
样例 : |
string |
message |
样例 : |
string |
success |
默认值 : |
boolean |
2.2. Address
地址信息
| 名称 | 说明 | 类型 |
|---|---|---|
city |
市 |
string |
coordinate_type |
坐标类型,BD09:百度坐标, GCJ02:火星坐标,WGS84:WGS84坐标 |
string |
country |
国家 |
string |
district |
区 |
string |
latitude |
纬度 |
number |
longtitude |
经度 |
number |
postcode |
邮编 |
string |
private_street |
脱敏地址 |
string |
province |
省份 |
string |
street |
详细地址 |
string |
2.4. CRMInfoModificationRequest
| 名称 | 说明 | 类型 |
|---|---|---|
score |
样例 : |
number |
2.5. CancelRtnRequest
取消退货请求对象
| 名称 | 说明 | 类型 |
|---|---|---|
approve_state |
样例 : |
enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) |
operator_role |
样例 : |
string |
reason |
取消原因 |
string |
sellerInfo |
收货失败:原因/凭证 |
2.6. Carrier
承运商
| 名称 | 说明 | 类型 |
|---|---|---|
carrier |
承运平台 |
|
delivery_id |
配送活动标识 |
string |
delivery_name |
配送活动名称 |
string |
deliveryman |
送货员 |
|
deliveryman_mobile |
送货员手机 |
string |
exception_reason |
承运异常原因 |
string |
expected_logistics_type |
期望承运物流类型,取值范围:express(快递)、crowdsourcing(众包)。快递:如圆通,中通等;众包:如美团,蜂鸟,达达等 |
string |
merchant |
承运商家 |
|
state |
承运状态,取值范围:initial(初始状态)、created(已下发)、createdFailed(下发失败)、dispatched(已派单)、arrived(骑手已到店)、pickup(已揽件)、pickupFailed(揽件失败)、delivering(配送中)、delivered(配送完成)、canceled(已取消) |
enum (initial, created, dispatched, createdFailed, arrived, pickup, pickupFailed, delivering, delivered, canceled) |
type |
承运商类型,取值范围:self(门店自送)、thirdparty(平台配送)、express(物流配送) |
enum (self, thirdparty, express) |
2.8. CodeName
| 名称 | 说明 | 类型 |
|---|---|---|
code |
样例 : |
string |
name |
样例 : |
string |
2.9. ConfirmRefundRequest
确认退款请求对象
| 名称 | 说明 | 类型 |
|---|---|---|
operator_role |
操作角色:platform(平台) |
string |
payments |
退款支付明细 |
< RefundPayment > array |
refundState |
退款状态,none(未退款),refunded(已退款) |
enum (none, refunded) |
2.10. CouponDetail
券信息
| 名称 | 说明 | 类型 |
|---|---|---|
amount |
实际抵用金额 |
number |
code |
券号 |
string |
name |
券名称 |
string |
type |
cash(现金券)、discount(折扣券) |
string |
type_id |
券类型代码 |
string |
use_mode |
用券形式:pay(支付)、discount(优惠) |
string |
value |
折扣率或者现金面额 |
number |
2.11. CouponInfo
券信息
| 名称 | 说明 | 类型 |
|---|---|---|
details |
券使用详情 |
< CouponDetail > array |
use_total |
券抵用总金额 |
number |
2.13. DiscountSettleDetail
优惠结算详情
| 名称 | 说明 | 类型 |
|---|---|---|
discount |
承担优惠金额 |
number |
role |
优惠承担方 |
string |
2.14. DiscountShareDetail
整合优惠结算详情
| 名称 | 说明 | 类型 |
|---|---|---|
discount |
承担优惠金额 |
number |
type |
类型 |
string |
2.15. ExtraField
自定义字段
| 名称 | 说明 | 类型 |
|---|---|---|
id |
自定义id |
string |
name |
自定义名称 |
string |
value |
自定义值 |
string |
2.16. FavDetail
优惠详情
| 名称 | 说明 | 类型 |
|---|---|---|
amount |
优惠金额 |
number |
batch_act_id |
批次维度的活动ID |
string |
child_type |
优惠子类型 |
string |
extra_info |
扩展信息,json格式。 |
string |
factor |
优惠参与信息 |
|
id |
优惠ID |
string |
merchant_act_id |
商家活动ID |
string |
name |
活动名称 |
string |
prom_cls |
促销来源类型 |
string |
remark |
优惠说明 |
string |
settle_details |
优惠结算分摊详情 |
< DiscountSettleDetail > array |
share_details |
多方整合优惠分摊信息 |
< DiscountShareDetail > array |
sku_act_id |
商品维度的活动ID |
string |
type |
优惠类型 |
string |
voucher_code |
凭证代码 |
string |
2.17. FavFactor
优惠参与信息
| 名称 | 说明 | 类型 |
|---|---|---|
qty |
本商品参与促销总数量 |
number |
sku_items |
来源商品参与优惠明细 |
< FavFactorItem > array |
total |
本商品参与促销总金额 |
number |
2.18. FavFactorItem
参与优惠商品明细
| 名称 | 说明 | 类型 |
|---|---|---|
amount |
参与促销金额 |
number |
item_id |
行标识 |
string |
item_no |
行号 |
integer (int32) |
qty |
参与促销数量 |
number |
2.19. FrontRtn
平台退货信息
| 名称 | 说明 | 类型 |
|---|---|---|
app |
平台应用id |
|
created |
退单申请时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
creator |
创建人 |
string |
modified |
退单最后修改时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
order_finished |
订单完成时间,临时字段,不存储 |
string (date-time) |
platform |
平台 |
|
return_state |
样例 : |
string |
rtn_id |
平台退货单号 |
string |
source |
来源 |
string |
state |
平台退换货状态 |
string |
stationName |
平台门店名称 |
string |
station_id |
平台门店代码 |
string |
2.20. IdName
| 名称 | 说明 | 类型 |
|---|---|---|
id |
样例 : |
string |
name |
样例 : |
string |
2.21. IdWrapper
| 名称 | 说明 | 类型 |
|---|---|---|
id |
样例 : |
string |
2.22. ItemPromotion
商品行促销信息
| 名称 | 说明 | 类型 |
|---|---|---|
apported_discount_amount |
整单优惠分摊金额 |
number |
discount_amount |
商品优惠金额 |
number |
favs |
优惠详情 |
< FavDetail > array |
2.23. OrderItemTraceCodeDetail
溯源码
| 名称 | 说明 | 类型 |
|---|---|---|
barcode |
条码 |
string |
batch_no |
批号 |
string |
code |
溯源码 |
string |
production_date |
生产日期 |
string (date-time) |
qpc_str |
规格 |
string |
qty |
数量 |
number |
type |
类型,默认是normal |
string |
valid_date |
有效期 |
string (date-time) |
2.24. OrderPackageInfo
订单打包信息
| 名称 | 说明 | 类型 |
|---|---|---|
details |
包装明细 |
< PackageDetail > array |
package_type |
指定打包袋类型:保温袋、纸袋、PLA环保袋 |
string |
required |
是否需要打包袋 |
boolean |
type |
单据类型 |
string |
2.26. PackageDetail
打包商品明细
| 名称 | 说明 | 类型 |
|---|---|---|
amount |
打包袋金额 |
number |
qty |
打包袋数量 |
number |
sku_id |
打包袋ID |
string |
sku_name |
打包袋名称 |
string |
2.27. PrintBill
打印单据
| 名称 | 说明 | 类型 |
|---|---|---|
content |
内容 |
string |
created |
单据创建时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
deleted |
默认值 : |
boolean |
deleted_time |
样例 : |
string (date-time) |
name |
模板小票名称 |
string |
outerId |
外部Id,目前作为yilianyun打印的唯一标识 |
string |
printer |
打印机类型:JPOS(JPOS打印机),yilianyun(易联云打印机),默认JPOS |
string |
sku_id |
样例 : |
string |
ticket_type |
票据类型:小票、杯贴 |
string |
title |
显示名称 |
string |
type |
样例 : |
string |
2.29. Refund
退款信息
| 名称 | 说明 | 类型 |
|---|---|---|
amount |
实际退货金额(包含运费) |
number |
classification |
退款类别,取值范围:normal(正常)、balance(补差),为空表示正常 |
enum (normal, balance) |
extra |
退款其他费用,退货取件费:rtn_pickup_freight |
< ExtraField > array |
freight |
退运费 |
number |
package_total |
包装费用 |
number |
part_refund |
是否部分退 |
boolean |
payments |
退款支付明細 |
< RefundPayment > array |
refund_phase |
退款阶段,取值范围:onsale(售中)、aftersale(售后),仅退款默认为售中阶段 |
enum (onsale, aftersale) |
settle_amount |
结算金额 |
number |
settle_commission |
平台结算佣金 |
number |
settle_fieight |
结算运费 |
number |
shop_amount |
商家货款金额 |
number |
state |
退款状态,取值范围:none(未退款)、refunded(已退款) |
enum (none, refunded) |
2.30. RefundPayment
退款支付明细
| 名称 | 说明 | 类型 |
|---|---|---|
account_name |
账号名称 |
string |
account_no |
账号 |
string |
amount |
退款金额 |
number |
code |
支付方式代码 |
string |
discount_amount |
退款优惠金额 |
number |
extra_info |
扩展信息,json字符串 |
string |
name |
支付方式名称 |
string |
out_pay_id |
第三方支付流水号 |
string |
pay_id |
支付id |
string |
score |
积分数量 |
number |
2.31. ReturnDelivery
退货信息
| 名称 | 说明 | 类型 |
|---|---|---|
carrier |
承运商 |
|
carrier_note |
承运商备注 |
string |
return_mobile |
退货联系人 |
string |
returner |
退货人 |
|
state |
退货状态,取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货) |
enum (none, customerShipped, received) |
station |
退回门店 |
|
station_type |
退回站点类型,取值范围:store(门店)、wrh(仓库)、vendor(供应商) |
string |
vendor |
退回供应商 |
|
waybill_id |
承运单号 |
string |
wrh |
退回仓库 |
|
wrh_rtn_id |
仓库退货单号 |
string |
2.32. ReturnRequest
退货请求对象
| 名称 | 说明 | 类型 |
|---|---|---|
carrier |
承运商 |
|
carrier_note |
承运商备注 |
string |
operator_role |
操作角色 |
string |
return_state |
退货状态,取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货) |
enum (none, customerShipped, received) |
waybill_id |
承运单号,非空时将更新 |
string |
2.33. Rtn
退换货单
| 名称 | 说明 | 类型 |
|---|---|---|
address_change_fee |
地址变更费 |
number |
appeal |
是否申诉 |
boolean |
apply_id |
申请ID |
string |
apply_reason |
申请原因 |
string |
apply_system |
申请方 |
string |
approve_state |
审批状态,取值范围:none(未审核),serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝) |
enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) |
cancel_reason |
取消申请原因 |
string |
created |
样例 : |
string (date-time) |
creator |
样例 : |
string |
crm_info |
营销信息 |
|
customer |
客户 |
|
customer_note |
客户留言 |
string |
delivery |
退货信息 |
|
exception_codes |
异常代码,sku(商品异常) |
string |
exception_remark |
异常说明 |
string |
exception_time |
异常时间 |
string (date-time) |
front |
平台退货信息 |
|
has_exception |
是否异常 |
boolean |
id |
退货订单号,不能重复,为空自动生成 |
string |
items |
商品行 |
< RtnItem > array |
member_info |
会员积分信息 |
|
modified |
样例 : |
string (date-time) |
modifier |
样例 : |
string |
order_id |
原订单号 |
string |
package_info |
打包信息 |
|
print_bills |
退单打印数据 |
< PrintBill > array |
promotion |
退单促销 |
|
refund |
退款信息 |
|
req_id |
申请单ID(废弃字段) |
string |
rtn_req_id |
销售退单号 |
string |
seller_info |
收货失败:原因/凭证 |
|
settle_info |
对账信息 |
|
settle_unit |
结算单位 |
|
shop |
平台商家 |
|
sku_quantity |
商品总数 |
number |
state |
退货单状态,新建可不填,取值范围:confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消),为空时取默认值confirmed |
enum (confirmed, approved, finished, canceled) |
tags |
订单标签 |
< OrderTag > array |
type |
退货单类型,取值范围:refund(仅退款)、refundAndRtn(退款退货);为空默认为退款退货 |
enum (refund, refundAndRtn) |
voucher_urls |
凭证Url(图片) |
< string > array |
wrh_id |
发货仓库编号 |
string |
wrh_state |
仓库状态,取值参考RtnWrhState |
string |
2.34. RtnApproveRequest
退单审核请求对象
| 名称 | 说明 | 类型 |
|---|---|---|
approve_state |
审核状态:none(未审核),serviceApproved(客服已审核),serviceRefuse(客服已拒绝) |
enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) |
item_infos |
明细信息 |
< 退单审核请求对象-明细信息 > array |
operator_role |
操作角色:platform(平台) |
string |
reason |
原因 |
string |
turn_to_type |
转换为哪种类型 |
enum (refund, refundAndRtn) |
2.35. RtnFilter
退单过滤器
| 名称 | 说明 | 类型 |
|---|---|---|
app_id_eq |
平台应用代码等于 |
string |
appeal |
是否申诉 |
boolean |
approve_states |
审核状态,取值范围:none(未审核)、serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝) |
< enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) > array |
bill_id_eq |
凭证单号等于 |
string |
bill_id_like |
凭证单号类似 |
string |
carrier_states |
承运状态,取值范围:initial(初始状态)、created(已下发)、createdFailed(下发失败)、pickup(已揽件)、pickupFailed(揽件失败)、delivering(配送中)、delivered(配送完成)、canceled(已取消) |
< enum (initial, created, dispatched, createdFailed, arrived, pickup, pickupFailed, delivering, delivered, canceled) > array |
carrier_types |
承运类型,取值范围:self(商家自送)、thirdparty(平台配送)、express(快递配送) |
< enum (self, thirdparty, express) > array |
created_end |
创建结束时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
created_start |
创建起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
customer_Mobile |
客户电话 |
string |
customer_Name |
客户姓名 |
string |
customer_mobile_like |
客户电话模糊搜索 |
string |
deliver_rtn_end |
退货终止时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
deliver_rtn_start |
退货起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
fake_refund_date |
退款完成日期,只支持es,是用索引最后修改时间和退款状态=refunded来匹配的,格式为:yyyy-MM-dd |
string (date-time) |
front_created_end |
下单时间终止时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
front_created_start |
下单时间起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
front_order_id |
平台订单ID |
string |
front_rtn_id |
平台退换货ID |
string |
front_sku_id |
平台商品编码 |
string |
front_station_order_no_eq |
门店订单号 |
string |
has_billing |
是否有凭证信息 |
boolean |
has_exception |
是否异常 |
boolean |
index_modified_end |
索引最后修改时间结束于,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
index_modified_start |
索引最后修改时间起始于,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
order_id |
订单号起始于 |
string |
order_id_in |
订单号 |
< string > array |
pick_info_operator_id_eq |
订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单 |
string |
pick_info_operator_id_in |
订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单 |
< string > array |
pick_info_operator_name_like |
订单拣货信息-拣货员名称 |
string |
platform_id |
平台ID |
string |
platform_ids |
平台ID集合 |
< string > array |
pre_page |
上一次页数 |
integer (int32) |
product_contains |
商品包括 |
string |
refund_phase |
申请阶段 |
string |
refund_states |
退款状态,取值范围:none(未审核)、refunded(已退款) |
< enum (none, refunded) > array |
return_states |
退货状态,取值范围:none(未审核)、customerShipped(客户已发货)、received(已收货) |
< enum (none, customerShipped, received) > array |
rtn_Id |
退单号起始于 |
string |
rtn_ids |
退单号 |
< string > array |
shop_id |
店铺ID |
string |
sku_id |
商品编码 |
string |
states |
退货单状态,取值范围:confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消) |
< enum (confirmed, approved, finished, canceled) > array |
station_id |
门店ID |
string |
station_ids |
门店ID |
< string > array |
station_type |
退回站点 |
string |
types |
退货类型 |
< enum (refund, refundAndRtn) > array |
vendor_code_eq |
供应商代码等于 |
string |
vendor_code_in |
供应商代码集合 |
< string > array |
vendor_code_start_with |
供应商代码起始于 |
string |
waybill_id |
退回物流单号 |
string |
wrh_id_in |
退回仓库code集合 |
< string > array |
wrh_id_start_with |
退回仓库code起始于 |
string |
2.36. RtnItem
退货商品行
| 名称 | 说明 | 类型 |
|---|---|---|
barcode |
商品条码 |
string |
details |
退款商品行明细 |
< RtnItemDetail > array |
extra_info |
扩展信息,json字符串 |
string |
front_item_id |
平台订单行ID |
string |
front_sku_id |
前台商品标识 |
string |
front_unit |
单位 |
string |
image_url |
商品图片信息 |
string |
is_collocation |
是否搭配商品(加料) |
boolean |
is_gift |
默认值 : |
boolean |
item_id |
行唯一标识 |
string |
item_no |
行号 |
string |
item_title |
商品标题 |
string |
order_item_id |
订单行标识id |
string |
orig_barcode |
转换前商品条码 |
string |
orig_image_url |
转换前商品图片信息 |
string |
orig_item |
订单原商品信息,用于多规格、组合商品场景,记录用户下单时的商品信息 |
|
orig_item_title |
转换前的商品名称:用于多规格、组合商品转换标品场景 |
string |
orig_mas_sku_id |
样例 : |
string |
orig_price |
转换前的商品售价:用于多规格、组合商品转换标品场景 |
number |
orig_qty |
转换前的商品数量:用于多规格、组合商品转换标品场景 |
number |
orig_sku_id |
转换前的货号:用于多规格转换场景 |
string |
orig_spec |
转换前的规格:用于多规格、组合商品转换标品场景 |
string |
orig_unit |
转换前的单位:用于多规格、组合商品转换标品场景 |
string |
origin_sku_id |
替换前的商品标识,只有界面使用 |
string |
product_id |
商品代码 |
string |
promotion |
商品退促销 |
|
purchase_price |
采购价 |
number |
quantity |
退货数量 |
number |
real_qty |
实际数量(已废弃) |
number |
real_quantity |
实际拣货商品数量 |
number |
real_weight |
实际称重,明细总重量,单位g |
number |
refund_amount |
退款金额 (订单优惠后的金额) |
number |
relation_item_id |
关联商品行号 |
string |
relation_sku_id |
关联的货号 |
string |
settle_price |
结算价格 |
number |
settle_total |
结算金额 |
number |
shop_price |
货款价格 |
number |
shop_total |
货款金额 |
number |
sku_id |
商品标识 |
string |
spec |
商品规格 |
string |
tags |
标签 |
< 退单明细标签 > array |
total |
退款金额 |
number |
trace_code_details |
溯源码明细 |
< OrderItemTraceCodeDetail > array |
unit |
单位:个、份等 |
string |
unit_price |
价格 |
number |
uuid |
样例 : |
string |
2.37. RtnItemDetail
退款商品行明细
| 名称 | 说明 | 类型 |
|---|---|---|
id |
商品货号 |
string |
quantity |
商品数量 |
number |
ratio |
原料比例,数值3表示,一个组合商品,包含3个原料商品 |
number |
real_quantity |
样例 : |
number |
title |
名称 |
string |
trace_code_details |
溯源码明细 |
< OrderItemTraceCodeDetail > array |
2.38. RtnItemDetailTraceCodeUpdateObj
退单明细原料溯源码更新对象
| 名称 | 说明 | 类型 |
|---|---|---|
id |
原料id |
string |
trace_code_list |
溯源码列表 |
< OrderItemTraceCodeDetail > array |
2.39. RtnItemTraceCodeUpdateObj
退单明细溯源码更新对象
| 名称 | 说明 | 类型 |
|---|---|---|
details |
原料(组合商品才有) |
< RtnItemDetailTraceCodeUpdateObj > array |
item_id |
行唯一标识 |
string |
item_no |
行号 |
string |
sku_id |
货号 |
string |
trace_code_list |
溯源码列表 |
< OrderItemTraceCodeDetail > array |
2.42. RtnModificationRequest
修改退货单请求对象
| 名称 | 说明 | 类型 |
|---|---|---|
address_change_fee |
地址变更费 |
number |
apply_reason |
申请原因 |
string |
carrier_type |
退单配送状态 |
enum (self, thirdparty, express) |
customer_note |
客户留言 |
string |
freight |
运费 |
number |
items |
退换货明细行 |
< RtnItem > array |
modify_item_detail |
是否修改商品原料 |
boolean |
package_total |
包装费 |
number |
refund_extra |
退款其他费用,退货取件费:rtn_pickup_freight |
< ExtraField > array |
rtnId |
退换货单ID |
string |
settle_amount |
结算金额 |
number |
settle_commission |
本退单退回佣金 |
number |
voucher_urls |
凭证Url(图片) |
< string > array |
2.44. RtnOrigItem
原商品行信息
| 名称 | 说明 | 类型 |
|---|---|---|
barcode |
转换前条码 |
string |
combined_id |
如果是组合商品,需要传组合标识ID,可以用组合商品ID作为标识 |
string |
image_url |
转换前图片地址 |
string |
item_title |
转换前的商品名称:用于多规格、组合商品转换标品场景 |
string |
price |
转换前的商品售价:用于多规格、组合商品转换标品场景 |
number |
quantity |
转换前的商品数量:用于多规格、组合商品转换标品场景 |
number |
sku_id |
转换前的货号:用于多规格、组合商品转换标品场景 |
string |
type |
类型,多规格multi、组合combined |
string |
2.45. RtnPaging
退单分页对象
| 名称 | 说明 | 类型 |
|---|---|---|
page |
页码 |
integer (int32) |
page_count |
总页数 |
integer (int32) |
page_size |
页大小 |
integer (int32) |
rtns |
退单列表 |
< Rtn > array |
total |
总条数 |
integer (int64) |
2.46. RtnPrintData
退单打印数据
| 名称 | 说明 | 类型 |
|---|---|---|
bills |
每联的打印数据 |
< PrintBill > array |
front_rtn_id |
前端平台退单ID |
string |
rtn_id |
退单号 |
string |
time |
打印数据的生成时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
2.47. RtnPrintDataList
退单打印数据列表对象
| 名称 | 说明 | 类型 |
|---|---|---|
rtns |
退单打印数据列表 |
< RtnPrintData > array |
2.49. RtnRefundUpdateRequest
修改退款信息
| 名称 | 说明 | 类型 |
|---|---|---|
payments |
退款支付明細 |
< RefundPayment > array |
2.50. RtnSettleInfo
对账信息
| 名称 | 说明 | 类型 |
|---|---|---|
settlable |
是否可结算 |
boolean |
settle_date |
账单日期 |
string (date-time) |
station_settle_mode |
门店分账模式:online(线上分账模式)、offline(线下分账模式) |
string |
2.51. RtnSettleInfoUpdateRequest
修改结算信息
| 名称 | 说明 | 类型 |
|---|---|---|
settlable |
默认值 : |
boolean |
settle_date |
样例 : |
string (date-time) |
2.52. RtnSubmitResponse
退单新建响应
| 名称 | 说明 | 类型 |
|---|---|---|
code |
样例 : |
string |
message |
样例 : |
string |
rtn_id |
样例 : |
string |
success |
默认值 : |
boolean |
2.53. RtnUpdateDeliveryRequest
修改物流物流退回信息请求对象
| 名称 | 说明 | 类型 |
|---|---|---|
carrier |
承运商 |
|
mobile |
手机号 |
string |
state |
退货状态:none(未退货)、customerShipped(客户已发货)、received(已收货) |
enum (none, customerShipped, received) |
waybill_id |
承运单号 |
string |
2.55. SellerInfo
收货失败:原因/凭证
| 名称 | 说明 | 类型 |
|---|---|---|
seller_note |
收货失败原因 |
string |
seller_voucher_urls |
卖家收货失败凭证:图片地址 |
< string > array |
2.56. SettleUnit
结算单位
| 名称 | 说明 | 类型 |
|---|---|---|
code |
单位代码,取值门店代码 |
string |
name |
单位门店,取值门店名称 |
string |
type |
类型:store |
string |
2.57. 修改退单溯源码的请求
| 名称 | 说明 | 类型 |
|---|---|---|
items |
退单明细溯源码更新对象列表 |
< RtnItemTraceCodeUpdateObj > array |
2.58. 联系方式(soms)
联系方式
| 名称 | 说明 | 类型 |
|---|---|---|
email |
邮箱 |
string |
fax |
传真 |
string |
mobile |
手机(mobile和telephone建议给值mobile) |
string |
name |
姓名 |
string |
private_mobile |
脱敏手机号 |
string |
private_name |
脱敏名称 |
string |
telephone |
电话 |
string |
2.59. 退单审核请求对象-明细信息
| 名称 | 说明 | 类型 |
|---|---|---|
detail_infos |
原料信息 |
< 退单审核请求对象-明细原料信息 > array |
item_id |
行Id |
string |
item_no |
行号 |
string |
order_item_id |
订单行Id |
string |
real_quantity |
实际数量 |
number |
sku_id |
货号 |
string |
2.60. 退单审核请求对象-明细原料信息
| 名称 | 说明 | 类型 |
|---|---|---|
real_quantity |
实际退回数量 |
number |
sku_id |
原料货号 |
string |
2.61. 退单明细标签
| 名称 | 说明 | 类型 |
|---|---|---|
name |
名称 |
string |