OMS接口文档

OMS接口文档


退换货订单导入

<p><strong>简要描述:</strong> </p> <ul> <li>退换货订单表体 (一张退换货单由一个表头和一个表体组成)</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://localhost:8080/billoperation/apiaction?token=</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">billnum</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>单据编码 ec_refundorder</td> </tr> <tr> <td style="text-align: left;">action</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>操作类型 refundOrderimport</td> </tr> <tr> <td style="text-align: left;">externalData</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>导入数据</td> </tr> </tbody> </table> <p><strong>导入数据详情(externalData详细信息):</strong> <strong>表头</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">类型</th> <th>必选</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">plat</td> <td style="text-align: left;">平台(含预留) 1--淘宝,2--京东,3--苏宁,4--U商城,5--亚马逊,6--小红书,7--有赞,8--1688,11--淘宝供销平台,99--其他,9--拼多多,10--工行融E购,12--友零售,13--楚楚街,23--唯品会mp,15--苏宁拼购,30--渠道云</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">shop_id</td> <td style="text-align: left;">店铺</td> <td style="text-align: left;">Long</td> <td>是</td> </tr> <tr> <td style="text-align: left;">store_id</td> <td style="text-align: left;">门店id</td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">refund_id</td> <td style="text-align: left;">退款单号(唯一编码)</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">tid</td> <td style="text-align: left;">交易编号</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">oribillid</td> <td style="text-align: left;">退款单原单id</td> <td style="text-align: left;">Long</td> <td>是</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">平台状态</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">refund_type</td> <td style="text-align: left;">退款类型 1--退款,2--退货,3--拒收,4--换货</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">convert_type</td> <td style="text-align: left;">转单状态</td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">fail_reason</td> <td style="text-align: left;">失败原因</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">convert_time</td> <td style="text-align: left;">转单时间</td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">total_fee</td> <td style="text-align: left;">实收金额(订单交易总金额)</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">refund_fee</td> <td style="text-align: left;">退款申请单金额</td> <td style="text-align: left;">Decimal</td> <td>否</td> </tr> <tr> <td style="text-align: left;">payment</td> <td style="text-align: left;">实际退款金额</td> <td style="text-align: left;">Decimal</td> <td>否</td> </tr> <tr> <td style="text-align: left;">refundFee</td> <td style="text-align: left;">退款金额</td> <td style="text-align: left;">Decimal</td> <td>否</td> </tr> <tr> <td style="text-align: left;">refundNum</td> <td style="text-align: left;">退货数量</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">buyer_nick</td> <td style="text-align: left;">买家昵称</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">reason</td> <td style="text-align: left;">退款原因</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">desc</td> <td style="text-align: left;">退款说明</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">company_name</td> <td style="text-align: left;">退货快递公司</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">sid</td> <td style="text-align: left;">退货快递单号</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">created</td> <td style="text-align: left;">退款申请时间</td> <td style="text-align: left;">DateTime</td> <td>是</td> </tr> <tr> <td style="text-align: left;">modified</td> <td style="text-align: left;">修改时间</td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">down_time</td> <td style="text-align: left;">下载时间</td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">order_status</td> <td style="text-align: left;">订单交易状态 请查看status描述:<a href="https://www.showdoc.com.cn/265424688438926?page_id=1999778270293645">https://www.showdoc.com.cn/265424688438926?page_id=1999778270293645</a></td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">good_status</td> <td style="text-align: left;">货物状态 BUYER_NOT_RECEIVED--买家未收到货,BUYER_RECEIVED--买家已收到货,BUYER_RETURNED_GOODS--买家已退货</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">sys_status</td> <td style="text-align: left;">系统状态 refund_wait_agree--买家已经申请退款,等待卖家同意,refund_wait_buyer_returnGoods--卖家已经同意退货,等待买家退货,refund_wait_seller_confirmGoods--买家已经退货,等待卖家确认收货,refund_refuse--卖家拒绝退款,refund_closed--退款关闭,,refund_success--退款成功</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">refund_status</td> <td style="text-align: left;">退货状态</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">refund_version</td> <td style="text-align: left;">退款版本号</td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">image_id</td> <td style="text-align: left;">图片id</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">image_name</td> <td style="text-align: left;">图片名称</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">image_url</td> <td style="text-align: left;">图片url</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">isClosed</td> <td style="text-align: left;">是否关闭</td> <td style="text-align: left;">ShortInt</td> <td>否</td> </tr> <tr> <td style="text-align: left;">bill_code</td> <td style="text-align: left;">收款单号</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">blend_person</td> <td style="text-align: left;">勾兑人</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">transferPerson</td> <td style="text-align: left;">转单人</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">auditPerson</td> <td style="text-align: left;">审核人</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">audit_date</td> <td style="text-align: left;">审核日期</td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">blend_date</td> <td style="text-align: left;">勾兑时间</td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">isBlend</td> <td style="text-align: left;">是否勾对</td> <td style="text-align: left;">ShortInt</td> <td>否</td> </tr> <tr> <td style="text-align: left;">memo</td> <td style="text-align: left;">备注</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">blend_id</td> <td style="text-align: left;">勾兑ID</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">编码</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">tenant_id</td> <td style="text-align: left;">租户</td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">org_id</td> <td style="text-align: left;">组织档案节点</td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">salerptcode</td> <td style="text-align: left;"></td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">salerptid</td> <td style="text-align: left;"></td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">srctype</td> <td style="text-align: left;"></td> <td style="text-align: left;">ShortInt</td> <td>否</td> </tr> <tr> <td style="text-align: left;">bsalerpt</td> <td style="text-align: left;"></td> <td style="text-align: left;">ShortInt</td> <td>否</td> </tr> <tr> <td style="text-align: left;">salerpter</td> <td style="text-align: left;"></td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">salerpttime</td> <td style="text-align: left;"></td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">newAddTradePerson</td> <td style="text-align: left;">制单人</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">newAddTradeTime</td> <td style="text-align: left;">制单时间</td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">distributor_nick</td> <td style="text-align: left;">分销商昵称</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">moneytype</td> <td style="text-align: left;">币种</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">isAuditing</td> <td style="text-align: left;">是否审核</td> <td style="text-align: left;">ShortInt</td> <td>否</td> </tr> <tr> <td style="text-align: left;">original_refund_phase</td> <td style="text-align: left;"></td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">refund_phase</td> <td style="text-align: left;">退款阶段</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">inbound_status</td> <td style="text-align: left;"></td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">inbound_time</td> <td style="text-align: left;"></td> <td style="text-align: left;">String</td> <td>否</td> </tr> </tbody> </table> <p><strong>表体--refundOrderDetail</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">类型</th> <th>必选</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">good_status</td> <td style="text-align: left;">货物状态</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">tid</td> <td style="text-align: left;">交易编号</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">oid</td> <td style="text-align: left;">子订单号</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">num_iid</td> <td style="text-align: left;">平台商品编码</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">product_name</td> <td style="text-align: left;">商品名称</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">商品标题</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">sku</td> <td style="text-align: left;">平台商品SKU信息</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">cwhcode</td> <td style="text-align: left;">仓库id</td> <td style="text-align: left;">Long</td> <td>是</td> </tr> <tr> <td style="text-align: left;">isGift</td> <td style="text-align: left;">是否赠品</td> <td style="text-align: left;">ShortInt</td> <td>是</td> </tr> <tr> <td style="text-align: left;">cbatch</td> <td style="text-align: left;">批号</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">sku_id</td> <td style="text-align: left;">sku_id</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">citemID</td> <td style="text-align: left;">商品ID</td> <td style="text-align: left;">Long</td> <td>是</td> </tr> <tr> <td style="text-align: left;">productID</td> <td style="text-align: left;">系统商品ID</td> <td style="text-align: left;">Long</td> <td>是</td> </tr> <tr> <td style="text-align: left;">num</td> <td style="text-align: left;">数量</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">price</td> <td style="text-align: left;">价格</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">total_fee</td> <td style="text-align: left;">金额</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">memo</td> <td style="text-align: left;">备注</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">created</td> <td style="text-align: left;">退款申请时间</td> <td style="text-align: left;">DateTime</td> <td>是</td> </tr> <tr> <td style="text-align: left;">modified</td> <td style="text-align: left;">修改时间</td> <td style="text-align: left;">DateTime</td> <td>否</td> </tr> <tr> <td style="text-align: left;">org_id</td> <td style="text-align: left;">组织档案节点</td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">tenant_id</td> <td style="text-align: left;">租户</td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">salerptbodyid</td> <td style="text-align: left;"></td> <td style="text-align: left;">Long</td> <td>否</td> </tr> <tr> <td style="text-align: left;">actualReturnQuantity</td> <td style="text-align: left;">实际退货数量</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">cTradeCodeLine</td> <td style="text-align: left;">电商订单号</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">cTradeLineId</td> <td style="text-align: left;">订单行ID</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">refund_phase</td> <td style="text-align: left;">退款阶段</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">payment</td> <td style="text-align: left;">实收金额</td> <td style="text-align: left;">Decimal</td> <td>否</td> </tr> <tr> <td style="text-align: left;">enableNum</td> <td style="text-align: left;">可退数量</td> <td style="text-align: left;">Decimal</td> <td>否</td> </tr> <tr> <td style="text-align: left;">isInbound</td> <td style="text-align: left;"></td> <td style="text-align: left;">ShortInt</td> <td>否</td> </tr> <tr> <td style="text-align: left;">goodtype</td> <td style="text-align: left;"></td> <td style="text-align: left;">ShortInt</td> <td>否</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code>{ "externalData" : [ { "plat": "1", "refund_version": 1554860993524, "srctype": 1, "refundNum": 2, "reason": "多拍/错拍/不想要", "down_time": "2019-04-10 09:51:49", "code": "20190410095412923001", "tid": "404818115517251453", "original_refund_phase": "onsale", "good_status": "BUYER_RECEIVED", "order_status": "sellers_have_been_shipped", "isAuditing": 1, "moneytype": "RMB", "total_fee": 0.01, "payment": 0, "id": 1174098087366912, "pubts": "2019-04-23 17:32:28", "oribillid": 1174095616315648, "tenant": 616973480136960, "sys_status": "refund_wait_buyer_returnGoods", "auditDate": "2019-04-11 19:47:42", "refund_type": "2", "org": 3283, "created": "2019-04-10 09:49:53", "bsalerpt": 0, "refund_id": "23641187311255314", "convert_time": "2019-04-10 09:54:12", "convert_type": 0, "refundOrderDetail": [ { "isInbound": 1, "productID": 1162770706141440, "cTradeLineId": "1174095207993601", "cwhcode": 1158535624593664, "num": 1, "num_iid": "526421307171", "oid": "404818115517251453", "title": "办公用签字笔1012(ISV测试商品,不要拍)", "outer_id": "040001", "parentid": 1174098087366912, "tid": "404818115517251453", "good_status": "BUYER_RECEIVED", "citemID": 1162770732994816, "price": 0.01, "total_fee": 0.01, "isGift": 0, "payment": 0.01, "enableNum": 1, "id": 1174098087366913, "sku": "颜色分类:蓝色", "pubts": "2019-04-11 19:47:45", "tenant": 616973480136960, "actualReturnQuantity": 1, "org": 3283, "created": "2019-04-10 09:49:53", "sku_id": "1162770732994816", "product_name": "inv017保质期", "cTradeCodeLine": "DSDD11062019041000000001", "refund_phase": "aftersale" } ], "shop_id": 1106724684943616, "buyer_nick": "七海月", "isClosed": 0, "transferPerson": "肖静", "refund_fee": 0, "auditPerson": "肖静", "close_reason": "" }], "billnum":"ec_refundorder", "action":"refundOrderimport" }</code></pre> <p><strong>返回示例</strong></p> <pre><code> { "code": 200, "message": "操作成功", "data": "退换货订单导入完成" }</code></pre> <p><strong>返回参数说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>200:成功;其他:失败</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>错误消息</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML