Merge branch 'master' of http://git.dev.yoho.cn/yoho-documents/api-interfaces

LUOXC
Commit ba24802cc2b311c146083ee8133c51f23a51700a 2 parents dd06b9ff 6b3711e9
Showing 2 changed files with 353 additions and 10 deletions
个人中心/PC.md
订单/订单前后台分离.md
--- a/个人中心/PC.md
View file @ba24802
+++ b/个人中心/PC.md
View file @ba24802
@@ -1034,3 +1034,228 @@ code为200即为成功，否则是失败。
   "message": "请求成功"
 }
 ```
+## 30、添加商家入驻申请记录 ##
+
+添加商家入驻申请记录（?method=app.shops.insertApply）
+#### 请求参数
+| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 |  
+|:-------| -----:|-----:|-----:|-----:|----:|  
+|brandName|String|是|卫龙|||  
+|registerStatus|String|是|已申请|||  
+|sellerName|String|是|卫龙辣条|||  
+|sellerAddress|String|是|中国山西|||  
+|zipCode|String|是|350000|||  
+|contacts|String|是|梁走召|||  
+|contactPhone|String|是|13000000000|||  
+|contactEmail|String|是|sss@dd.com|||  
+|onlineShopWebsite|String|是|1|||  
+|categoryInfo|String|是||||  
+|storeInfo|String|是||||  
+|sellerRole|String|是|品牌商|||  
+|brandWebsite|String|是|1|||  
+|billingCycle|String|是|月结|||  
+|warehouseAddress|String|是|11|||  
+|producer|String|是|111|||  
+|invoiceType|String|是|17%的增值税发票|||  
+|newCycle|String|是|每周|||  
+|quarterNum|int|是|1|||  
+|supplyCycle|String|是|每周|||  
+|haveStore|String|是|0|||  
+|brandMaterial|String|是|/2015/04/12/18/0179f42b2a0d47.ppt|||  
+|goodsMaterial|String|是|/2015/04/12/18/7b26b4ed2f8b391a55.xlsx|||  
+|uid|int|是|4865015|||  
+
+
+注意，通用的头部没有列出。  
+请求示例  
+http://192.168.102.205:8080/geteway/?method=app.shops.insertApply&brandName=卫龙best8888&registerStatus=已申请&sellerName=卫龙辣条&sellerAddress=中国山西&zipCode=350000&contacts=梁走召ss&contactPhone=1300000000013000000000130000000001300000000013000000000130000000001300000000013000000000&contactEmail=ssssssssww@dd.com&onlineShopWebsite=1&categoryInfo={\"0\":{\"category_one\":\"6\",\"category_two\":\"46\",\"category_price\":\"700-800\"},\"2\":{\"category_one\":\"3\",\"category_two\":\"28\",\"category_price\":\"1000-1500\"}}&storeInfo=[{\"store_address\":\"山东青岛市台东利群3楼linkcode男装专柜\",\"store_sales_volume\":\"100000\"}]&sellerRole=品牌商&brandWebsite=1&billingCycle=月结&warehouseAddress=11&producer=111&invoiceType=17%25的增值税发票&newCycle=每周&quarterNum=1&supplyCycle=每周&haveStore=0&brandMaterial=/2015/04/12/18/0174889f4ee3a51593f84f19f42b2a0d47.ppt&goodsMaterial=/2015/04/12/18/01b6ed2362f985b07b26b4ed2f8b391a55.xlsx&uid=4865015
+
+### 响应
+code为200即为成功，否则是失败。 
+响应参数，data部分  
+响应成功JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": [],
+  "md5": "6d729d4b35f10fc73531210bd7ecff91",
+  "message": "添加商家入驻申请记录成功。"
+}
+```
+响应失败JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 500,
+  "data": [],
+  "md5": "6d729d4b35f10fc73531210bd7ecff91",
+  "message": "添加商家入驻申请记录失败。"
+}
+```
+
+## 31、商家入驻获取产品大分类的列表 ##
+
+商家入驻获取产品大分类的列表（?method=app.category.queryMax）
+#### 请求参数
+| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 |  
+|:-------| -----:|-----:|-----:|-----:|----:|  
+
+
+注意，通用的头部没有列出。  
+请求示例  
+http://192.168.102.205:8080/geteway/?method=app.category.queryMax
+
+### 响应
+code为200即为成功，否则是失败。 
+响应参数，data部分  
+响应成功JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": [
+    {
+      "category_id": 1,
+      "category_name": "上衣"
+    },
+    {
+      "category_id": 3,
+      "category_name": "裤装"
+    },
+    {
+      "category_id": 4,
+      "category_name": "裙装"
+    },
+    {
+      "category_id": 6,
+      "category_name": "鞋靴"
+    },
+    {
+      "category_id": 7,
+      "category_name": "包类/装备"
+    },
+    {
+      "category_id": 8,
+      "category_name": "服配"
+    },
+    {
+      "category_id": 308,
+      "category_name": "内衣/家居服"
+    },
+    {
+      "category_id": 10,
+      "category_name": "创意生活"
+    },
+    {
+      "category_id": 567,
+      "category_name": "一级目录"
+    },
+    {
+      "category_id": 360,
+      "category_name": "泳衣"
+    },
+    {
+      "category_id": 592,
+      "category_name": "0408新增1"
+    },
+    {
+      "category_id": 365,
+      "category_name": "潮童"
+    },
+    {
+      "category_id": 241,
+      "category_name": "数码周边"
+    }
+  ],
+  "md5": "8d152a99a6403afb3028b108d4a73d32",
+  "message": "Category Product List."
+}
+```
+
+## 32、商家入驻根据parentId获取二级分类的列表 ##
+
+商家入驻根据parentId获取二级分类的列表（?method=app.category.queryMin）
+#### 请求参数
+| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 |  
+|:-------| -----:|-----:|-----:|-----:|----:|  
+|parent_id|String|否|1||| 
+
+注意，通用的头部没有列出。  
+请求示例  
+http://192.168.102.205:8080/geteway/?method=app.category.queryMin&parent_id=1
+
+### 响应
+code为200即为成功，否则是失败。 
+响应参数，data部分  
+响应成功JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": [
+    {
+      "category_id": 11,
+      "category_name": "T恤"
+    },
+    {
+      "category_id": 13,
+      "category_name": "POLO"
+    },
+    {
+      "category_id": 14,
+      "category_name": "背心"
+    },
+    {
+      "category_id": 12,
+      "category_name": "衬衫"
+    },
+    {
+      "category_id": 16,
+      "category_name": "卫衣"
+    },
+    {
+      "category_id": 257,
+      "category_name": "毛衣/针织"
+    },
+    {
+      "category_id": 21,
+      "category_name": "夹克"
+    },
+    {
+      "category_id": 22,
+      "category_name": "大衣/风衣"
+    },
+    {
+      "category_id": 226,
+      "category_name": "防风外套"
+    },
+    {
+      "category_id": 19,
+      "category_name": "西装"
+    },
+    {
+      "category_id": 15,
+      "category_name": "马甲"
+    },
+    {
+      "category_id": 20,
+      "category_name": "棉衣"
+    },
+    {
+      "category_id": 18,
+      "category_name": "羽绒服"
+    },
+    {
+      "category_id": 172,
+      "category_name": "皮衣"
+    },
+    {
+      "category_id": 412,
+      "category_name": "套装"
+    }
+  ],
+  "md5": "5e9e33f14cfb223f8833008c9c5b27fe",
+  "message": "Category Product List."
+}
+```
--- a/订单/订单前后台分离.md
View file @ba24802
+++ b/订单/订单前后台分离.md
View file @ba24802
@@ -59,6 +59,8 @@ code==200表示成功,其它都为失败
 	"exchange_mode": 10,
 	"mobile": "13776693005",
 	"order_code": 16062099,
+	"init_order_code": 16062099,
+	"source_order_code": 16062099,
 	"province": "江苏省",
 	"receipt_time": "2",
 	"remark": "用户换货",
@@ -87,28 +89,72 @@ code==200表示成功,其它都为失败
 | exchanges | amq.topic |
 | route key | erp.createChangeOrder |
+成功
+
 ```json
