update

zhengwen.ge
Commit e7d50b9320b5c9dc2b58807afc386c60bf9269e0 1 parent 852fd2d8
Showing 1 changed file with 173 additions and 0 deletions
商家端/README.md
--- a/商家端/README.md
View file @e7d50b9
+++ b/商家端/README.md
View file @e7d50b9
@@ -200,4 +200,177 @@ code为200即为成功，否则是失败。
   "message": "操作成功"
 }
 }
+ ```
+ 
+ ## 4、商家端，获取站内信列表##
+ 
+ 商家端，获取站内信列表（method=app.shopInbox.getList）
+ #### 公共请求参数
+ | 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
+ |:-------| -----:|-----:|-----:|-----:|-----:|----:| 
+ |client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
+ |app_version|float|10|否|1||APP版本|
+ |os_version|string|20|否|Android4.4||系统版本+机器型号|
+ |client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
+ |screen_size|string|20|否|800x900||（手机尺寸）|
+ 
+ #### 请求参数
+ | 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+ |:-------| -----:|-----:|-----:|-----:|----:| 
+ |shopsId|String|否|2793||店铺id|
+ 
+ 
+ 注意，通用的头部没有列出。  
+ 请求示例
+ http://127.0.0.1:8081/gateway/?method=app.shopInbox.getList&shopsId=123&type=1
+ 
+ ### 响应(data里所有的字段返回都是string类型)
+ code为200即为成功，否则是失败。 
+ 响应JSON格式如下所示:
+ ```json
+ {
+ {
+   "alg": "SALT_MD5",
+   "code": 200,
+   "data": {
+     "list": [
+       {
+         "content": "大家好，最新版的商家端app已经上线，敬请更新潮店宝4.4.0版本。",
+         "createTime": 1464241919,
+         "id": 49068,
+         "isDel": "N",
+         "isRead": "N",
+         "shopsid": 123,
+         "title": "【公告】商家端app上线",
+         "type": "1"
+       }
+     ]
+   },
+   "md5": "e280b0c02a41ef2b01fc8e39f18d2087",
+   "message": "操作成功"
+ }
+ }
+ ```
+ 
+ ## 5、获取消息的数量, 根据is_read条件过滤.##
+ 
+ 获取消息的数量, 根据is_read条件过滤.(method=app.shopInbox.getShopInboxTotal)
+ #### 公共请求参数
+ | 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
+ |:-------| -----:|-----:|-----:|-----:|-----:|----:| 
+ |client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
+ |app_version|float|10|否|1||APP版本|
+ |os_version|string|20|否|Android4.4||系统版本+机器型号|
+ |client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
+ |screen_size|string|20|否|800x900||（手机尺寸）|
+ 
+ #### 请求参数
+ | 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+ |:-------| -----:|-----:|-----:|-----:|----:| 
+ |shopsId|String|否|2793||店铺id|
+ |isRead|String|是|Y,N||是否已读|
+ 
+ 注意，通用的头部没有列出。  
+ 请求示例
+ http://127.0.0.1:8081/gateway/?method=app.shopInbox.getShopInboxTotal&shopsId=123&isRead=N
+ 
+ ### 响应(data里所有的字段返回都是string类型)
+ code为200即为成功，否则是失败。 
+ 响应JSON格式如下所示:
+ ```json
+ {
+ {
+   "alg": "SALT_MD5",
+   "code": 200,
+   "data": 1,
+   "md5": "2c1f3cf90a65af787e96f80a73058912",
+   "message": "操作成功"
+ }
+ }
+ ```
+ 
+ ## 6、批量设置为已读.##
+ 
+ 获取消息的数量, 根据is_read条件过滤.(method=app.shopInbox.getShopInboxTotal)
+ #### 公共请求参数
+ | 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
+ |:-------| -----:|-----:|-----:|-----:|-----:|----:| 
+ |client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
+ |app_version|float|10|否|1||APP版本|
+ |os_version|string|20|否|Android4.4||系统版本+机器型号|
+ |client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
+ |screen_size|string|20|否|800x900||（手机尺寸）|
+ 
+ #### 请求参数
+ | 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+ |:-------| -----:|-----:|-----:|-----:|----:| 
+ |shopsId|String|否|2793||店铺id|
+ |ids|String|否|49068，49070|||
+ 
+ 注意，通用的头部没有列出。  
+ 请求示例
+ http://127.0.0.1:8081/gateway/?method=app.shopInbox.batchSetIsRead&shopsId=123&ids=49068
+ 
+ ### 响应(data里所有的字段返回都是string类型)
+ code为200即为成功，否则是失败。 
+ 响应JSON格式如下所示:
+ ```json
+ {
+ {
+   "alg": "SALT_MD5",
+   "code": 200,
+   "data": {
+     "code": "200",
+     "data": [],
+     "message": "success"
+   },
+   "md5": "b51ee4b85429bc5ea4a98cd75428f2c4",
+   "message": "操作成功"
+ }
+ }
+ ```
+ 
+ ## 7、根据shopsID，站内信id删除商家端用户站内信##
+ 
+ 根据shopsID，站内信id删除商家端用户站内信.(method=app.shopInbox.delShopInbox)
+ #### 公共请求参数
+ | 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
+ |:-------| -----:|-----:|-----:|-----:|-----:|----:| 
+ |client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
+ |app_version|float|10|否|1||APP版本|
+ |os_version|string|20|否|Android4.4||系统版本+机器型号|
+ |client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
+ |screen_size|string|20|否|800x900||（手机尺寸）|
+ 
+ #### 请求参数
+ | 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+ |:-------| -----:|-----:|-----:|-----:|----:| 
+ |shopsId|String|否|2793||店铺id|
+ |ids|String|否|49068，49070|||
+ 
+ 注意，通用的头部没有列出。  
+ 请求示例
+ http://127.0.0.1:8081/gateway/?method=app.shopInbox.delShopInbox&shopsId=123&ids=49068
+ 
+ ### 响应(data里所有的字段返回都是string类型)
+ code为200即为成功，否则是失败。 
+ 响应JSON格式如下所示:
+ ```json
+ {
+ {
+   "alg": "SALT_MD5",
+   "code": 200,
+   "data": {
+     "code": "200",
+     "data": [
+       {
+         "id": "49068"
+       }
+     ],
+     "message": "success"
+   },
+   "md5": "d925151adb0f4adac9626663cfd74238",
+   "message": "操作成功"
+ }
+ }
 ```
\ No newline at end of file