OMS 对外开放接口说明

OMS 对外开放接口说明


退件单创建

<h5>简要描述</h5> <ul> <li>退件单创建</li> </ul> <h5>请求URL</h5> <ul> <li><code>/v1/return/order/create</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求参数示例</h5> <pre><code>{ "warehouseCode": "WAREHOUSEUK", "returnOrderType": 1, "returnReason": 1, "returnTrackNo": "bbbb", "returnTime": "2016-10-28 05:55:24", "foNo": "FO202209140002-YTD", "returnNotes": "021302", "details": [ { "sku": "AX99001101", "returnQty": 1, "dealWay": 1 } ], "isConfirm": 0, "returnLabelFlag": 1, "returnLabelAddress": { "name": "test_d33c720ba3ce", "countryCode": "gb", "state": "test_b23a7da04948", "city": "test_e02177e2c01c", "streetOne": "test_6b133835dcd0", "streetTwo": "test_6376fc6a5c6d", "postcode": "test_4cc958b2fb53", "tel": "test_8a386709c0b3", "fax": "test_d14c9340bf39", "email": "test_5363337a16cd", "taxNo": "test_0402aaffc49f", "companyName": "test_dbddf6904298", "logisticsServiceCode": "KDA" }, "deliverLabelAddress": { "name": "test_c207a044e147", "countryCode": "GB", "state": "test_6ecaaf14fbd0", "city": "test_6d87e67a2d40", "streetOne": "test_c765ac2eb9f5", "streetTwo": "test_4e63447e826d", "postcode": "test_5a27d5a97031", "tel": "test_f5fa7be85995", "fax": "test_74fdad1ac352", "email": "test_64a26ec8328e", "taxNo": "test_80a5a381f204", "companyName": "test_1c50198160e6", "logisticsServiceCode": "DX_GB_TEST" } } </code></pre> <h5>json字段说明</h5> <table> <thead> <tr> <th style="text-align: left;">字段名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">warehouseCode</td> <td style="text-align: left;">是</td> <td>string</td> <td>到货仓库编码</td> </tr> <tr> <td style="text-align: left;">returnOrderType</td> <td style="text-align: left;">是</td> <td>int</td> <td>1:买家退件,2:认领退件</td> </tr> <tr> <td style="text-align: left;">returnReason</td> <td style="text-align: left;">是</td> <td>int</td> <td>1:地址错误2:多次投递未成3:买家退货4:其他仓库退货5:邮局退回6:回邮单100:其他</td> </tr> <tr> <td style="text-align: left;">returnTrackNo</td> <td style="text-align: left;">是</td> <td>string</td> <td>退货跟踪号</td> </tr> <tr> <td style="text-align: left;">returnTime</td> <td style="text-align: left;">是</td> <td>string</td> <td>退货时间</td> </tr> <tr> <td style="text-align: left;">foNo</td> <td style="text-align: left;">否</td> <td>string</td> <td>发货批次号</td> </tr> <tr> <td style="text-align: left;">returnNotes</td> <td style="text-align: left;">否</td> <td>string</td> <td>退货说明</td> </tr> <tr> <td style="text-align: left;">details</td> <td style="text-align: left;">是</td> <td>array</td> <td>退货明细</td> </tr> <tr> <td style="text-align: left;">details.sku</td> <td style="text-align: left;">是</td> <td>string</td> <td>SKU</td> </tr> <tr> <td style="text-align: left;">details.returnQty</td> <td style="text-align: left;">是</td> <td>int</td> <td>退货数量</td> </tr> <tr> <td style="text-align: left;">details.dealWay</td> <td style="text-align: left;">是</td> <td>int</td> <td>处理方式 1重新上架2退回国内3良品上架4良品贴标上架5直接销毁 8产品升级 9检查10维修11拆件 12维修并发运 13上架不良品</td> </tr> <tr> <td style="text-align: left;">isConfirm</td> <td style="text-align: left;">是</td> <td>number</td> <td>是否审核 0:否 1:是,为1则退货订单直接审核 默认0</td> </tr> <tr> <td style="text-align: left;">returnLabelFlag</td> <td style="text-align: left;">是</td> <td>int</td> <td>是否需要回邮单 0:不需要 1:需要 默认为0</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress</td> <td style="text-align: left;">否</td> <td>object</td> <td>回邮发件人地址(需要回邮单时必填)</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.name</td> <td style="text-align: left;">是</td> <td>string</td> <td>回邮发件人地址-联系人</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.countryCode</td> <td style="text-align: left;">是</td> <td>string</td> <td>回邮发件人地址-国家代码</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.state</td> <td style="text-align: left;">否</td> <td>string</td> <td>回邮发件人地址-省</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.city</td> <td style="text-align: left;">是</td> <td>string</td> <td>回邮发件人地址-市</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.streetOne</td> <td style="text-align: left;">是</td> <td>string</td> <td>回邮发件人地址-街道1</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.streetTwo</td> <td style="text-align: left;">否</td> <td>string</td> <td>回邮发件人地址-街道2</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.postcode</td> <td style="text-align: left;">是</td> <td>string</td> <td>回邮发件人地址-邮编</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.tel</td> <td style="text-align: left;">否</td> <td>string</td> <td>回邮发件人地址-电话</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.fax</td> <td style="text-align: left;">否</td> <td>string</td> <td>回邮发件人地址-传真</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.email</td> <td style="text-align: left;">否</td> <td>string</td> <td>回邮发件人地址-邮件</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.taxNo</td> <td style="text-align: left;">否</td> <td>string</td> <td>回邮发件人地址-税号</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.companyName</td> <td style="text-align: left;">否</td> <td>string</td> <td>回邮发件人地址-公司名</td> </tr> <tr> <td style="text-align: left;">returnLabelAddress.logisticsServiceCode</td> <td style="text-align: left;">是</td> <td>string</td> <td>回邮发件人地址-渠道代码</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress</td> <td style="text-align: left;">否</td> <td>object</td> <td>发运地址(处理方案存在维修并发运的情况必填)</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.name</td> <td style="text-align: left;">是</td> <td>string</td> <td>发运地址-联系人</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.countryCode</td> <td style="text-align: left;">是</td> <td>string</td> <td>发运地址-国家代码</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.state</td> <td style="text-align: left;">否</td> <td>string</td> <td>发运地址-省</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.city</td> <td style="text-align: left;">是</td> <td>string</td> <td>发运地址-城市</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.streetOne</td> <td style="text-align: left;">是</td> <td>string</td> <td>发运地址-街道1</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.streetTwo</td> <td style="text-align: left;">否</td> <td>string</td> <td>发运地址-街道2</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.postcode</td> <td style="text-align: left;">是</td> <td>string</td> <td>发运地址-邮编</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.tel</td> <td style="text-align: left;">否</td> <td>string</td> <td>发运地址-电话</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.fax</td> <td style="text-align: left;">否</td> <td>string</td> <td>发运地址-传真</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.email</td> <td style="text-align: left;">否</td> <td>string</td> <td>发运地址-邮箱</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.taxNo</td> <td style="text-align: left;">否</td> <td>string</td> <td>发运地址-税号</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.companyName</td> <td style="text-align: left;">否</td> <td>string</td> <td>发运地址-公司名</td> </tr> <tr> <td style="text-align: left;">deliverLabelAddress.logisticsServiceCode</td> <td style="text-align: left;">是</td> <td>string</td> <td>发运地址-渠道代码</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "msg": "操作成功", "code": 200, "data": { "returnOrderCode": "RT202302140005-YTD" } } </code></pre> <h5>成功返回示例的参数说明</h5> <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;">msg</td> <td style="text-align: left;">string</td> <td>提示</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>返回编码</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">object</td> <td>返回数据</td> </tr> <tr> <td style="text-align: left;">returnOrderCode</td> <td style="text-align: left;">string</td> <td>退件单号</td> </tr> </tbody> </table>

页面列表

ITEM_HTML