-{"id":1,"init_order_code":"111","source_order_code":1111,"new_order_code":1111,"exchange_id":111,"returned_id":111,"exchange_status":10,"returned_status":10}
+{
+    "code": 200, 
+    "message": "ok", 
+    "data": {
+        "id": 1, 
+        "init_order_code": "111", 
+        "source_order_code": 1111, 
+        "new_order_code": 1111, 
+        "exchange_id": 111, 
+        "returned_id": 111, 
+        "exchange_status": 10, 
+        "returned_status": 10
+    }
+}
+```
+
+失败
+
+```json
+{
+    "code":500,
+    "message":"error",
+    "data":{ 
+        "id": 1, 
+        "init_order_code": "111", 
+        "source_order_code": 1111, 
+        "new_order_code": 1111, 
+        "exchange_id": 111, 
+        "returned_id": 111, 
+        "exchange_status": 91,  // 客服驳回
+        "returned_status": 91   // 客服驳回
+    }
+}
 ```
 ### 前台更新换货快递信息
 | | |
 | :-- | :-- |
 | exchanges | amq.topic |
-| route key | order.updateChangeOrderExpressInfo |
+| route key | order.updateChangeRefundOrderExpressInfo |
 ```json
-{"id":1,"apply_id":40,"express_number":"603596395359","express_name":"顺丰","express_id":"23"}
+{   "id":1,
+    "apply_id":40,
+    "express_number":"603596395359",
+    "express_name":"顺丰",
+    "express_id":"23",
+    type:"change"       // 表示类型为换货
+}
 ```
 ### ERP更新换货单状态
 | | |
 | :-- | :-- |
 | exchanges | amq.topic |
-| route key | erp.updateChangeOrderStatus |
+| route key | erp.updateChangeRefundOrderStatus |
 ```json
