[[TOC]] = 聚超值2.4.0接口文档 = == 一.基本约定 == {{{ 1.开发机、测试机代理地址： mrobot开发机代理：192.168.10.199 端口：1080 mrobot测试机代理：192.168.10.198 端口：1080 电脑网应用端测试环境域名 v72.pconline.com.cn:80 电脑网应用端线上环境域名 best.pconline.com.cn mrobot线上环境域名：mrobot.pconline.com.cn mrobot测试环境域名：v80.pconline.com.cn mrobot开发环境域名：dev40.pconline.com.cn 2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。 { "desc":"给用户的提示放在这里" } 4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。 5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号 7.需要分页的接口，统一返回以下字段: pageNo,pageSize,total 8.wap页的附加信息（JSON格式），用注释的方式放到html代码里，以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾 9.接口名称以（M）结尾的代表接口经mrobot处理或转发 }}} == 二.接口列表 == == 1 订单管理 == === 1.1订单列表（M） === '''（未完成）'''[[BR]] 需求 {{{ 每个订单新增赔付id字段refundId。 }}} **mrobot接口** > http://mrobot.pconline.com.cn/s/best/buy/orderList.xsp?type=0&pageNo=1&pageSize=10 **后端接口** > http://best.pconline.com.cn/buy/appIntf/order/orderList.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app2.2.0/order#用户订单列表 用户订单列表] **说明** > 请求用户的订单列表 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || pageNo || 第几页 || int || 1 || 是 || || || pageSize || 一页的数据量 || int || 10 || 是 || || || type || 0全部订单；1待付款订单；2待发货订单；3待收货订单；4已完成订单 || int || 0 || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" pageNo: 1, pageSize: 10, total: 20, pageTotal: 2, serviceDate: 111111111111111111 //系统时间毫秒数 data: [ { orderId: 123456, //订单id orderNo: "20151111123321", //订单编号 enName: "ECCO Men's Dress Moccasin Penny Loafer", //商品标题 property: "Size: 42 M EU / 8-8.5 D(M) US|Color: Black", //商品参数 有些商品没有参数 此项为"" imgUrl: "xxx.xxxx...", //商品图片 cnPrice: 123.00, //人民币单价 frPrice: 20.00, //美元单价 itemCnPrice: 123.00 //商品总价 单价*数量 tariffAmountprice: 120.00, //关税 expAmountprice: 123.00, //运费 amountPrice: 100000.00, //订单总价 status: 1, //订单状态 statusDesc: "已取消", //订单状态描述 pastDate: 111111111111111111111, //付款过期时间毫秒数 quantity: 1, //商品数量 mallId: 123, //电商id mallName: "美国亚马逊" //电商名称 refundId: 0 //0未申请赔付 不为0则标示已申请赔付的ID 2.4.0新增 } ] } }}} ---------- === 1.2 订单详情wap页（M） === '''（未完成）'''[[BR]] 需求 {{{ 正文内容增加： 1、增加订单关闭的时间信息； 2、增加关闭订单的原因说明； 3、如果订单申请了赔付，则增加跳转赔付详情入口（操作协议：pcaction://see-compensateDetail?orderId={orderId}&refundId={refundId} ）； }}} **mrobot接口** > http://mrobot.pconline.com.cn/x/best-best/buy/appIntf/order/orderDetail.jsp?orderId=1504 **后端接口** > http://best.pconline.com.cn/buy/appIntf/order/orderDetail.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app2.2.0/order#订单详情 订单详情] **说明** > 订单详情 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单id || int || 0 || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || ||v||版本号||int||0||否||2.2.0版本传v=2.2.0|| **返回格式** > html **返回数据** html页面 ---------- == 2 赔付 == === 2.1赔付列表（M） === '''（未完成）'''[[BR]] 需求：新接口[[BR]] **mrobot接口** > 待补充 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/refundList.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#赔付列表 赔付列表] **说明** > 请求用户的赔付列表 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || pageNo || 第几页 || int || 1 || 是 || || || pageSize || 一页的数据量 || int || 10 || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" pageNo: 1, pageSize: 10, total: 20, pageTotal: 2, serviceDate: 111111111111111111 //系统时间毫秒数 data: [ { orderId: 123456 //订单id refundId: 123456 //赔付id refundNo: 1482817 //赔付编号 status: '1' //赔付状态 imgUrl: "xxx.xxxx...", //商品图片 enName: 'ECCO Men's Dress Moccasin Penny Loafer' //商品标题 property: "Size: 42 M EU / 8-8.5 D(M) US|Color: Black" //商品参数 } ] } }}} ---------- === 2.2 申请赔付 === [[BR]] **需求：**[[BR]] 1、新接口；[[BR]] **mrobot接口** > 无 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/submitRefund.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#提交赔付申请 提交赔付申请] **说明** > 提交赔付申请 **缓存时间** > 无 **提交方式** > POST **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单outerId || int || "" || 是 || || || causeType || 赔付原因 || int || "" || 是 || || || cause || 赔付说明 || string || "" || 是 || || || proofs || 凭证图片，多张图片用","隔开 || string || "" || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" } }}} ---------- === 2.3 取消赔付申请 === [[BR]] **需求：**[[BR]] 1、新接口；[[BR]] **mrobot接口** > 无 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/refundList.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#取消赔付申请 取消赔付申请] **说明** > 取消赔付申请 **缓存时间** > 无 **提交方式** > POST **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单outerId || int || "" || 是 || || || refundId || 赔付申请id || int || "" || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" } }}} ---------- === 2.4 赔付详情（M） === [[BR]] **需求：**[[BR]] 1、新接口；[[BR]] **mrobot接口** > 无 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/getRefund.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#获取赔付详情 获取赔付详情] **说明** > 获取赔付详情 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单outerId || int || "" || 是 || || || refundId || 赔付申请id || int || "" || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || **返回格式** > json **返回数据** {{{#!java { result { status: 1, msg: '请求成功', data: { refundId:123456, //赔付申请id orderId:123456, //订单的id refundNo: "1111111111", //赔付编号 status: "已提交申请，请等待处理", //赔付状态 refund:{ [ refundStatus: 1, //赔付记录状态 aduitcustomer: 'rico', //处理人 processingDate: '2016-01-27 11:23:15'//处理时间 processingReason: 'laalla' //处理说明 causeType: 1, //赔付原因 causeTypeDesc: "商品损坏", //赔付说明（退款说明） proofs: "http://url,http://url", //凭证照片 ] } } } } }}} ----------