BOSS Team / OPEN_API · Commits

Commit 4ad52b6b0c9bbb74c935525442220533f0cbb491

Authored by 翁力
2 parents c2abf1a9 b1c57081

Merge remote-tracking branch 'origin/master'

Inline Side-by-side
Showing 6 changed files with 534 additions and 1 deletions
6. BOSS云/1.1 商品-获取商品列表.md
  View file @4ad52b6
... ... @@ -56,7 +56,7 @@
56 56 <td>plat</td>
57 57 <td>true</td>
58 58 <td>String</td>
59   - <td>平台类型（见通用参数说明)</td>
  59 + <td>平台类型</td>
60 60 </tr>
61 61 <tr>
62 62 <td>sign</td>
... ...
6. BOSS云/1.2 商品-获取商品信息.md
  View file @4ad52b6
  1 +/*
  2 + Title: 1.2 商品-获取商品信息
  3 + Sort: 2
  4 +*/
  5 +#### URL: http://console.open.cnlive.com/open/api/pom/getProduct
  6 +-----
  7 +#### 请求方式: GET
  8 +-----
  9 +#### 返回格式: JSON
  10 +-----
  11 +#### 请求参数说明:
  12 +<table class="table table-bordered table-striped table-condensed">
  13 +<tr>
  14 + <th>参数</th>
  15 + <th>必选</th>
  16 + <th>类型</th>
  17 + <th>说明</th>
  18 +</tr>
  19 +<tr>
  20 + <td>sp_id</td>
  21 + <td>true</td>
  22 + <td>String</td>
  23 + <td>服务提供商ID</td>
  24 +</tr>
  25 +<tr>
  26 + <td>prdId </td>
  27 + <td>true </td>
  28 + <td>String </td>
  29 + <td>商品ID</td>
  30 +</tr>
  31 +<tr>
  32 + <td>plat </td>
  33 + <td>true </td>
  34 + <td>String </td>
  35 + <td>平台类型</td>
  36 +</tr>
  37 +<tr>
  38 + <td>sign</td>
  39 + <td>true</td>
  40 + <td>String</td>
  41 + <td>签名</td>
  42 +</tr>
  43 +</table>
  44 +
  45 +-----
  46 +#### 返回格式说明:
  47 +```
  48 +成功：
  49 +{
  50 + "prdId": "58e40fb1-a258-4590-983f-3534149f769a",
  51 + "title": "LiveShow会员包",
  52 + "descript": "",
  53 + "homePage": "",
  54 + "spId": "003_005",
  55 + "weight": "300",
  56 + "status": "true",
  57 + "currency": "2",
  58 + "vipRmb": "0",
  59 + "rmb": "0",
  60 + "originalRmb": "0",
  61 + "monthPrice1": "1",
  62 + "monthPrice2": "3",
  63 + "monthPrice3": "6",
  64 + "cnCoin": "0",
  65 + "originalCnCoin": "0",
  66 + "discount1": "100",
  67 + "discount2": "100",
  68 + "type": "2",
  69 + "subType": "201",
  70 + "stock": "-1",
  71 + "originalStock": "-1",
  72 + "maxNumOfOrders": "1",
  73 + "orderingGuide": "",
  74 + "activityDesc": "",
  75 + "maxNumOfUse": "0",
  76 + "validPeriod": "",
  77 + "resourceType": "2",
  78 + "resource": "015,016",
  79 + "freeCoupon": "2",
  80 + "effectiveDate": "2015-07-09 17:05:16",
  81 + "expiryDate": "2099-12-31 23:59:59",
  82 + "createTime": "2015-07-09 17:02:31"
  83 +}
  84 +失败：
  85 +{
  86 + "errorCode":"xxxx",
  87 + "errorMessage":"缺少参数|plat参数非法|未发现改记录"
  88 +}
  89 +
  90 +```
  91 +-----
  92 +#### 返回参数说明:
  93 +<table class="table table-bordered table-striped table-condensed">
  94 + <tr>
  95 + <th>参数</th>
  96 + <th>参数说明</th>
  97 + </tr>
  98 + <tr>
  99 + <td>prdId </td>
  100 + <td>商品ID</td>
  101 + </tr>
  102 + <tr>
  103 + <td>title </td>
  104 + <td>商品名</td>
  105 + </tr>
  106 + <tr>
  107 + <td>bigPoster </td>
  108 + <td>商品海报大图</td>
  109 + </tr>
  110 + <tr>
  111 + <td>smallPoster </td>
  112 + <td>商品海报小图</td>
  113 + </tr>
  114 + <tr>
  115 + <td>descript </td>
  116 + <td>商品简介</td>
  117 + </tr>
  118 + <tr>
  119 + <td>homePage </td>
  120 + <td>商家主页</td>
  121 + </tr>
  122 + <tr>
  123 + <td>spId </td>
  124 + <td>服务提供商</td>
  125 + </tr>
  126 + <tr>
  127 + <td>weight </td>
  128 + <td>权重</td>
  129 + </tr>
  130 + <tr>
  131 + <td>status </td>
  132 + <td>商品状态 false 未上线 true已上线</td>
  133 + </tr>
  134 + <tr>
  135 + <td>currency </td>
  136 + <td>支付币种 1中国币 2人民币 3中国币/人民币</td>
  137 + </tr>
  138 + <tr>
  139 + <td>vipRmb </td>
  140 + <td>VIP人民币价格，单位分</td>
  141 + </tr>
  142 + <tr>
  143 + <td>rmb </td>
  144 + <td>人民币价格，单位分</td>
  145 + </tr>
  146 + <tr>
  147 + <td>originalRmb </td>
  148 + <td>人民币原价，单位分</td>
  149 + </tr>
  150 + <tr>
  151 + <td>monthPrice1 </td>
  152 + <td>人民币包月价格，单位分</td>
  153 + </tr>
  154 + <tr>
  155 + <td>monthPrice2 </td>
  156 + <td>人民币包半年价格，单位分</td>
  157 + </tr>
  158 + <tr>
  159 + <td>monthPrice3 </td>
  160 + <td>人民币包年价格，单位分</td>
  161 + </tr>
  162 + <tr>
  163 + <td>cnCoin </td>
  164 + <td>中国币价格</td>
  165 + </tr>
  166 + <tr>
  167 + <td>originalCnCoin </td>
  168 + <td>中国币原价</td>
  169 + </tr>
  170 + <tr>
  171 + <td>discount1 </td>
  172 + <td>折扣1，团购数达到10</td>
  173 + </tr>
  174 + <tr>
  175 + <td>discount2 </td>
  176 + <td>折扣2，团购数达到20</td>
  177 + </tr>
  178 + <tr>
  179 + <td>type </td>
  180 + <td>商品分类 0 虚拟物品 1实物 2视频</td>
  181 + </tr>
  182 + <tr>
  183 + <td>subType </td>
  184 + <td>商品类型 001充值卡 002电子票 200视频</td>
  185 + </tr>
  186 + <tr>
  187 + <td>stock </td>
  188 + <td>库存</td>
  189 + </tr>
  190 + <tr>
  191 + <td>originalStock </td>
  192 + <td>原始库存</td>
  193 + </tr>
  194 + <tr>
  195 + <td>maxNumOfOrders </td>
  196 + <td>订购策略-最大订购数</td>
  197 + </tr>
  198 + <tr>
  199 + <td>orderingGuide </td>
  200 + <td>订购说明</td>
  201 + </tr>
  202 + <tr>
  203 + <td>maxNumOfUse </td>
  204 + <td>使用策略-按次使用</td>
  205 + </tr>
  206 + <tr>
  207 + <td>activityDesc </td>
  208 + <td>活动说明</td>
  209 + </tr>
  210 + <tr>
  211 + <td>resourceType </td>
  212 + <td>商品打包类型 0单项 1普通包 2会员包</td>
  213 + </tr>
  214 + <tr>
  215 + <td>resource </td>
  216 + <td>打包MAM节点 多个节点以英文,号分割</td>
  217 + </tr>
  218 + <tr>
  219 + <td>effectiveDate </td>
  220 + <td>商品生效时间 yyyy-MM-dd HH:mm:ss</td>
  221 + </tr>
  222 + <tr>
  223 + <td>expiryDate </td>
  224 + <td>商品失效时间 yyyy-MM-dd HH:mm:ss</td>
  225 + </tr>
  226 +</table>