-{"id":1,"status":40}
+{   
+    "returned_id":1,        //returned_id为erp系统退货单id唯一主键
+    "status":40,
+    "type":"change"     //"change" 表示换货类型,"refund"表示退货类型
+}
 ```
@@ -118,34 +164,106 @@ code==200表示成功,其它都为失败
 | exchanges | amq.topic |
 | route key | order.createRefundOrder |
+```json
+{
+    "uid": "3342109",
+    "alipay_account": "13912008849",
+    "alipay_name": "xxxx",
+    "area_code": "area_code",
+    "bank_card": "6228480605428963215",
+    "bank_name": "中国农业银行",
+    "city": "南京市",
+    "county": "",
+    "order_code": "308545172",
+    "payee_name": "张璐",
+    "province": "江苏省",
+    "remark": "尺寸不合适",
+    "return_amount_mode": "2",
+    "order_returned_id":123,//前台表生成的退货订单主键,其余字段同老接口
+    "returned_goods_list": [
+        {
+            "product_sku": "383669",
+            "goods_type": "1",
+            "last_price": "334",
+            "returned_reason": "1",
+            "remark": "尺寸不合适",
+            "evidence_images": ""
+        }
+    ]
+}
+```
+
+
 ### ERP创建退货单
 | | |
 | :-- | :-- |
 | exchanges | amq.topic |
 | route key | erp.createRefundOrder |
+
+成功
+
+```json
+{
+    "code": 200, 
+    "message": "ok", 
+    "data": {   
+        "order_returned_id":1,      //order_returned_id为前台退货id唯一主键
+        "returned_id":1,            //returned_id为erp退货id唯一主键
+        "returned_status":10,
+        "real_returned_amount":100,
+        "is_return_coupon":"N",
+        "return_yoho_coin":11111
+    }
+}
+```
+
+失败
+
 ```json
-{"id":1,"returned_id":1,"returned_status":10,"real_returned_amount":100,"is_return_coupon":"N","return_yoho_coin":11111}
+{
+    "code":500,
+    "message":"error",
+    "data":{ 
+        "order_returned_id":1,      //order_returned_id为前台退货id唯一主键
+        "returned_id":1,            //returned_id为erp退货id唯一主键
+        "returned_status":91       //客服驳回
+    }
+}
 ```
+
 ### 前台更新退货快递信息
 | | |
 | :-- | :-- |
 | exchanges | amq.topic |
-| route key | order.updateRefundOrderExpressInfo |
+| route key | order.updateChangeRefundOrderExpressInfo |
 ```json
-{"id":1,"apply_id":40,"express_number":"603596395359","express_name":"顺丰","express_id":"23"}
+{   "order_returned_id":1,      //order_returned_id为前台退货id唯一主键
+    "apply_id":40,              //apply_id为erp退货id唯一主键
+    "express_number":"603596395359",
+    "express_name":"顺丰",
+    "express_id":"23"，
+    "type":"refund"            // 表示类型为退货
+}
+
+
 ```
 ### ERP更新退货单状态
 | | |
 | :-- | :-- |
 | exchanges | amq.topic |
-| route key | erp.updateRefundOrderStatus |
+| route key | erp.updateChangeRefundOrderStatus |
 ```json
-{"id":1,"status":40}
+{   
+    "returned_id":1,        //returned_id为erp系统退货单id唯一主键
+    "status":40,
+    "type":"refund"        //"change" 表示换货类型,"refund"表示退货类型
+}
+
 ```