OMS 对外开放接口说明

OMS 对外开放接口说明


订单查询

<h5>简要描述</h5> <ul> <li>会过滤【取消】及【截单成功】状态订单</li> </ul> <h5>请求URL</h5> <ul> <li><code>/v1/order/search</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求参数示例</h5> <pre><code>{ "beginCreateTime": "2022-05-18", "beginSaleTime": "2022-05-18", "beginStockOutTime": "2022-05-18", "beginUpdateTime": "2022-05-18", "endCreateTime": "2022-05-28", "endSaleTime": "2022-05-28", "endStockOutTime": "2022-05-28", "endUpdateTime": "2022-05-28", "foNos": [ "FO2022050101" ], "orderNos": [ "OD2022050101" ], "pageNum": 1, "pageSize": 10, "referenceNos": [ "RF2022050101" ] } </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;">beginCreateTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>制单时间区间开始 example: 2022-05-18</td> </tr> <tr> <td style="text-align: left;">beginSaleTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>销售时间区间开始</td> </tr> <tr> <td style="text-align: left;">beginStockOutTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>出库时间区间开始</td> </tr> <tr> <td style="text-align: left;">beginUpdateTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>更新时间区间开始</td> </tr> <tr> <td style="text-align: left;">endCreateTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>制单时间区间结束</td> </tr> <tr> <td style="text-align: left;">endSaleTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>销售时间区间结束</td> </tr> <tr> <td style="text-align: left;">endStockOutTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>出库时间区间结束</td> </tr> <tr> <td style="text-align: left;">endUpdateTime</td> <td style="text-align: left;">否</td> <td>string</td> <td>更新时间区间结束</td> </tr> <tr> <td style="text-align: left;">foNos</td> <td style="text-align: left;">否</td> <td>array</td> <td>发货批次号集合 example: [ &quot;FO2022050101&quot; ]</td> </tr> <tr> <td style="text-align: left;">orderNos</td> <td style="text-align: left;">否</td> <td>array</td> <td>订单号集合</td> </tr> <tr> <td style="text-align: left;">pageNum</td> <td style="text-align: left;">是</td> <td>string</td> <td>页码</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">是</td> <td>string</td> <td>每页显示记录数,1-100,大于100按100计算</td> </tr> <tr> <td style="text-align: left;">referenceNos</td> <td style="text-align: left;">否</td> <td>array</td> <td>referenceNos</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "msg": "操作成功", "code": 200, "data": [ { "orderNo": "A0825_0001", "saleTime": "2022-08-25 00:00:00", "fulfilmentTime": null, "warehouseCode": "FRWAREHOUSE", "saleChannelCode": null, "logisticsServiceCode": null, "isRegistered": 0, "consigneeName": "liu_fr", "consigneeStreetOne": "9 B RUE DU PLANET", "consigneeStreetTwo": "", "consigneePostcode": "30390", "consigneeCountry": "法国", "consigneeCountryCode": "fr", "consigneeState": "GD", "consigneeCity": "THEZIERS", "consigneeEmail": "jplau@126.com", "consigneeTel": "0033783779455", "consigneeTaxNo": "", "companyName": "", "isInsured": 0, "foNo": "FO202208250002-YTD", "status": 30, "orderErrorMsg": null, "referenceNo": null, "trackingNumber": null, "lastTrackingNumber": "123", "createTime": "2022-08-25 09:49:18.888", "updateTime": "2022-08-25 09:49:43.682", "expressFee": 0, "operateFee": 0, "packageFee": 0, "orderWeight": 2, "actualWeight": null, "orderVolumeWeight": null, "actualVolumeWeight": null, "trackNumber": "", "labelUrl": "", "attachmentUrl": "http:\/\/www.1.com\/appli\/etiquette-2580980-20231016092916.pdf", "details": [ { "sku": "AX99001103", "qty": 1 } ], "boxDetails": [ { "boxNumber": "T52402", "sku": "AX99001101", "qty": 1, "trackNumber": "12313x56" } ] } ] } </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;">orderNo</td> <td style="text-align: left;">string</td> <td>订单号</td> </tr> <tr> <td style="text-align: left;">saleTime</td> <td style="text-align: left;">string</td> <td>订单销售时间</td> </tr> <tr> <td style="text-align: left;">fulfilmentTime</td> <td style="text-align: left;">date</td> <td>仓库交付物流派送时间</td> </tr> <tr> <td style="text-align: left;">warehouseCode</td> <td style="text-align: left;">string</td> <td>发货仓库编码</td> </tr> <tr> <td style="text-align: left;">saleChannelCode</td> <td style="text-align: left;">string</td> <td>销售渠道编号</td> </tr> <tr> <td style="text-align: left;">logisticsServiceCode</td> <td style="text-align: left;">string</td> <td>派送渠道编号</td> </tr> <tr> <td style="text-align: left;">isRegistered</td> <td style="text-align: left;">string</td> <td>是否挂号错误(0:否 1:是)</td> </tr> <tr> <td style="text-align: left;">consigneeName</td> <td style="text-align: left;">string</td> <td>收货人</td> </tr> <tr> <td style="text-align: left;">consigneeStreetOne</td> <td style="text-align: left;">string</td> <td>收货人街道1</td> </tr> <tr> <td style="text-align: left;">consigneeStreetTwo</td> <td style="text-align: left;">string</td> <td>收货人街道2</td> </tr> <tr> <td style="text-align: left;">consigneePostcode</td> <td style="text-align: left;">string</td> <td>收货人邮编</td> </tr> <tr> <td style="text-align: left;">consigneeCountry</td> <td style="text-align: left;">string</td> <td>收货人国家</td> </tr> <tr> <td style="text-align: left;">consigneeCountryCode</td> <td style="text-align: left;">string</td> <td>收货人国家简码</td> </tr> <tr> <td style="text-align: left;">consigneeState</td> <td style="text-align: left;">string</td> <td>联系人州省份</td> </tr> <tr> <td style="text-align: left;">consigneeCity</td> <td style="text-align: left;">string</td> <td>收货人城市</td> </tr> <tr> <td style="text-align: left;">consigneeEmail</td> <td style="text-align: left;">string</td> <td>收货人Email</td> </tr> <tr> <td style="text-align: left;">consigneeTel</td> <td style="text-align: left;">string</td> <td>收货人电话</td> </tr> <tr> <td style="text-align: left;">consigneeTaxNo</td> <td style="text-align: left;">string</td> <td>收货人税号</td> </tr> <tr> <td style="text-align: left;">companyName</td> <td style="text-align: left;">string</td> <td>收货人公司名</td> </tr> <tr> <td style="text-align: left;">isInsured</td> <td style="text-align: left;">string</td> <td>是否投保(0:否 1:是)</td> </tr> <tr> <td style="text-align: left;">foNo</td> <td style="text-align: left;">string</td> <td>发货批次号</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">string</td> <td>状态 10草稿,20待审核,25审核不通过,30待发货,40已配货,50发货中,90已发货,70截单中,95已作废(截单),100已作废</td> </tr> <tr> <td style="text-align: left;">orderErrorMsg</td> <td style="text-align: left;">string</td> <td>订单错误提示,特别注意:ERP在创建成功后,海外仓需要异步获取取跟踪号,如果获取跟踪号失败,会有提示信息 ERP应要取到这个失败的提示,展示给客户,</td> </tr> <tr> <td style="text-align: left;">referenceNo</td> <td style="text-align: left;">string</td> <td>客户单号、参考号</td> </tr> <tr> <td style="text-align: left;">trackingNumber</td> <td style="text-align: left;">string</td> <td>物流追踪号,由仓库回写</td> </tr> <tr> <td style="text-align: left;">lastTrackingNumber</td> <td style="text-align: left;">string</td> <td>尾程跟踪号,由仓库回写</td> </tr> <tr> <td style="text-align: left;">createTime</td> <td style="text-align: left;">string</td> <td>订单创建时间</td> </tr> <tr> <td style="text-align: left;">updateTime</td> <td style="text-align: left;">string</td> <td>订单最后一次更新时间</td> </tr> <tr> <td style="text-align: left;">expressFee</td> <td style="text-align: left;">string</td> <td>快递费用,由仓库发货后回写</td> </tr> <tr> <td style="text-align: left;">operateFee</td> <td style="text-align: left;">string</td> <td>操作费,由仓库在发货后回写</td> </tr> <tr> <td style="text-align: left;">packageFee</td> <td style="text-align: left;">string</td> <td>包装费,由仓库发货后回写</td> </tr> <tr> <td style="text-align: left;">orderWeight</td> <td style="text-align: left;">string</td> <td>订单重量,单位g</td> </tr> <tr> <td style="text-align: left;">actualWeight</td> <td style="text-align: left;">object</td> <td>包裹重量,单位g</td> </tr> <tr> <td style="text-align: left;">orderVolumeWeight</td> <td style="text-align: left;">object</td> <td>订单体积重</td> </tr> <tr> <td style="text-align: left;">actualVolumeWeight</td> <td style="text-align: left;">object</td> <td>包裹体积重</td> </tr> <tr> <td style="text-align: left;">attachmentUrl</td> <td style="text-align: left;">string</td> <td>附件URL(多个逗号分隔)</td> </tr> <tr> <td style="text-align: left;">details</td> <td style="text-align: left;">array</td> <td>订单明细</td> </tr> <tr> <td style="text-align: left;">details.sku</td> <td style="text-align: left;">string</td> <td>订单明细 SKU</td> </tr> <tr> <td style="text-align: left;">details.qty</td> <td style="text-align: left;">string</td> <td>订单明细 数量</td> </tr> <tr> <td style="text-align: left;">boxDetails</td> <td style="text-align: left;">array</td> <td>装箱明细</td> </tr> <tr> <td style="text-align: left;">boxDetails.boxNumber</td> <td style="text-align: left;">string</td> <td>盒子号</td> </tr> <tr> <td style="text-align: left;">boxDetails.sku</td> <td style="text-align: left;">string</td> <td>SKU</td> </tr> <tr> <td style="text-align: left;">boxDetails.qty</td> <td style="text-align: left;">string</td> <td>装箱数量</td> </tr> <tr> <td style="text-align: left;">boxDetails.trackNumber</td> <td style="text-align: left;">string</td> <td>装箱跟踪号</td> </tr> </tbody> </table> <h5>失败返回示例</h5> <pre><code>{ "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>

页面列表

ITEM_HTML