OMS 对外开放接口说明

OMS 对外开放接口说明


创建订单-直发

<h5>简要描述</h5> <ul> <li>创建直发订单</li> </ul> <h5>请求URL</h5> <ul> <li><code>/v1/order/createDirect</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求参数示例</h5> <pre><code>{ "orderNo": "R0000012", "referenceNo": "R0000012", "warehouseCode": "WAREHOUSEUK", "logisticsServiceCode": "BJS_GB_1", "saleChannelCode": "amazon", "saleTime": "2028-01-04", "isConfirm": 1, "details": [ { "sku": "test_46a14550a963", "qty": 2, "length": 65.61, "width": 86.68, "height": 85.38, "weight": 2000 } ], "consignee": { "name": "test_09f6ab16cd42", "countryCode": "GB", "state": "test_643eb2fb2dc1", "city": "test_e9448fecfad8", "streetOne": "test_38ca213f16a8", "streetTwo": "", "postcode": "A12 G1", "email": "test_8d4301a56d67", "tel": "95873897e617", "taxNo": "", "companyName": "" }, "shipper": { "name": "test1", "countryCode": "GB", "state": "", "city": "landon", "streetOne": "street1", "streetTwo": "", "postcode": "A12 G1", "email": "e@e.com", "tel": "", "timezone": "1" }, "parcelLength": 64.1, "parcelWidth": 86.45, "parcelHeight": 38.82, "parcelWeight": 16.93, "isRegistered": 0, "isInsured": 0, "insuranceAmount": 32.21, "itemId": "", "transactionId": "", "attachmentUrl": "http:\/\/test_a302b27b7514.pdf", "notes": "test_5aa705faad18" } </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;">referenceNo</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;">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>date</td> <td>销售日期</td> </tr> <tr> <td style="text-align: left;">isConfirm</td> <td style="text-align: left;">是</td> <td>int</td> <td>是否确认0否1是</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>string</td> <td>sku</td> </tr> <tr> <td style="text-align: left;">details.qty</td> <td style="text-align: left;">是</td> <td>int</td> <td>数量</td> </tr> <tr> <td style="text-align: left;">details.length</td> <td style="text-align: left;">否</td> <td>number</td> <td>长(单位cm)</td> </tr> <tr> <td style="text-align: left;">details.width</td> <td style="text-align: left;">否</td> <td>number</td> <td>宽(单位cm)</td> </tr> <tr> <td style="text-align: left;">details.height</td> <td style="text-align: left;">否</td> <td>number</td> <td>高(单位cm)</td> </tr> <tr> <td style="text-align: left;">details.weight</td> <td style="text-align: left;">否</td> <td>number</td> <td>重量(单位g)</td> </tr> <tr> <td style="text-align: left;">consignee</td> <td style="text-align: left;">是</td> <td>object</td> <td>收件人</td> </tr> <tr> <td style="text-align: left;">consignee.name</td> <td style="text-align: left;">是</td> <td>string</td> <td>名称</td> </tr> <tr> <td style="text-align: left;">consignee.countryCode</td> <td style="text-align: left;">是</td> <td>string</td> <td>国家码(两位)</td> </tr> <tr> <td style="text-align: left;">consignee.state</td> <td style="text-align: left;">否</td> <td>string</td> <td>省</td> </tr> <tr> <td style="text-align: left;">consignee.city</td> <td style="text-align: left;">是</td> <td>string</td> <td>城市</td> </tr> <tr> <td style="text-align: left;">consignee.streetOne</td> <td style="text-align: left;">是</td> <td>string</td> <td>街道1</td> </tr> <tr> <td style="text-align: left;">consignee.streetTwo</td> <td style="text-align: left;">否</td> <td>string</td> <td>街道2</td> </tr> <tr> <td style="text-align: left;">consignee.postcode</td> <td style="text-align: left;">是</td> <td>string</td> <td>邮编</td> </tr> <tr> <td style="text-align: left;">consignee.email</td> <td style="text-align: left;">否</td> <td>string</td> <td>邮箱(部分渠道需要邮箱)</td> </tr> <tr> <td style="text-align: left;">consignee.tel</td> <td style="text-align: left;">是</td> <td>string</td> <td>电话</td> </tr> <tr> <td style="text-align: left;">consignee.taxNo</td> <td style="text-align: left;">否</td> <td>string</td> <td>税号</td> </tr> <tr> <td style="text-align: left;">consignee.companyName</td> <td style="text-align: left;">否</td> <td>string</td> <td>公司名</td> </tr> <tr> <td style="text-align: left;">shipper</td> <td style="text-align: left;">否</td> <td>object</td> <td>发件人(默认使用仓库的地址信息)</td> </tr> <tr> <td style="text-align: left;">shipper.name</td> <td style="text-align: left;">是</td> <td>string</td> <td>发件人名称</td> </tr> <tr> <td style="text-align: left;">shipper.countryCode</td> <td style="text-align: left;">是</td> <td>string</td> <td>发件人-国家简码</td> </tr> <tr> <td style="text-align: left;">shipper.state</td> <td style="text-align: left;">否</td> <td>string</td> <td>发件人-省</td> </tr> <tr> <td style="text-align: left;">shipper.city</td> <td style="text-align: left;">是</td> <td>string</td> <td>发件人-城市</td> </tr> <tr> <td style="text-align: left;">shipper.streetOne</td> <td style="text-align: left;">是</td> <td>string</td> <td>发件人-街道1</td> </tr> <tr> <td style="text-align: left;">shipper.streetTwo</td> <td style="text-align: left;">否</td> <td>string</td> <td>发件人-街道2</td> </tr> <tr> <td style="text-align: left;">shipper.postcode</td> <td style="text-align: left;">是</td> <td>string</td> <td>发件人-邮编</td> </tr> <tr> <td style="text-align: left;">shipper.email</td> <td style="text-align: left;">否</td> <td>string</td> <td>发件人-邮箱</td> </tr> <tr> <td style="text-align: left;">shipper.tel</td> <td style="text-align: left;">否</td> <td>string</td> <td>发件人-电话</td> </tr> <tr> <td style="text-align: left;">shipper.timezone</td> <td style="text-align: left;">否</td> <td>int</td> <td>发件人-时区</td> </tr> <tr> <td style="text-align: left;">parcelLength</td> <td style="text-align: left;">是</td> <td>number</td> <td>包裹长cm</td> </tr> <tr> <td style="text-align: left;">parcelWidth</td> <td style="text-align: left;">是</td> <td>number</td> <td>包裹宽cm</td> </tr> <tr> <td style="text-align: left;">parcelHeight</td> <td style="text-align: left;">是</td> <td>number</td> <td>包裹高cm</td> </tr> <tr> <td style="text-align: left;">parcelWeight</td> <td style="text-align: left;">是</td> <td>number</td> <td>包裹重量g</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;">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;">attachmentUrl</td> <td style="text-align: left;">否</td> <td>string</td> <td>附件URL(多个逗号分隔)</td> </tr> <tr> <td style="text-align: left;">notes</td> <td style="text-align: left;">否</td> <td>string</td> <td>备注</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "msg": "上传成功", "code": 200, "data": { "foNo": "ZF2311160010-B9", "referenceNo": "R0000002" } } </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;">number</td> <td>成功200 其他失败</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;">foNo</td> <td style="text-align: left;">string</td> <td>发货批次号</td> </tr> <tr> <td style="text-align: left;">referenceNo</td> <td style="text-align: left;">string</td> <td>客户参考号</td> </tr> </tbody> </table>

页面列表

ITEM_HTML