OMS接口文档

OMS接口文档


订单查询

<p><strong>简要描述:</strong> </p> <ul> <li> <p>订单查询接口,主要用于所有单据操作之前调用该接口获取订单时间戳</p> <p>重要!!! 使用此接口查询 请务必按需要传入参数中的 headselectfields(需要返回的订单头字段)、bodyselectfields(需要返回的订单体字段),可以很大的提升查询效率。 请开发者务必遵循。 入参中按照时间范围获取订单 时间跨度建议不大于一天。 能大大提高响应速度和成功率。</p> <p>pagesize 每页条数。建议使用40,可以提高成功率,减少超时数量。</p> </li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li>` <a href="https://omsapi.yonyoucloud.com/dst-web/api/billoperation/apiaction?access_token">https://omsapi.yonyoucloud.com/dst-web/api/billoperation/apiaction?access_token</a>=</li> </ul> <p><strong>推荐对接方案:</strong> </p> <ul> <li><a href="https://www.showdoc.cc/265424688438926?page_id=3727236885063494">https://www.showdoc.cc/265424688438926?page_id=3727236885063494</a></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">billnum</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>单据编码 ec_tradeorder</td> </tr> <tr> <td style="text-align: left;">action</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>操作类型 tradeinfos</td> </tr> <tr> <td style="text-align: left;">partParam</td> <td style="text-align: left;">是</td> <td style="text-align: left;">map</td> <td>查询条件集合</td> </tr> <tr> <td style="text-align: left;">headselectfields</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>需要返回的订单头字段 如tid,status 按逗号分隔 此参数必输 返回字段可以参考 <a href="https://www.showdoc.cc/265424688438926?page_id=1999778270293645">https://www.showdoc.cc/265424688438926?page_id=1999778270293645</a></td> </tr> <tr> <td style="text-align: left;">headdefineselectfields</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>需要返回的订单头自定义字段 如define1,define2 如果不需要反馈自定义项 此参数可不传</td> </tr> <tr> <td style="text-align: left;">bodyselectfields</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>需要返回的订单体字段 如tid,cWhCode 按逗号分隔 此参数必输 返回字段可以参考 <a href="https://www.showdoc.cc/265424688438926?page_id=1999778270293645">https://www.showdoc.cc/265424688438926?page_id=1999778270293645</a></td> </tr> <tr> <td style="text-align: left;">bodydefineselectfields</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>需要返回的订单头自定义字段 如define1,define2 按逗号分隔 如果不需要反馈自定义项 此参数可不传</td> </tr> <tr> <td style="text-align: left;">pageIndex</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>页码</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>每页数据行数 (最大不要超过40,如果传入超过40的数值会影响结果范围,不准确或者请求超时,请注意!)</td> </tr> <tr> <td style="text-align: left;">start_created</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询交易创建时间开始。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">end_created</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询交易创建时间结束。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">start_pay</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询付款时间开始。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">end_pay</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询付款时间结束。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">start_pubts</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询更新时间开始。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">end_pubts</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询更新结束。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">start_rpttime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询日结时间开始。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">end_rpttime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询日结时间结束。格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>线上交易状态</td> </tr> <tr> <td style="text-align: left;">sys_Status</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>oms系统订单处理状态,多个状态用,分隔</td> </tr> <tr> <td style="text-align: left;">tid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>交易编号</td> </tr> <tr> <td style="text-align: left;">shipcode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>发货单号</td> </tr> <tr> <td style="text-align: left;">start_shiptime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询发货开始时间 格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">end_shiptime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>查询发货开始时间 格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">否</td> <td style="text-align: left;">long</td> <td>订单id</td> </tr> <tr> <td style="text-align: left;">ids</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>订单ids 多个id用英文逗号分隔</td> </tr> <tr> <td style="text-align: left;">shipmode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>发货模式 ,多个模式用,分隔</td> </tr> <tr> <td style="text-align: left;">ishold</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>挂起状态 0-未挂起,1-已挂起</td> </tr> <tr> <td style="text-align: left;">isclosed</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>关闭状态 0-未关闭,1-已关闭</td> </tr> <tr> <td style="text-align: left;">shopcode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>店铺编码(查询若不传id或ids,则必传shopcode)</td> </tr> <tr> <td style="text-align: left;">tradecode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>电商订单号</td> </tr> <tr> <td style="text-align: left;">isposted</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>是否日结 1-日结 2-未日结</td> </tr> <tr> <td style="text-align: left;">plat</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>平台</td> </tr> <tr> <td style="text-align: left;">wmsDeliveryCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>WMS出库单号</td> </tr> <tr> <td style="text-align: left;">cExpressCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>快递单号</td> </tr> <tr> <td style="text-align: left;">blendId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>勾对ID</td> </tr> <tr> <td style="text-align: left;">salerptcode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>日报号</td> </tr> </tbody> </table> <p>*<em> </em>备注 接口返回参数描述请参看订单新增接口文档 pubts--时间戳**</p> <p><strong>线上交易状态</strong></p> <table> <thead> <tr> <th style="text-align: left;">需要传入值</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">waiting_buyer_to_pay</td> <td style="text-align: left;">待付款</td> </tr> <tr> <td style="text-align: left;">buyers_have_paid</td> <td style="text-align: left;">待发货</td> </tr> <tr> <td style="text-align: left;">sellers_have_been_shipped</td> <td style="text-align: left;">已发货</td> </tr> <tr> <td style="text-align: left;">sellers_have_been_shipped</td> <td style="text-align: left;">部分发货</td> </tr> <tr> <td style="text-align: left;">trade_closed</td> <td style="text-align: left;">交易关闭</td> </tr> <tr> <td style="text-align: left;">trade_refunding</td> <td style="text-align: left;">退款中</td> </tr> <tr> <td style="text-align: left;">trade_finished</td> <td style="text-align: left;">交易完成</td> </tr> </tbody> </table> <p><strong>oms系统订单处理状态</strong></p> <table> <thead> <tr> <th style="text-align: left;">需要传入值</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">unapprove</td> <td style="text-align: left;">待审核</td> </tr> <tr> <td style="text-align: left;">bizapprove</td> <td style="text-align: left;">已客审</td> </tr> <tr> <td style="text-align: left;">finapprove</td> <td style="text-align: left;">待发货</td> </tr> <tr> <td style="text-align: left;">shipconfirm</td> <td style="text-align: left;">已发货</td> </tr> </tbody> </table> <p><strong>发货模式</strong></p> <table> <thead> <tr> <th style="text-align: left;">需要传入值</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">EnterpriseDeliver</td> <td style="text-align: left;">企业发货</td> </tr> <tr> <td style="text-align: left;">ECDeliver</td> <td style="text-align: left;">电商发货</td> </tr> <tr> <td style="text-align: left;">WMSDeliver</td> <td style="text-align: left;">WMS仓发货</td> </tr> </tbody> </table> <table> <thead> <tr> <th style="text-align: left;">需要传入值</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">EnterpriseDeliver</td> <td style="text-align: left;">企业发货</td> </tr> <tr> <td style="text-align: left;">ECDeliver</td> <td style="text-align: left;">电商发货</td> </tr> <tr> <td style="text-align: left;">WMSDeliver</td> <td style="text-align: left;">WMS仓发货</td> </tr> </tbody> </table> <p>订单来源</p> <table> <thead> <tr> <th style="text-align: left;">需要传入值</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">0</td> <td style="text-align: left;">其他</td> </tr> <tr> <td style="text-align: left;">1</td> <td style="text-align: left;">下载</td> </tr> <tr> <td style="text-align: left;">2</td> <td style="text-align: left;">导入</td> </tr> <tr> <td style="text-align: left;">3</td> <td style="text-align: left;">手工新增</td> </tr> <tr> <td style="text-align: left;">4</td> <td style="text-align: left;">手工换货</td> </tr> <tr> <td style="text-align: left;">5</td> <td style="text-align: left;">参照生单</td> </tr> <tr> <td style="text-align: left;">6</td> <td style="text-align: left;">京东售后</td> </tr> <tr> <td style="text-align: left;">7</td> <td style="text-align: left;">天猫换货</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code>{ "partParam": { "headselectfields":"tid,cTradeCode,cExpressCoID.expressName as expressName,receiver_city,receiver_name,receiver_mobile,payment,status", "headdefineselectfields":"define10", "bodyselectfields":"citemID.skuName,citemID.cCode as skuCode,cWhCode.code as warahouseCode,num,onsale_num,divide_order_fee,status", "bodydefineselectfields":"id", "pageIndex": "1", "pageSize": "100", "ids": "1472833018876168,1472833018876164,1472826786337024" }, "billnum": "ec_tradeorder", "action": "tradeinfos" }</code></pre> <p><strong>返回示例</strong></p> <pre><code>{ "code": 200, "message": "操作成功", "data": { "pageIndex": 1, "pageSize": 40, "totalCount": 3, "info": [ { "tradeOrderDetail": [ { "realNum": 1, "num": 1, "onsale_num": 0, "warahouseCode": "SF0001", "warehouseName": "顺丰仓库", "parentid": 1472826786337024, "warehouseCode": "SF0001", "divide_order_fee": 0, "skuName": "冻大西洋鳕鱼去皮片-", "citemID_skuName": "冻大西洋鳕鱼去皮片-", "citemID": 1224055187804416, "cWhCode": 1221529601872128, "id": 1472826786337025, "skuCode": "124100600000", "status": "WAIT_GOODS_RECEIVE_CONFIRM" } ], "expressName": "京东物流", "receiver_city": "抚顺市", "receiver_name": "张三", "payment": 139, "id": 1472826786337024, "receiver_mobile": "18888888888", "tid": "106499050676", "cTradeCode": "DD12212019110700000053", "status": "sellers_have_been_shipped" }, { "tradeOrderDetail": [ { "realNum": 1, "num": 1, "onsale_num": 0, "parentid": 1472833018876164, "divide_order_fee": 33.9, "skuName": "红酒", "citemID_skuName": "红酒", "citemID": 1221233400156416, "cWhCode": 0, "id": 1472833018876165, "skuCode": "005", "status": "TRADE_FINISHED" } ], "expressName": "中通学院路网点", "receiver_city": "北京市", "receiver_name": "李四", "payment": 33.9, "id": 1472833018876164, "receiver_mobile": "18888888888", "tid": "683912419274649545", "cTradeCode": "DD12942019102700000024", "status": "trade_finished" }, { "tradeOrderDetail": [ { "realNum": 1, "num": 1, "onsale_num": 0, "parentid": 1472833018876168, "divide_order_fee": 33.9, "skuName": "红酒", "citemID_skuName": "红酒", "citemID": 1221233400156416, "cWhCode": 0, "id": 1472833018876169, "skuCode": "005", "status": "TRADE_FINISHED" } ], "expressName": "中通学院路网点", "receiver_city": "济南市", "receiver_name": "王五", "payment": 33.9, "id": 1472833018876168, "receiver_mobile": "18888888888", "tid": "683496897583938768", "cTradeCode": "DD12942019102700000025", "status": "trade_finished" } ] } }</code></pre> <p><strong>返回参数说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML