OMS 对外开放接口说明

OMS 对外开放接口说明


订单创建

<h5>简要描述</h5> <ul> <li>订单和转仓订单的创建</li> </ul> <h5>接口状态</h5> <ul> <li>已完成</li> </ul> <h5>请求URL</h5> <ul> <li><code>/v1/order/create</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求参数示例</h5> <pre><code>{ "orderNo": "T202203040005", "warehouseCode": "WAREHOUSEIT", "logisticsServiceCode": "FR-GLS-L", "saleTime": "2022-03-08", "referenceNo": "SO202201130001", "saleChannelCode": "amazon", "isRegistered": 1, "isInsured": 0, "insuranceAmount": 00, "isConfirm": 1, "thirdType": "1", "thirdWarehouseCode": "TW01WAREHOUSE", "itemId": "123", "transactionId": "123", "details": [ { "sku": "test", "qty": 1 } ], "consigneeCountryCode": "cn", "consigneeState": "GD", "consigneeCity": "米兰", "consigneeEmail": "123458756@qq.com", "consigneeName": "张自然", "consigneePostcode": "518666", "consigneeStreetOne": "宝安大道", "consigneeStreetTwo": "", "consigneeTaxNo": "5070826", "consigneeTel": "13115070826", "companyName":"", "notes":"", "trackNumber": "", "labelUrl": "", "attachmentUrl": "" } </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;">orderNo</td> <td style="text-align: left;">是</td> <td>string</td> <td>订单号</td> </tr> <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;">logisticsServiceCode</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>销售日期 example: 2022-03-08</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;">isRegistered</td> <td style="text-align: left;">是</td> <td>int</td> <td>是否挂号 0:否 1:是</td> </tr> <tr> <td style="text-align: left;">isInsured</td> <td style="text-align: left;">是</td> <td>int</td> <td>是否投保 0:否 1:是</td> </tr> <tr> <td style="text-align: left;">insuranceAmount</td> <td style="text-align: left;">否</td> <td>number</td> <td>投保金额,当选择投保时,可以输入投保金额,如果不填写,则使用产品的保险金额。</td> </tr> <tr> <td style="text-align: left;">isConfirm</td> <td style="text-align: left;">是</td> <td>int</td> <td>是否确认 example: 0:否 1:是 为1则订单直接审核通过</td> </tr> <tr> <td style="text-align: left;">thirdType</td> <td style="text-align: left;">否</td> <td>string</td> <td>第三方仓库类型(生成转仓订单必传) example: 1-fba,2-fbc,3-第三方仓库,4-自提客户</td> </tr> <tr> <td style="text-align: left;">thirdWarehouseCode</td> <td style="text-align: left;">否</td> <td>string</td> <td>第三方仓库编码(如果传请从基础数据中的第三方仓库接口中查询,可为空)</td> </tr> <tr> <td style="text-align: left;">itemId</td> <td style="text-align: left;">否</td> <td>string</td> <td>销售平台的ItemId,同一订单传其中一个即可</td> </tr> <tr> <td style="text-align: left;">transactionId</td> <td style="text-align: left;">否</td> <td>string</td> <td>销售平台的交易ID,同一订单传其中一个即可</td> </tr> <tr> <td style="text-align: left;">details</td> <td style="text-align: left;">是</td> <td>array</td> <td>订单详情 example: [{&quot;sku&quot;:&quot;123&quot;,&quot;qty&quot;:1}]</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.qty</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;">consigneeCity</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;">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> <tr> <td style="text-align: left;">labelUrl</td> <td style="text-align: left;">否</td> <td>string</td> <td>面单URL用于自上传(仅PDF文件)</td> </tr> <tr> <td style="text-align: left;">trackNumber</td> <td style="text-align: left;">否</td> <td>string</td> <td>物流跟踪号用于自上传</td> </tr> <tr> <td style="text-align: left;">orderPrePackBoxDetails</td> <td style="text-align: left;">否</td> <td>string</td> <td>装箱明细,FBA转仓有装箱明细时可填</td> </tr> <tr> <td style="text-align: left;">orderPrePackBoxDetails.boxNumber</td> <td style="text-align: left;">是</td> <td>string</td> <td>箱号</td> </tr> <tr> <td style="text-align: left;">orderPrePackBoxDetails.sku</td> <td style="text-align: left;">是</td> <td>string</td> <td>sku编码同订单明细</td> </tr> <tr> <td style="text-align: left;">orderPrePackBoxDetails.qty</td> <td style="text-align: left;">是</td> <td>string</td> <td>sku数量</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "msg": "上传成功", "code": 200, "data": { "referenceNo": "202201130001", "foNo": "FO202205240005-XOD" } } </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;">referenceNo</td> <td style="text-align: left;">string</td> <td>客户单号</td> </tr> <tr> <td style="text-align: left;">foNo</td> <td style="text-align: left;">string</td> <td>发货批次号</td> </tr> </tbody> </table> <h5>失败返回示例</h5> <pre><code>{ "errcode": "30003", "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>错误码: 00000:参数错误,如:单号为空、重复,国家简码不正确 00001:单号生成错误 30001:发货仓库不存在 30002:销售渠道不存在 30003:派送渠道不存在 00005:保存失败</p>

页面列表

ITEM_HTML