platform / yohobuy-doc · Commits

Go to a project

Authored by tanling
Commit 60b9d3ab409601a58e9efe7f19f7e55bd841c88d 1 parent 1a5905bd

temp commit

Inline Side-by-side
Showing 1 changed file with 522 additions and 0 deletions
  1 +# 销售类目接口服务定义
  2 +---------------------
  3 +
  4 +# 全件检索销售类目列表
  5 +
  6 +> 接口名： `/salesCategory/queryAllSalesCategoryList`
  7 +
  8 +### 入参
  9 +
  10 +-------------------------
  11 +|属性名称|类型|例子|说明|是否必填|
  12 +|-------|----|----|----|-------|
  13 +--------------------------------
  14 +
  15 +### 返回
  16 +
  17 +``` json
  18 +{
  19 + "code": 200,
  20 + "message": "queryAllSalesCategoryList success",
  21 + "data": [{
  22 + "createTime": 1441117726,
  23 + "icon": "",
  24 + "categoryId": 1,
  25 + "relationParameter": "114,293,116,117,115,119,124,122,131,129,346,133,348,147,149,148,151,231,152,153,196,238,239,240,349,157,342,156,161,300,160,233,341,340,210,339,351,186,235,163,224,322,323,324,325,326,327,328,329,330,331,72,74,75,76,142,77,78,79,80,199,213,217,218,234,303,305,306,307,334,162,316,164,317,295,321,311,357,359,320,195,197,413,130,258,173,227,125,118,121,123,263,260,264,261,352",
  26 + "orderBy": 0,
  27 + "parentId": 0,
  28 + "categoryCode": "1,0,0,0",
  29 + "relationUrl": "",
  30 + "levelNumber": 1,
  31 + "categoryName": "男生",
  32 + "status": 1,
  33 + "items": [{
  34 + "createTime": 1441117792,
  35 + "icon": "http://img11.static.yhbimg.com/taobaocms/2015/09/01/14/01d48022e08742f1c96766caa6484593ce.jpg?imageView/{mode}/w/{width}/h/{height}",
  36 + "categoryId": 5,
  37 + "relationParameter": "114,293,116,117,115,119,124,122,413,258,173,227,125,118,121,123",
  38 + "orderBy": 10,
  39 + "parentId": 1,
  40 + "categoryCode": "1,5,0,0",
  41 + "relationUrl": "",
  42 + "levelNumber": 2,
  43 + "categoryName": "上衣",
  44 + "status": 1,
  45 + "items": [{
  46 + "relationUrl": "",
  47 + "createTime": 0,
  48 + "icon": 3,
  49 + "categoryId": 45,
  50 + "relationParameter": "114,293",
  51 + "orderBy": 5,
  52 + "parentId": 5,
  53 + "categoryCode": "1,5,45,0",
  54 + "levelNumber": 3,
  55 + "categoryName": "T恤",
  56 + "status": 1
  57 + }]
  58 + }, {
  59 + "relationUrl": "",
  60 + "createTime": 1441117934,
  61 + "icon": "http://img11.static.yhbimg.com/taobaocms/2015/09/01/14/019b1a20d4cf319e0e8035cacf2d1d231f.jpg?imageView/{mode}/w/{width}/h/{height}",
  62 + "categoryId": 8,
  63 + "relationParameter": "131,129,346,133,348,130,114,293",
  64 + "orderBy": 9,
  65 + "parentId": 1,
  66 + "categoryCode": "1,8,0,0",
  67 + "levelNumber": 2,
  68 + "categoryName": "裤装",
  69 + "status": 1,
  70 + "items": [{
  71 + "relationUrl": "UP",
  72 + "createTime": 1441118557,
  73 + "icon": 3,
  74 + "categoryId": 86,
  75 + "relationParameter": "131",
  76 + "orderBy": 3,
  77 + "parentId": 8,
  78 + "categoryCode": "1,8,86,0",
  79 + "levelNumber": 3,
  80 + "categoryName": "短裤",
  81 + "status": 1
  82 + }]
  83 + }, {
  84 + "createTime": 0,
  85 + "icon": 3,
  86 + "categoryId": 11,
  87 + "relationParameter": "147,149,148,151,231",
  88 + "orderBy": 8,
  89 + "parentId": 1,
  90 + "categoryCode": "1,11,0,0",
  91 + "relationUrl": "22",
  92 + "levelNumber": 2,
  93 + "categoryName": "鞋靴",
  94 + "status": 1,
  95 + "items": [{
  96 + "relationUrl": "UP",
  97 + "createTime": 0,
  98 + "icon": "",
  99 + "categoryId": 107,
  100 + "relationParameter": "147",
  101 + "orderBy": 0,
  102 + "parentId": 11,
  103 + "categoryCode": "1,11,107,0",
  104 + "levelNumber": 3,
  105 + "categoryName": "休闲/运动鞋",
  106 + "status": 1
  107 + }, {
  108 + "relationUrl": "UP",
  109 + "createTime": 0,
  110 + "icon": "",
  111 + "categoryId": 113,
  112 + "relationParameter": "149",
  113 + "orderBy": 0,
  114 + "parentId": 11,
  115 + "categoryCode": "1,11,113,0",
  116 + "levelNumber": 3,
  117 + "categoryName": "凉鞋/凉拖",
  118 + "status": 0
  119 + }]
  120 + }, {
  121 + "relationUrl": "",
  122 + "createTime": 0,
  123 + "icon": "",
  124 + "categoryId": 14,
  125 + "relationParameter": "152,153,196,238,239,240,349,157,342,156,161,300,160,233,341,340,210,339,351,195,197",
  126 + "orderBy": 11,
  127 + "parentId": 1,
  128 + "categoryCode": "1,17,0,0",
  129 + "levelNumber": 2,
  130 + "categoryName": "包类",
  131 + "status": 0,
  132 + "items": [{
  133 + "relationUrl": "UP",
  134 + "createTime": 0,
  135 + "icon": 3,
  136 + "categoryId": 147,
  137 + "relationParameter": "238,239,240,349",
  138 + "orderBy": 12,
  139 + "parentId": 14,
  140 + "categoryCode": "1,14,147,0",
  141 + "levelNumber": 3,
  142 + "categoryName": "钱包/卡包/手包/钥匙包",
  143 + "status": 1
  144 + }]
  145 + }, {
  146 + "createTime": 0,
  147 + "icon": 3,
  148 + "categoryId": 17,
  149 + "relationParameter": "186,235,163,224,322,323,324,325,326,327,328,329,330,331,72,74,75,76,142,77,78,79,80,199,213,217,218,234,303,305,306,307,334,162,316,320,164,317,295,321",
  150 + "orderBy": 0,
  151 + "parentId": 1,
  152 + "categoryCode": "1,17,0,0",
  153 + "relationUrl": "SJ",
  154 + "levelNumber": 2,
  155 + "categoryName": "服配",
  156 + "status": 0,
  157 + "items": [{
  158 + "relationUrl": "",
  159 + "createTime": 0,
  160 + "icon": "",
  161 + "categoryId": 177,
  162 + "relationParameter": "186,235",
  163 + "orderBy": 0,
  164 + "parentId": 17,
  165 + "categoryCode": "1,17,177,0",
  166 + "levelNumber": 3,
  167 + "categoryName": "太阳镜/眼镜",
  168 + "status": 1
  169 + }, {
  170 + "relationUrl": "UP",
  171 + "createTime": 0,
  172 + "icon": 3,
  173 + "categoryId": 246,
  174 + "relationParameter": "163,224,322,323,324,325,326,327,328,329,330,331",
  175 + "orderBy": 0,
  176 + "parentId": 17,
  177 + "categoryCode": "1,17,178,0",
  178 + "levelNumber": 3,
  179 + "categoryName": "帽子",
  180 + "status": 1
  181 + }]
  182 + }]
  183 + }, {
  184 + "createTime": 1460079347,
  185 + "icon": 3,
  186 + "categoryId": 2,
  187 + "relationParameter": "227,173,125,258,121,123,119,124,118,348,122,115,117,346,114,293,131,133,186,235,163,224,322,323,324,325,326,327,328,329,330,331,72,74,75,76,142,77,78,79,80,199,213,217,218,234,303,305,306,307,334,162,316,320,164,317,295,321,147,149,148,151,231,311,364,357,359,116,129,134,135,413,152,153,238,239,240,349,157,342,156,161,300,160,233,341,340,210,339,351,195,196,197,263",
  188 + "orderBy": 1,
  189 + "parentId": 0,
  190 + "categoryCode": "2,0,0,0",
  191 + "relationUrl": "11",
  192 + "levelNumber": 1,
  193 + "categoryName": "女生",
  194 + "status": 1,
  195 + "items": [{
  196 + "createTime": 1460079406,
  197 + "icon": 3,
  198 + "categoryId": 31,
  199 + "relationParameter": "134,135",
  200 + "orderBy": 111,
  201 + "parentId": 2,
  202 + "categoryCode": "2,31,0,0",
  203 + "relationUrl": "11",
  204 + "levelNumber": 2,
  205 + "categoryName": "裙装",
  206 + "status": 1
  207 + }]
  208 + }]
  209 +}
  210 +
  211 +```
  212 +
  213 +# 根据状态获取销售类目接口
  214 +
  215 +> 接口名： `/salesCategory/querySalesCategoryListByStatus`
  216 +
  217 +### 入参
  218 +
  219 +-------------------------
  220 +|属性名称|类型|例子|说明|是否必填|
  221 +|-------|----|----|----|-------|
  222 +|state|int|5|状态|是|
  223 +--------------------------------
  224 +
  225 +### 返回
  226 +
  227 +``` json
  228 +{
  229 + "code": 200,
  230 + "message": "querySalesCategoryListByStatus success",
  231 + "data": [{
  232 + "createTime": 1441117726,
  233 + "icon": "",
  234 + "categoryId": 1,
  235 + "relationParameter": "114,293,116,117,115,119,124,122,131,129,346,133,348,147,149,148,151,231,152,153,196,238,239,240,349,157,342,156,161,300,160,233,341,340,210,339,351,186,235,163,224,322,323,324,325,326,327,328,329,330,331,72,74,75,76,142,77,78,79,80,199,213,217,218,234,303,305,306,307,334,162,316,164,317,295,321,311,357,359,320,195,197,413,130,258,173,227,125,118,121,123,263,260,264,261,352",
  236 + "orderBy": 0,
  237 + "parentId": 0,
  238 + "categoryCode": "1,0,0,0",
  239 + "relationUrl": "",
  240 + "levelNumber": 1,
  241 + "categoryName": "男生",
  242 + "status": 1,
  243 + "items": [{
  244 + "createTime": 1441117792,
  245 + "icon": "http://img11.static.yhbimg.com/taobaocms/2015/09/01/14/01d48022e08742f1c96766caa6484593ce.jpg?imageView/{mode}/w/{width}/h/{height}",
  246 + "categoryId": 5,
  247 + "relationParameter": "114,293,116,117,115,119,124,122,413,258,173,227,125,118,121,123",
  248 + "orderBy": 10,
  249 + "parentId": 1,
  250 + "categoryCode": "1,5,0,0",
  251 + "relationUrl": "",
  252 + "levelNumber": 2,
  253 + "categoryName": "上衣",
  254 + "status": 1,
  255 + "items": [{
  256 + "relationUrl": "",
  257 + "createTime": 0,
  258 + "icon": 3,
  259 + "categoryId": 45,
  260 + "relationParameter": "114,293",
  261 + "orderBy": 5,
  262 + "parentId": 5,
  263 + "categoryCode": "1,5,45,0",
  264 + "levelNumber": 3,
  265 + "categoryName": "T恤",
  266 + "status": 1
  267 + }]
  268 + }, {
  269 + "relationUrl": "",
  270 + "createTime": 1441117934,
  271 + "icon": "http://img11.static.yhbimg.com/taobaocms/2015/09/01/14/019b1a20d4cf319e0e8035cacf2d1d231f.jpg?imageView/{mode}/w/{width}/h/{height}",
  272 + "categoryId": 8,
  273 + "relationParameter": "131,129,346,133,348,130,114,293",
  274 + "orderBy": 9,
  275 + "parentId": 1,
  276 + "categoryCode": "1,8,0,0",
  277 + "levelNumber": 2,
  278 + "categoryName": "裤装",
  279 + "status": 1,
  280 + "items": [{
  281 + "relationUrl": "UP",
  282 + "createTime": 1441118557,
  283 + "icon": 3,
  284 + "categoryId": 86,
  285 + "relationParameter": "131",
  286 + "orderBy": 3,
  287 + "parentId": 8,
  288 + "categoryCode": "1,8,86,0",
  289 + "levelNumber": 3,
  290 + "categoryName": "短裤",
  291 + "status": 1
  292 + }]
  293 + }, {
  294 + "createTime": 0,
  295 + "icon": 3,
  296 + "categoryId": 11,
  297 + "relationParameter": "147,149,148,151,231",
  298 + "orderBy": 8,
  299 + "parentId": 1,
  300 + "categoryCode": "1,11,0,0",
  301 + "relationUrl": "22",
  302 + "levelNumber": 2,
  303 + "categoryName": "鞋靴",
  304 + "status": 1,
  305 + "items": [{
  306 + "relationUrl": "UP",
  307 + "createTime": 0,
  308 + "icon": "",
  309 + "categoryId": 107,
  310 + "relationParameter": "147",
  311 + "orderBy": 0,
  312 + "parentId": 11,
  313 + "categoryCode": "1,11,107,0",
  314 + "levelNumber": 3,
  315 + "categoryName": "休闲/运动鞋",
  316 + "status": 1
  317 + }, {
  318 + "relationUrl": "UP",
  319 + "createTime": 0,
  320 + "icon": "",
  321 + "categoryId": 113,
  322 + "relationParameter": "149",
  323 + "orderBy": 0,
  324 + "parentId": 11,
  325 + "categoryCode": "1,11,113,0",
  326 + "levelNumber": 3,
  327 + "categoryName": "凉鞋/凉拖",
  328 + "status": 0
  329 + }]
  330 + }, {
  331 + "relationUrl": "",
  332 + "createTime": 0,
  333 + "icon": "",
  334 + "categoryId": 14,
  335 + "relationParameter": "152,153,196,238,239,240,349,157,342,156,161,300,160,233,341,340,210,339,351,195,197",
  336 + "orderBy": 11,
  337 + "parentId": 1,
  338 + "categoryCode": "1,17,0,0",
  339 + "levelNumber": 2,
  340 + "categoryName": "包类",
  341 + "status": 0,
  342 + "items": [{
  343 + "relationUrl": "UP",
  344 + "createTime": 0,
  345 + "icon": 3,
  346 + "categoryId": 147,
  347 + "relationParameter": "238,239,240,349",
  348 + "orderBy": 12,
  349 + "parentId": 14,
  350 + "categoryCode": "1,14,147,0",
  351 + "levelNumber": 3,
  352 + "categoryName": "钱包/卡包/手包/钥匙包",
  353 + "status": 1
  354 + }]
  355 + }, {
  356 + "createTime": 0,
  357 + "icon": 3,
  358 + "categoryId": 17,
  359 + "relationParameter": "186,235,163,224,322,323,324,325,326,327,328,329,330,331,72,74,75,76,142,77,78,79,80,199,213,217,218,234,303,305,306,307,334,162,316,320,164,317,295,321",
  360 + "orderBy": 0,
  361 + "parentId": 1,
  362 + "categoryCode": "1,17,0,0",
  363 + "relationUrl": "SJ",
  364 + "levelNumber": 2,
  365 + "categoryName": "服配",
  366 + "status": 0,
  367 + "items": [{
  368 + "relationUrl": "",
  369 + "createTime": 0,
  370 + "icon": "",
  371 + "categoryId": 177,
  372 + "relationParameter": "186,235",
  373 + "orderBy": 0,
  374 + "parentId": 17,
  375 + "categoryCode": "1,17,177,0",
  376 + "levelNumber": 3,
  377 + "categoryName": "太阳镜/眼镜",
  378 + "status": 1
  379 + }, {
  380 + "relationUrl": "UP",
  381 + "createTime": 0,
  382 + "icon": 3,
  383 + "categoryId": 246,
  384 + "relationParameter": "163,224,322,323,324,325,326,327,328,329,330,331",
  385 + "orderBy": 0,
  386 + "parentId": 17,
  387 + "categoryCode": "1,17,178,0",
  388 + "levelNumber": 3,
  389 + "categoryName": "帽子",
  390 + "status": 1
  391 + }]
  392 + }]
  393 + }, {
  394 + "createTime": 1460079347,
  395 + "icon": 3,
  396 + "categoryId": 2,
  397 + "relationParameter": "227,173,125,258,121,123,119,124,118,348,122,115,117,346,114,293,131,133,186,235,163,224,322,323,324,325,326,327,328,329,330,331,72,74,75,76,142,77,78,79,80,199,213,217,218,234,303,305,306,307,334,162,316,320,164,317,295,321,147,149,148,151,231,311,364,357,359,116,129,134,135,413,152,153,238,239,240,349,157,342,156,161,300,160,233,341,340,210,339,351,195,196,197,263",
  398 + "orderBy": 1,
  399 + "parentId": 0,
  400 + "categoryCode": "2,0,0,0",
  401 + "relationUrl": "11",
  402 + "levelNumber": 1,
  403 + "categoryName": "女生",
  404 + "status": 1,
  405 + "items": [{
  406 + "createTime": 1460079406,
  407 + "icon": 3,
  408 + "categoryId": 31,
  409 + "relationParameter": "134,135",
  410 + "orderBy": 111,
  411 + "parentId": 2,
  412 + "categoryCode": "2,31,0,0",
  413 + "relationUrl": "11",
  414 + "levelNumber": 2,
  415 + "categoryName": "裙装",
  416 + "status": 1
  417 + }]
  418 + }]
  419 +}
  420 +
  421 +```
  422 +
  423 +# 根据销售类目的id查询销售类目接口
  424 +
  425 +> 接口名： `/salesCategory/querySalesCategoryById`
  426 +
  427 +### 入参
  428 +
  429 +-------------------------
  430 +|属性名称|类型|例子|说明|是否必填|
  431 +|-------|----|----|----|-------|
  432 +|categoryId|int|11|销售类目id|是|
  433 +--------------------------------
  434 +
  435 +### 返回
  436 +
  437 +``` json
  438 +
  439 +
  440 +```
  441 +
  442 +
  443 +# 添加销售类目接口
  444 +
  445 +> 接口名： `/salesCategory/addSalesCategory`
  446 +
  447 +### 入参
  448 +
  449 +-------------------------
  450 +|属性名称|类型|例子|说明|是否必填|
  451 +|--------|----|----|----|--------|
  452 +|categoryName|String|创意家居|销售类目名称|是|
  453 +|relationParameter|String|285,113|关联的物理类目id|否|
  454 +|relationUrl|string||关联url|否|
  455 +|parentId|int|1|父销售类目id|否|
  456 +|orderBy|int|0|排序|否|
  457 +|icon|string||销售类目图标|否|
  458 +|categoryCode|String|4,0,0,0|一级目录到当前的目录,不足4位末尾补齐|否|
  459 +|status|int|0|销售类目状态1：开启 1：关闭 |否
  460 +|levelNumber|int|1|销售类目等级|否
  461 +|batchNo|string|201602021023|批次号|是
  462 +|auditTime|string|2016-01-30 15:00:00|审核时间|否
  463 +---------------------
  464 +
  465 +### 返回
  466 +
  467 +``` json
  468 +{
  469 + "code": 200,
  470 + "data": [],
  471 + "md5": "d751713988987e9331980363e24189ce",
  472 + "message": "addLimitCode success."
  473 +}
  474 +
  475 +```
  476 +
  477 +
  478 +
  479 +
  480 +
  481 +# 更新限购码接口
  482 +
  483 +> 接口名： `/limitCode/updateLimitCode`
  484 +
  485 +### 入参
  486 +
  487 +-------------------------
  488 +|属性名称|类型|例子|说明|是否必填|
  489 +|--------|----|----|----|--------|
  490 +|id|int|6|限购码ID|是|
  491 +|name|string|潮流尖货限购码|限购码名称|是|
  492 +|limitTimes|int|100|数量|是|
  493 +|reqDepartment|string|运营部|申请部门|否|
  494 +|limitDateFrom|string|2016-02-01 14:00:00|起始时间|是|
  495 +|limitDateTo|string|2016-02-20 14:00:00|失效时间|是|
  496 +|describe|string|耐克新款|限购码描述|否|
  497 +|userUseLimit|int|1|用户使用次数|否|
  498 +|userTypeLimit|int|1|用户类型|否
  499 +|limitSkn|string|50012345|限购商品skn|否
  500 +|creatorName|string|张三|创建者名称|否
  501 +|creatorId|int|12401|创建者ID|否
  502 +|createTime|string|2016-01-29 15:00:00|创建时间|否
  503 +|status|int|0|限购码状态0：待审核 1：审核通过 2：驳回 3：过期 4:作废|否
  504 +|reason|string|预算不够|驳回原因|否
  505 +|batchNo|string|201602021023|批次号|是
  506 +|auditTime|string|2016-01-30 15:00:00|审核时间|否
  507 +---------------------
  508 +
  509 +### 返回
  510 +
  511 +``` json
  512 +{
  513 + "code": 500,
  514 + "data": [],
  515 + "md5": "d751713988987e9331980363e24189ce",
  516 + "message": "updateLimitCode success."
  517 +}
  518 +
  519 +```
  520 +
  521 +
  522 +