欧珀莱麒麟CRM对外接口


P21-订单查询

<p><strong>简要描述:</strong> </p> <ul> <li>会员总订单列表</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li>环境地址: <code>https://kylinapi.aupres.com.cn/omni-integration-api/v1/main/page</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>GET </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;">memberType</td> <td style="text-align: left;">Y</td> <td style="text-align: left;">会员类型 传固定值aupres</td> <td>string</td> </tr> <tr> <td style="text-align: left;">currentPage</td> <td style="text-align: left;">N</td> <td style="text-align: left;">当前页数, 默认为1</td> <td>integer(int32)</td> </tr> <tr> <td style="text-align: left;">memberId</td> <td style="text-align: left;">Y</td> <td style="text-align: left;">会员ID</td> <td>string</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">N</td> <td style="text-align: left;">分页容量, 默认为20</td> <td>integer(int32)</td> </tr> <tr> <td style="text-align: left;">orderField</td> <td style="text-align: left;">N</td> <td style="text-align: left;">排序字段(orderTime:下单时间倒叙,payTime: 订单付款时间倒叙)</td> <td>string</td> </tr> <tr> <td style="text-align: left;">orderStatus</td> <td style="text-align: left;">N</td> <td style="text-align: left;">订单状态(CREATED 下单;CANCELLED 订单取消;DELIVERED 已发货;CONFIRMED 卖家已确认;FINISHED 订单完成;REFUND_START 退款开始;REFUNDING 退款中;REFUND_FINISHED 退款完成;REFUND_CANCEL 退款取消)</td> <td>string</td> </tr> <tr> <td style="text-align: left;">channelType</td> <td style="text-align: left;">Y</td> <td style="text-align: left;">固定值:POS</td> <td>string</td> </tr> <tr> <td style="text-align: left;">orderBy</td> <td style="text-align: left;">N</td> <td style="text-align: left;">时间排序规则 ASC-正序,DESC-倒叙 (若不传默认倒叙)</td> <td>string</td> </tr> </tbody> </table> <p><strong>返回参数</strong> </p> <table> <thead> <tr> <th style="text-align: left;">HTTP Code</th> <th style="text-align: left;">Description</th> <th>Schema</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">200</td> <td style="text-align: left;">OK</td> <td><code>基本分页结果</code></td> </tr> <tr> <td style="text-align: left;">401</td> <td style="text-align: left;">Unauthorized</td> <td>No Content</td> </tr> <tr> <td style="text-align: left;">403</td> <td style="text-align: left;">Forbidden</td> <td>No Content</td> </tr> <tr> <td style="text-align: left;">404</td> <td style="text-align: left;">Not Found</td> <td>No Content</td> </tr> </tbody> </table> <p><strong>返回参数说明</strong> </p> <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;">currentPage</td> <td style="text-align: left;">当前页</td> <td>integer</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">分页容量</td> <td>integer</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">分页数据</td> <td>array</td> </tr> </tbody> </table> <p><strong>data说明</strong> </p> <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;">channelType</td> <td style="text-align: left;">渠道</td> <td>string</td> </tr> <tr> <td style="text-align: left;">couponFee</td> <td style="text-align: left;">优惠劵金额</td> <td>number(double)</td> </tr> <tr> <td style="text-align: left;">couponNo</td> <td style="text-align: left;">优惠劵码</td> <td>string</td> </tr> <tr> <td style="text-align: left;">string</td> <td style="text-align: left;">客户编号(单渠道唯一标识)</td> <td>string</td> </tr> <tr> <td style="text-align: left;">customizedProperties</td> <td style="text-align: left;">扩展字段</td> <td>object</td> </tr> <tr> <td style="text-align: left;">description</td> <td style="text-align: left;">订单备注</td> <td>string</td> </tr> <tr> <td style="text-align: left;">discountFee</td> <td style="text-align: left;">折扣金额</td> <td>number(double)</td> </tr> <tr> <td style="text-align: left;">discountRate</td> <td style="text-align: left;">折扣率 &lt;=1</td> <td>number(double)</td> </tr> <tr> <td style="text-align: left;">exchangeTime</td> <td style="text-align: left;">订单换货时间 格式: yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td> <td>string(date-time)</td> </tr> <tr> <td style="text-align: left;">freight</td> <td style="text-align: left;">运费</td> <td>number(double)</td> </tr> <tr> <td style="text-align: left;">guideCode</td> <td style="text-align: left;">订单对应导购</td> <td>string</td> </tr> <tr> <td style="text-align: left;">isInternal</td> <td style="text-align: left;">是否是内部订单. Y:否 N:是 . 默认为N</td> <td>string</td> </tr> <tr> <td style="text-align: left;">isSend</td> <td style="text-align: left;">isSend, 默认为N</td> <td>string</td> </tr> <tr> <td style="text-align: left;">lastSync</td> <td style="text-align: left;">数据同步时间</td> <td>string(date-time)</td> </tr> <tr> <td style="text-align: left;">memberId</td> <td style="text-align: left;">会员ID</td> <td>string</td> </tr> <tr> <td style="text-align: left;">memberType</td> <td style="text-align: left;">会员类型</td> <td>string</td> </tr> <tr> <td style="text-align: left;">orderCoupons</td> <td style="text-align: left;">订单优惠券</td> <td>array</td> </tr> <tr> <td style="text-align: left;">orderId</td> <td style="text-align: left;">订单ID</td> <td>string</td> </tr> <tr> <td style="text-align: left;">orderItems</td> <td style="text-align: left;">子订单信息</td> <td>array</td> </tr> <tr> <td style="text-align: left;">orderPays</td> <td style="text-align: left;">订单支付方式</td> <td>array</td> </tr> <tr> <td style="text-align: left;">orderStatus</td> <td style="text-align: left;">订单状态</td> <td>string</td> </tr> <tr> <td style="text-align: left;">orderStatusDesc</td> <td style="text-align: left;">订单状态描述</td> <td>string</td> </tr> <tr> <td style="text-align: left;">orderTime</td> <td style="text-align: left;">下单时间, 格式: yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td> <td>string(date-time)</td> </tr> <tr> <td style="text-align: left;">orderType</td> <td style="text-align: left;">订单类型:正常单 - NORMAL, 退单 - REFUND</td> <td>string</td> </tr> <tr> <td style="text-align: left;">originOrderId</td> <td style="text-align: left;">原始订单ID, 退单时传</td> <td>string</td> </tr> <tr> <td style="text-align: left;">payTime</td> <td style="text-align: left;">订单付款时间 格式: yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td> <td>string(date-time)</td> </tr> <tr> <td style="text-align: left;">payment</td> <td style="text-align: left;">实付金额</td> <td>number(double)</td> </tr> <tr> <td style="text-align: left;">pointFlag</td> <td style="text-align: left;">是否计算积分. 0-不计算积分, 1- 计算积分</td> <td>integer(int32)</td> </tr> <tr> <td style="text-align: left;">receiveTime</td> <td style="text-align: left;">订单发货时间 格式: yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td> <td>string(date-time)</td> </tr> <tr> <td style="text-align: left;">receiverAddress</td> <td style="text-align: left;">收货人地址</td> <td>string</td> </tr> <tr> <td style="text-align: left;">receiverCity</td> <td style="text-align: left;">市</td> <td>string</td> </tr> <tr> <td style="text-align: left;">receiverDistrict</td> <td style="text-align: left;">区县</td> <td>string</td> </tr> <tr> <td style="text-align: left;">receiverMobile</td> <td style="text-align: left;">收货人手机号</td> <td>string</td> </tr> <tr> <td style="text-align: left;">receiverName</td> <td style="text-align: left;">收货人姓名</td> <td>string</td> </tr> <tr> <td style="text-align: left;">receiverProvince</td> <td style="text-align: left;">省</td> <td>string</td> </tr> <tr> <td style="text-align: left;">receiverTelephone</td> <td style="text-align: left;">收货人固定电话</td> <td>string</td> </tr> <tr> <td style="text-align: left;">receiverZipCode</td> <td style="text-align: left;">邮编</td> <td>string</td> </tr> <tr> <td style="text-align: left;">refundTime</td> <td style="text-align: left;">订单退货时间 格式: yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td> <td>string(date-time)</td> </tr> <tr> <td style="text-align: left;">shippingTime</td> <td style="text-align: left;">订单收货时间 格式: yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td> <td>string(date-time)</td> </tr> <tr> <td style="text-align: left;">shopCode</td> <td style="text-align: left;">注册门店code</td> <td>string</td> </tr> <tr> <td style="text-align: left;">shopName</td> <td style="text-align: left;">注册门店名称</td> <td>string</td> </tr> <tr> <td style="text-align: left;">shopTypeCode</td> <td style="text-align: left;">注册门店类型code</td> <td>string</td> </tr> <tr> <td style="text-align: left;">totalFee</td> <td style="text-align: left;">应付金额</td> <td>number(double)</td> </tr> <tr> <td style="text-align: left;">totalQuantity</td> <td style="text-align: left;">商品总数</td> <td>integer(int32)</td> </tr> <tr> <td style="text-align: left;">updateTime</td> <td style="text-align: left;">更新时间</td> <td>string(date-time)</td> </tr> </tbody> </table>

页面列表

ITEM_HTML