购物流程接口需求描述.doc

购物流程接口需求描述目录1 提交订单12 取消订单23 删除订单34 查询订单详情（根据订单id）45 获得用户的订单信息。66 根据订单id查询物流。77 商品加入购物车。88 获得购物车条目列表（根据用户id）。99 删除购物车中的条目（根据cartid）。1010 修改购物车中某条目的数量。1111 购物车结算。1212 获取用户收货地址列表。1413 收货地址增删改查。1414设置默认收货地址。1415获取用户浏览商品的历史记录列表。1416获取推荐应用列表。1417意见反馈。1418版本更新。151 提交订单a、HTTP请求方式POSTb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称productidtruestring商品idproductnumtruestring商品数量attressidtruestring收货地址idmessagetruestring客户留言attribute1truestring商品可选参数1attribute2truestring商品可选参数2attribute3truestring商品可选参数3f、说明提交一个订单g、返回结果及数据字段说明 ret:0, msg:ok, data: orderid:1, ret:1, msg:商品参数错误，没有这个参数选项。 ret:1, msg:商品参数错误,没有这个参数值。2 取消订单a、HTTP请求方式POSTb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称orderidtruestring订单idf、说明取消掉没有完成（及没有确定收货）订单。g、返回结果及数据字段说明 ret:0, msg:ok, data: orderid :1,3 删除订单a、HTTP请求方式POSTb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称orderidtruestring订单idf、说明删除掉已经完成的订单(即已经付过款的商品)。g、返回结果及数据字段说明 ret:0, msg:ok, data: orderid :1,4 查询订单详情（根据订单id）a、HTTP请求方式GETb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称orderidtruestring商品idf、说明根据订单的id查询订单的详细信息。返回数据包括订单id、是否付过款、数量、可选属性的数组以及商品的详细信息。g、返回结果及数据字段说明 ret:0, msg:ok, data: orderid :1, productnum :1, ispaid :false, attributes : attributeid: 1, attributename: 颜色, attributevalueid: 5, attributevaluename: 白色 , attributeid: 10, attributename: 尺码, attributevalueid: 45, attributevaluename: 32码 productinfo: PID: 8001,Pname: 2014夏季新款韩版时尚潮款修身显瘦低腰卷边刺绣休闲牛仔裤女铅笔裤,belongsname: 范冰冰的星店,belongsid: 123 Pparameter: 工艺：刺绣$产地：中国大陆, categoryid: 3, categName: 牛仔裤 , itemcode: 2001,itemName: 韩版时尚潮款修身显瘦低腰卷边刺绣休闲牛仔裤女铅笔裤 白色, itemBarCode: 暂无商品条码, IsHave: 1, markprice: 150.00, saleprice: 100.00, unit: 件, weight: 0.5, integral: 100, Pics: , attrival: attributeid: 1, attributename: 颜色, attributevalueid: 5, attributevaluename: 白色 , attributeid: 10, attributename: 尺码, attributevalueid: 45, attributevaluename: 32码 5 获得用户的订单信息。a、HTTP请求方式GETb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称uidtruestring用户idtimefalsestring三月前 或 三月后f、说明三月前 三月后 为“我的订单” 模块提供内容。g、返回结果及数据字段说明 ret:0, msg:ok, data: orderid :1, productnum :1, ispaid :true, name :小猪罗志祥棒球帽,ordertime :2014-01-14 17:15:38, money :499, ispaid :true, orderid :1, productnum :1, ispaid :false, name :小猪罗志祥棒球帽,ordertime :2014-01-14 17:15:38, money :499, ispaid :true, ret:100, msg:用户未登录。6 根据订单id查询物流。a、HTTP请求方式GETb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称pidtruestring订单idf、说明g、返回结果及数据字段说明 ret:0, msg:ok, data: orderid :1, productnum :1, name :小猪罗志祥棒球帽,ordertime :2014-01-14 17:15:38, money :499, transportationcompany:顺丰, transportationid:1, time :2014-05-09 17:15:38, action:完成配送, time :2014-05-09 17:15:38, action:路上, time :2014-05-09 17:15:38, action:物流接收包裹, ret:100, msg:用户未登录。 ret:1001, msg:该商品没有付款。7 商品加入购物车。a、HTTP请求方式POSTb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称pidtruestring商品idf、说明g、返回结果及数据字段说明 ret:0, msg:ok, data: cartid :1, ret:100, msg:用户未登录。8 获得购物车条目列表（根据用户id）。a、HTTP请求方式GETb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称pidtruestring商品idf、说明g、返回结果及数据字段说明 ret:0, msg:ok, data: cartid :1, money :120, pid :22 cartid :1, money :120, pid :2 cartid :1, money :120, pid :12 ret:100, msg:用户未登录。9 删除购物车中的条目（根据cartid）。a、HTTP请求方式POSTb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称cartidtruestring订单idf、说明删除购物车中的某个条目。g、返回结果及数据字段说明 ret:0, msg:ok,data:cartid:1 ret:100, msg:用户未登录。10 修改购物车中某条目的数量。a、HTTP请求方式POSTb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称cartidtruestring条目idactiontruestring加一 或 减一numfalsestring直接置为相应的数量f、说明该接口需要支持根据购物车的某条目的id来修改相应商品的件数，需要提供加一 减一 以及 直接置为相应数值的功能。g、返回结果及数据字段说明 ret:0, msg:ok, data:cartid :1,numnow:2, ret:100, msg:用户未登录。11 购物车结算。a、HTTP请求方式POSTb、是否需要登录turec、支持格式JSONe、请求参数参数名称是否必须类型描述modtruestring模块名称codetruestring方法名称uidtruestring用户idf、说明对用户购物车中的项目进行结算。g、返回结果及数据字段说明 ret:0, msg:ok, data: total:1000, defaultaddress:上海某地, productlist:id:1000,amout:2,name:某某,id:1200,amout:1,name:某某, ret:100, msg:用户未登录。NOTE：以下接口不再敷述，只做说明。12 获取用户收货地址列表。说明获得用户收货地址的列表。13 收货地址增删改查。说明对用户的收货地址进行维护，需要增删改查。14设置默认收货地址。说明设置用户的默认收货地址。15获取用户浏览商品的历史记录列表。说明获取用户浏览过的商品的历史记录16获取推荐应用列表。说明获取应用推荐列表。17意见反馈。说明意见反馈功能。18版本更新。说明获得版本信息。