OMS接口文档

OMS接口文档


退款单导入

<p><strong>简要描述:</strong> </p> <ul> <li>退款单表体 (一张退款单由一个表头和一个表体组成)</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://localhost:8080/api/billoperation/apiaction?token=12345678</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>单据编码</td> </tr> <tr> <td style="text-align: left;">action</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>操作类型 refundimport</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;">shopCode</td> <td style="text-align: left;">店铺编码</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">refund_num</td> <td style="text-align: left;">退货申请数量</td> <td style="text-align: left;">Decimal</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;">oid</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;">退款阶段(&quot;onsale&quot;:&quot;售中&quot;,&quot;aftersale&quot;:&quot;售后&quot;,&quot;sale&quot;:&quot;售中/售后&quot;)</td> <td style="text-align: left;">String</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;">退款类型(&quot;1&quot;:&quot;退款&quot;,&quot;2&quot;:&quot;退货&quot;,&quot;3&quot;:&quot;拒收&quot;)</td> <td style="text-align: left;">String</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;">stored_card_refund</td> <td style="text-align: left;">会员钱包退款</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">stored_card_disrefund</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;">seller_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;">order_status</td> <td style="text-align: left;">订单交易状态(&quot;waiting_buyer_to_pay&quot;:&quot;待付款&quot;,&quot;buyers_have_paid&quot;:&quot;待发货&quot;,&quot;sellers_have_been_shipped&quot;:&quot;已发货&quot;,&quot;sellers_have_been_shipped_part&quot;:&quot;部分发货&quot;,&quot;trade_closed&quot;:&quot;交易关闭&quot;,&quot;trade_refunding&quot;:&quot;退款中&quot;,&quot;trade_finished&quot;:&quot;交易完成&quot;)</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;">货物状态(&quot;BUYER_NOT_RECEIVED&quot;:&quot;买家未收到货&quot;,&quot;BUYER_RECEIVED&quot;:&quot;买家已收到货&quot;,&quot;BUYER_RETURNED_GOODS&quot;:&quot;买家已退货&quot;)</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;">系统状态(&quot;refund_success&quot;:&quot;退款成功&quot;,&quot;refund_wait_agree&quot;:&quot;等待卖家同意退款&quot;,&quot;refund_wait_buyer_returnGoods&quot;:&quot;等待买家退货&quot;,&quot;refund_wait_seller_confirmGoods&quot;:&quot;等待卖家确认收货&quot;,&quot;refund_refuse&quot;:&quot;卖家拒绝退款&quot;,&quot;refund_closed&quot;:&quot;退款关闭&quot;,&quot;refund_no&quot;:&quot;未申请退款&quot;)</td> <td style="text-align: left;">String</td> <td>是</td> </tr> </tbody> </table> <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;">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;">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;">citemid</td> <td style="text-align: left;">系统商品SkuID</td> <td style="text-align: left;">Long</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;">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;">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;">stored_card_refund</td> <td style="text-align: left;">会员钱包退款</td> <td style="text-align: left;">Decimal</td> <td>是</td> </tr> <tr> <td style="text-align: left;">stored_card_disrefund</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> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code> { "billnum": "ec_tradeorder", "action": "refundimport", "externalData": "[{\"refund_num\":0,\"shopCode\":\"001\",\"refund_id\":\"20190715142010002\",\"tid\":\"292021743163352606\",\"oid\":\"292021743166352606\",\"refund_phase\":\"aftersale\",\"status\":\"SUCCESS\",\"refund_type\":\"1\",\"total_fee\":72.23000000,\"refund_fee\":72.23000000,\"payment\":0,\"buyer_nick\":\"syqhgq\",\"seller_nick\":\"ssaaa\",\"reason\":\"包装/商品破损\",\"desc\":\"\",\"created\":\"2019-07-14 00:00:00\",\"modified\":\"2019-07-14 00:00:00\",\"down_time\":\"2019-07-14 00:00:00\",\"order_status\":\"trade_finished\",\"good_status\":\"BUYER_RECEIVED\",\"sys_status\":\"refund_success\",\"refund_version\":0,\"stored_card_disrefund\":0,\"stored_card_refund\":0,\"refundSourceDetail\":[{\"refund_num\":0,\"stored_card_disrefund\":0,\"stored_card_refund\":0,\"good_status\":\"BUYER_RECEIVED\",\"tid\":\"292021743163352606\",\"oid\":\"292021743166352606\",\"num_iid\":\"577531216623\",\"title\":\"新鲜深海甜虾仁\",\"outer_id\":\"124100460000\",\"num\":1.00000000,\"price\":99.00000000,\"total_fee\":72.23000000,\"payment\":72.23000000,\"refund_fee\":72.23000000,\"created\":\"2019-07-14 00:00:00\",\"modified\":\"2019-07-14 00:00:00\"}]}]" }</code></pre> <p><strong>返回示例</strong></p> <pre><code>{ "code": 200, "message": "导入成功1单" }</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