0 227 \ No newline at end of file
... ...
6. BOSS云/2.1 订单-获取用户订单列表(商品类型).md deleted 100644 → 0
  View file @c2abf1a
6. BOSS云/2.1 订单-获取用户订单列表.md 0 → 100644
  View file @4ad52b6
  1 +/*
  2 + Title: 2.1 订单-获取用户订单列表
  3 + Sort: 3
  4 +*/
  5 +#### URL: http://console.open.cnlive.com/open/api/pom/getOrders
  6 +-----
  7 +#### 请求方式: POST
  8 +-----
  9 +#### 返回格式: JSON
  10 +-----
  11 +#### 请求参数说明:
  12 +<table class="table table-bordered table-striped table-condensed">
  13 +<tr>
  14 + <th>参数</th>
  15 + <th>必选</th>
  16 + <th>类型</th>
  17 + <th>说明</th>
  18 +</tr>
  19 +<tr>
  20 + <td>sp_id</td>
  21 + <td>true</td>
  22 + <td>String</td>
  23 + <td>服务提供商ID</td>
  24 +</tr>
  25 +<tr>
  26 + <td>sid </td>
  27 + <td>true </td>
  28 + <td>Integer </td>
  29 + <td>用户ID</td>
  30 + </tr>
  31 + <tr>
  32 + <td>friend </td>
  33 + <td>true </td>
  34 + <td>Boolean </td>
  35 + <td>订单类型 true：送朋友(送朋友,土豪撒礼) false:自己用(自己买|被赠)</td>
  36 + </tr>
  37 + <tr>
  38 + <td>page </td>
  39 + <td>true </td>
  40 + <td>Integer </td>
  41 + <td>当前页</td>
  42 + </tr>
  43 + <tr>
  44 + <td>pageSize </td>
  45 + <td>true </td>
  46 + <td>Integer </td>
  47 + <td>每页显示多少条</td>
  48 + </tr>
  49 + <tr>
  50 + <td>ts </td>
  51 + <td>true </td>
  52 + <td>Integer </td>
  53 + <td>时间戳</td>
  54 + </tr>
  55 + <tr>
  56 + <td>plat </td>
  57 + <td>true </td>
  58 + <td>String </td>
  59 + <td>平台类型</td>
  60 + </tr>
  61 +<tr>
  62 + <td>sign</td>
  63 + <td>true</td>
  64 + <td>String</td>
  65 + <td>签名</td>
  66 +</tr>
  67 +</table>
  68 +
  69 +-----
  70 +#### 返回格式说明:
  71 +```
  72 +{
  73 + "previous_cursor": "0",
  74 + "next_cursor": "0",
  75 + "total_number": "1",
  76 + "orders": [
  77 + {
  78 + "id": "4028e46a4a3d5212014a3d52e1fd0001",
  79 + "prdId": "83a9c421-5b6e-4fe1-a77e-6831e5785e63",
  80 + "sid": "145680",
  81 + "uId": "145680",
  82 + "srvOrderId": "003xiaomi14121249691088556",
  83 + "promCode": "",
  84 + "createTime": "2014-12-12 15:07:29",
  85 + "effectiveDate": "2014-12-12 15:07:29",
  86 + "expiryDate": "2015-01-11 15:07:29",
  87 + "status": "1",
  88 + "buyAmount": "1",
  89 + "remainAmount": "0",
  90 + "title": "weng",
  91 + "bigPoster": "http://www.cnlive.com",
  92 + "smallPoster": "http://www.cnlive.com",
  93 + "homePage": "http://www.cnlive.com",
  94 + "currency": "3",
  95 + "rmb": "1",
  96 + "originalRmb": "2",
  97 + "cnCoin": "10",
  98 + "originalCnCoin": "20",
  99 + "type": ""
  100 + },
  101 + {
  102 + "id": "4028e46a4a3d5212014a3d52e1fd0001",
  103 + "prdId": "83a9c421-5b6e-4fe1-a77e-6831e5785e63",
  104 + "sid": "145680",
  105 + "uId": "145680",
  106 + "srvOrderId": "003xiaomi14121249691088556",
  107 + "promCode": "",
  108 + "createTime": "2014-12-12 15:07:29",
  109 + "effectiveDate": "2014-12-12 15:07:29",
  110 + "expiryDate": "2015-01-11 15:07:29",
  111 + "status": "1",
  112 + "buyAmount": "1",
  113 + "remainAmount": "0",
  114 + "title": "weng",
  115 + "bigPoster": "http://www.cnlive.com",
  116 + "smallPoster": "http://www.cnlive.com",
  117 + "homePage": "http://www.cnlive.com",
  118 + "currency": "3",
  119 + "rmb": "1",
  120 + "originalRmb": "2",
  121 + "cnCoin": "10",
  122 + "originalCnCoin": "20",
  123 + "type": ""
  124 + }
  125 + ]
  126 +}
  127 +
  128 +```
  129 +-----
  130 +#### 返回参数说明:
  131 +<table class="table table-bordered table-striped table-condensed">
  132 + <tr>
  133 + <th>参数</th>
  134 + <th>参数说明</th>
  135 + </tr>
  136 + <tr>
  137 + <td>id </td>
  138 + <td>订单ID(送朋友 无此属性)</td>
  139 + </tr>
  140 + <tr>
  141 + <td>prdId </td>
  142 + <td>商品ID</td>
  143 + </tr>
  144 + <tr>
  145 + <td>sid </td>
  146 + <td>用户ID(送朋友 无此属性)</td>
  147 + </tr>
  148 + <tr>
  149 + <td>uId </td>
  150 + <td>支付用户ID</td>
  151 + </tr>
  152 + <tr>
  153 + <td>srvOrderId </td>
  154 + <td>订单号</td>
  155 + </tr>
  156 + <tr>
  157 + <td>promCode </td>
  158 + <td>兑换码(送朋友和为自己用 无此属性)</td>
  159 + </tr>
  160 + <tr>
  161 + <td>effectiveDate </td>
  162 + <td>生效时间</td>
  163 + </tr>
  164 + <tr>
  165 + <td>expiryDate </td>
  166 + <td>失效时间</td>
  167 + </tr>
  168 + <tr>
  169 + <td>createTime </td>
  170 + <td>订购时间</td>
  171 + </tr>
  172 + <tr>
  173 + <td>buyAmount </td>
  174 + <td>购买数量</td>
  175 + </tr>
  176 + <tr>
  177 + <td>remainAmount </td>
  178 + <td>剩余数量</td>
  179 + </tr>
  180 + <tr>
  181 + <td>title </td>
  182 + <td>商品名</td>
  183 + </tr>
  184 + <tr>
  185 + <td>bigPoster </td>
  186 + <td>大海报</td>
  187 + </tr>
  188 + <tr>
  189 + <td>bigPoster </td>
  190 + <td>大海报</td>
  191 + </tr>
  192 + <tr>
  193 + <td>smallPoster </td>
  194 + <td>小海报</td>
  195 + </tr>
  196 + <tr>
  197 + <td>homePage </td>
  198 + <td>商品主页</td>
  199 + </tr>
  200 + <tr>
  201 + <td>status </td>
  202 + <td>订单状态 0有效 1失效</td>
  203 + </tr>
  204 + <tr>
  205 + <td>type </td>
  206 + <td>订单类型（仅送朋友有此属性：0送指定朋友 1土豪撒礼）</td>
  207 + </tr>
  208 + <tr>
  209 + <td>previous_cursor </td>
  210 + <td>前一页</td>
  211 + </tr>
  212 + <tr>
  213 + <td>next_cursor </td>
  214 + <td>后一页</td>
  215 + </tr>
  216 + <tr>
  217 + <td>total_number </td>
  218 + <td>总页数 </td>
  219 + </tr>
  220 +</table>
