OMS 对外开放接口说明

OMS 对外开放接口说明


订单修改

<h5>简要描述</h5> <ul> <li>无</li> </ul> <h5>请求URL</h5> <ul> <li><code>/v1/order/edit</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求参数示例</h5> <pre><code>{ "consigneeCity": "米兰", "consigneeCountryCode": "cn", "consigneeState": "GD", "consigneeEmail": "123458756@qq.com", "consigneeName": "张自然", "consigneePostcode": 518666, "consigneeStreetOne": "宝安大道", "consigneeStreetTwo": "string", "consigneeTaxNo": "string", "consigneeTel": "13115070826", "companyName": "", "details": [ { "sku": null, "qty": null } ], "referenceNo": "SO202201130001", "saleChannelCode": "amazon", "saleTime": "2022-03-08 00:00:00", "notes": "", "attachmentUrl": "http:\/\/www.a.com\/appli\/etiquette-2580980-20231016092916.pdf" } </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;">consigneeCity</td> <td style="text-align: left;">否</td> <td>string</td> <td>城市</td> </tr> <tr> <td style="text-align: left;">consigneeCountryCode</td> <td style="text-align: left;">否</td> <td>string</td> <td>国家简码</td> </tr> <tr> <td style="text-align: left;">consigneeState</td> <td style="text-align: left;">否</td> <td>string</td> <td>州省</td> </tr> <tr> <td style="text-align: left;">consigneeEmail</td> <td style="text-align: left;">否</td> <td>string</td> <td>邮箱</td> </tr> <tr> <td style="text-align: left;">consigneeName</td> <td style="text-align: left;">否</td> <td>string</td> <td>收货人</td> </tr> <tr> <td style="text-align: left;">consigneePostcode</td> <td style="text-align: left;">否</td> <td>string</td> <td>邮编</td> </tr> <tr> <td style="text-align: left;">consigneeStreetOne</td> <td style="text-align: left;">否</td> <td>string</td> <td>街道1</td> </tr> <tr> <td style="text-align: left;">consigneeStreetTwo</td> <td style="text-align: left;">否</td> <td>string</td> <td>街道2</td> </tr> <tr> <td style="text-align: left;">consigneeTaxNo</td> <td style="text-align: left;">否</td> <td>string</td> <td>税号</td> </tr> <tr> <td style="text-align: left;">consigneeTel</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>订单sku集合</td> </tr> <tr> <td style="text-align: left;">details.sku</td> <td style="text-align: left;">否</td> <td>object</td> <td>商品SKU</td> </tr> <tr> <td style="text-align: left;">details.qty</td> <td style="text-align: left;">否</td> <td>object</td> <td>数量</td> </tr> <tr> <td style="text-align: left;">referenceNo</td> <td style="text-align: left;">是</td> <td>string</td> <td>客户单号,参考号</td> </tr> <tr> <td style="text-align: left;">saleChannelCode</td> <td style="text-align: left;">否</td> <td>string</td> <td>销售渠道编号</td> </tr> <tr> <td style="text-align: left;">saleTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>销售日期,格式:yyyy-MM-dd</td> </tr> <tr> <td style="text-align: left;">companyName</td> <td style="text-align: left;">否</td> <td>string</td> <td>公司名</td> </tr> <tr> <td style="text-align: left;">notes</td> <td style="text-align: left;">否</td> <td>string</td> <td>备注</td> </tr> <tr> <td style="text-align: left;">attachmentUrl</td> <td style="text-align: left;">否</td> <td>string</td> <td>附件URL(多个逗号分隔)</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "msg": "修改成功", "code": 200 } </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> </tbody> </table> <h5>失败返回示例</h5> <pre><code>{ "errcode": "30009", "msg": "单号错误", "code": 500 } </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;">errcode</td> <td style="text-align: left;">string</td> <td>错误编码</td> </tr> <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> </tbody> </table> <h5>备注</h5> <p>3.1失败 30001:仓库不存在 30002:销售渠道不存在 30003:派送渠道不存在 30004:SKU与数量对不上 30005:SKU 不存在 30007:查询超出限制 30009:订单号错误</p>

页面列表

ITEM_HTML