0 221 \ No newline at end of file
... ...
6. BOSS云/2.2 订单-读取用户订单列表(简).md 0 → 100644
  View file @4ad52b6
  1 +/*
  2 + Title: 2.2 订单-读取用户订单列表(简)
  3 + Sort: 4
  4 +*/
  5 +#### URL: http://console.open.cnlive.com/open/api/pom/getOrderByType
  6 +-----
  7 +#### 请求方式: POST
  8 +-----
  9 +#### 返回格式: JSON
  10 +-----
  11 +#### 请求参数说明:
  12 +<table class="table table-bordered table-striped table-condensed">
  13 +<tr>
  14 + <th>参数</th>
  15 + <th>必选</th>
  16 + <th>类型</th>
  17 + <th>说明</th>
  18 +</tr>
  19 +<tr>
  20 + <td>sp_id</td>
  21 + <td>true</td>
  22 + <td>String</td>
  23 + <td>服务提供商ID</td>
  24 +</tr>
  25 +<tr>
  26 + <td>sid </td>
  27 + <td>true </td>
  28 + <td>Integer </td>
  29 + <td>用户ID</td>
  30 + </tr>
  31 + <tr>
  32 + <td>type</td>
  33 + <td>true </td>
  34 + <td>Integer </td>
  35 + <td>订单类型（0-自己买，1-免费券，2-土豪抢码，3-兑码）</td>
  36 + </tr>
  37 + <tr>
  38 + <td>page </td>
  39 + <td>true </td>
  40 + <td>Integer </td>
  41 + <td>当前页</td>
  42 + </tr>
  43 + <tr>
  44 + <td>pageSize </td>
  45 + <td>true </td>
  46 + <td>Integer </td>
  47 + <td>每页显示多少条</td>
  48 + </tr>
  49 + <tr>
  50 + <td>plat </td>
  51 + <td>true </td>
  52 + <td>String </td>
  53 + <td>平台类型</td>
  54 + </tr>
  55 + <tr>
  56 + <td>sign</td>
  57 + <td>true</td>
  58 + <td>String</td>
  59 + <td>签名</td>
  60 + </tr>
  61 +</table>
  62 +
  63 +-----
  64 +#### 返回格式说明:
  65 +```
  66 +成功：
  67 +{
  68 + "errorCode": "0",
  69 + "result": {
  70 + "orders": [
  71 + {
  72 + "title": "付费节目",
  73 + "createTime": "2015-01-16 14:42:32"
  74 + }
  75 + ],
  76 + "previous_cursor": "0",
  77 + "next_cursor": "0",
  78 + "total_number": "1"
  79 + }
  80 +}
  81 +失败：
  82 +{
  83 + "errorCode":"xxxx",
  84 + "errorMessage":"缺少参数|plat参数非法|参数格式错误|未登录|您已订购或达到订购限制|订单创建成功|订单创建失败"
  85 +}
  86 +
  87 +```
0 88 \ No newline at end of file
... ...
6. BOSS云/2.2 订单-读取用户订单列表(订单类型).md deleted 100644 → 0
  View file @c2abf1a