线下店接口定义更新

zhaojun
Commit 3c20046afb20456ad29c0ec2266416deafac7922 1 parent b0b3aad7
Showing 1 changed file with 63 additions and 55 deletions
订单/OfflineS.md
--- a/订单/OfflineS.md
View file @3c20046
+++ b/订单/OfflineS.md
View file @3c20046
 # 线下店购物车服务接口
-### 按uid或手环查询商品列表
+### 按购物车查询商品列表
 ### 接口说明
@@ -8,18 +8,16 @@
 | 接口说明 | 接口说明 | 
 | :-- | -----: |
 | 接口名 | app.OfflineS.cart |
-| 接口说明 | 按uid或手环查询商品列表 |
-| 接口说明 | 1.传uid，按uid查询商品列表 |
-| 接口说明 | 2.传手环，按手环查询商品列表 |
+| 接口说明 | 按shopping_key或md5_qr_key查询商品 |
 | http请求方式 | GET/POST |
 ### 请求参数
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.cart | | |
-| uid | int | 否 | 5772257 | | |
-| shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| sale_channel | string | 否 | 1 | 1 |  |
+| shopping_key | string | 是 | c36408a268e9b9418189d9a71967379e | |  购物车id|
+| md5_qr_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  md5后的手环|
+
 ### 正常返回结果
 ```json
@@ -29,8 +27,8 @@
 	"code": 200,
 	"data": {
 		"ordinary_cart_data": {     //普通商品购物车
-			"offline_goods": [],    //门店商品列表
-			"goods_list": [{        //线上商品列表
+			"offline_goods_list": [],    //门店商品列表
+			"online_goods_list": [{        //线上商品列表
 				"attribute": "1",
 				"brand_id": "4",
 				"buy_limit": 0,
@@ -258,11 +256,11 @@
 | 接口说明 | 接口说明 | 
 | :-- | -----: |
 | 接口名 | app.OfflineS.add |
-| 接口说明 | 添加商品到uid或手环（自动合并uid对应的商品集合到手环） |
-| 接口说明 | 1.传uid，商品加入到uid |
-| 接口说明 | 2.传手环，商品加入到手环 |
-| 接口说明 | 3.同时传uid和手环，自动合并uid对应的商品到手环|
-
+| 接口说明 | 添加商品到购物车或手环 |
+| 接口说明 | 1.传shopping_key则添加商品到购物车，不传则自动创建购物车，并把商品添加到购物车 |
+| 接口说明 | 2.传qr_key(手环），不传购物车，自动创建购物车并自动绑定，并把商品添加到购物车 |
+| 接口说明 | 3.同时传qr_key和shopping_key，自动绑定shopping_key与md5(qr_key)|
+| 接口说明 | 1、2、3都返回shopping_key和md5_qr_key(md5后的手环，如果没有则为0）|
 | http请求方式 | GET/POST |
@@ -272,12 +270,13 @@
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.add | | |
 | product_sku | int | 是 | 12121212 | |sku |
-| uid | int | 否 | 5772257 | |用户id |
-| shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| buy_number | string | 否 | 1 | 1 | 购买数量 |
+| product_skn | int | 否 | 12121212 | |skn |
+| delivery_way| int | 是 |  |  | 1:门店取货,2:线上购买 |
+| store_id    | int | 是 |  |  | 门店id |
+| buy_number  | int | 是 | 1 | 1 | 购买数量 |
 | promotion_id | int | 否 |  |  | 促销优惠id |
-| offline_shop_id | int | 否 |  |  | 门店id |
-
+| shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  购物车|
+| qr_key | string | 否 | xxxxxxxxxxxxxxxxxxxxxxxxxxxx | |  手环二维码|
 ### 正常返回结果
 ```json
@@ -286,7 +285,8 @@
 	"code": 200,
 	"data": {
 		"goods_count": "7",				//购物车商品数量
-		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //手环
+		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //购物车
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
 	},
 	"md5": "f9a4a776eb18b6d62a7b3ba992fa6041",
 	"message": "加入成功"
@@ -300,9 +300,7 @@
 | 接口说明 | 接口说明 | 
 | :-- | -----: |
 | 接口名 | app.OfflineS.increase |
-| 接口说明 | 增加uid或手环商品数量 |
-| 接口说明 | 1.传uid，增加商品数量到uid |
-| 接口说明 | 2.传手环，增加商品数量到手环 |
+| 接口说明 | 增加商品数量到shopping_key |
 | http请求方式 | GET/POST |
 ### 请求参数
@@ -310,9 +308,9 @@
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.increase | | |
 | product_sku | int | 是 | 12121212 | |sku |
-| uid | int | 否 | 5772257 | |用户id |
-| shopping_key | int | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| increase_number | string | 否 | 1 | 1 | 增加数量 |
+| delivery_way| int | 是 |  |  | 1:门店取货,2:线上购买 |
+| shopping_key | string | 是 | c36408a268e9b9418189d9a71967379e | |  购物车|
+| increase_number | int | 是 | 1 | 1 | 增加数量 |
 | promotion_id | int | 否 |  |  | 促销优惠id |
 ### 正常返回结果
@@ -323,6 +321,7 @@
 	"data": {
 		"goods_count": "7",				//购物车商品数量
 		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //shopping_key
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
 	},
 	"md5": "f9a4a776eb18b6d62a7b3ba992fa6041",
 	"message": "操作成功"
@@ -337,9 +336,7 @@
 | 接口说明 | 接口说明 | 
 | :-- | -----: |
 | 接口名 | app.OfflineS.decrease |
-| 接口说明 | 减少uid或手环商品数量 |
-| 接口说明 | 1.传uid，减少商品数量到uid |
-| 接口说明 | 2.传手环，减少商品数量到手环 |
+| 接口说明 | 减少商品数量到shopping_key |
 | http请求方式 | GET/POST |
 ### 请求参数
@@ -347,9 +344,9 @@
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.decrease | | |
 | product_sku | int | 是 | 12121212 | |sku |
-| uid | int | 否 | 5772257 | |用户id |
-| shopping_key | int | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| decrease_number | string | 否 | 1 | 1 | 减少数量 |
+| delivery_way| int | 是 |  |  | 1:门店取货,2:线上购买 |
+| shopping_key | string | 是 | c36408a268e9b9418189d9a71967379e | |  手环|
+| decrease_number | int | 是 | 1 | 1 | 减少数量 |
 | promotion_id | int | 否 |  |  | 促销优惠id |
 ### 正常返回结果
@@ -360,31 +357,29 @@
 	"data": {
 		"goods_count": "7",				//购物车商品数量
 		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //shopping_key
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
 	},
 	"md5": "f9a4a776eb18b6d62a7b3ba992fa6041",
 	"message": "操作成功"
 }
 ```
-### 删除uid或手环的商品
+### 删除shopping_key的商品
 ### 接口说明
 | 接口说明 | 接口说明 | 
 | :-- | -----: |
 | 接口名 | app.OfflineS.remove |
-| 接口说明 | 删除uid或手环的商品 |
-| 接口说明 | 1.传uid，删除uid下的商品 |
-| 接口说明 | 2.传手环，删除手环下的商品 |
+| 接口说明 | 删除shopping_key的商品 |
 | http请求方式 | GET/POST |
 ### 请求参数
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.remove | | |
-| uid | int | 否 | 5772257 | | |
 | shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| product_sku_list | string | 是 | {'131874':1,'765802':1} |  |  |
+| product_sku_list | string | 是 | "product_sku_list":"[{\"product_sku\":1019799,\"delivery_way\":100}]" |  |  |
 ### 正常返回结果
 ```json
@@ -394,6 +389,8 @@
 	"data": {
 		"goods_count": "7",				//购物车商品数量
 		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //shopping_key
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
+
 	},
 	"md5": "f9a4a776eb18b6d62a7b3ba992fa6041",
 	"message": "操作成功"
@@ -415,9 +412,9 @@
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.swap | | |
-| uid | int | 否 | 5772257 | | |
 | shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| swap_data | string | 是 | [{"buy_number":11,"selected":"Y","new_product_sku":"886593","old_product_sku":"131874"}] |  | 更换商品信息 |
+| swap_data | string | 是 |  "swap_data":"[{\"new_product_sku\":1019799,\"old_product_sku\":1019799,\"buy_number\":3,\"old_delivery_way\":1,\"new_delivery_way\":100}]"
+ |  | 更换商品信息 |
 ### 正常返回结果
 ```json
@@ -427,6 +424,8 @@
 	"data": {
 		"goods_count": "7",				//购物车商品数量
 		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //shopping_key
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
+
 	},
 	"md5": "f9a4a776eb18b6d62a7b3ba992fa6041",
 	"message": "加入成功"
@@ -448,9 +447,8 @@
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.removeAndCart | | |
-| uid | int | 否 | 5772257 | | |
 | shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| product_sku_list | string | 是 | [{"product_sku":131874,"buy_number":2,"promotion_id":0}] |  |  |
+| product_sku_list | string | 是 | "product_sku_list":"[{\"product_sku\":1019799,\"delivery_way\":100}]" |  |  |
 ### 正常返回结果
 ```json
@@ -474,7 +472,6 @@
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.count | | |
-| uid | int | 否 | 5772257 | | |
 | shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  |
 ### 正常返回结果
@@ -505,8 +502,7 @@
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.unbind | | |
-| uid | int | 是 | 5772257 | | |
-| shopping_key | string | 是 | c36408a268e9b9418189d9a71967379e | |  手环|
+| shopping_key | string | 是 | c36408a268e9b9418189d9a71967379e | |  购物车|
 ### 正常返回结果
 ```json
@@ -515,6 +511,8 @@
 	"code": 200,
 	"data": {
 		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //手环
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
+
 	},
 	"md5": "5f7db2059c7e09259edca244025949a9",
 	"message": "解绑成功"
@@ -534,11 +532,21 @@
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
 | method | string | 是 | app.OfflineS.active | | |
-| uid | int | 是 | 5772257 | | |
 | shopping_key | string | 是 | c36408a268e9b9418189d9a71967379e | |  手环|
-### 正常返回结果
-同查询购物车返回结果
+```json
+{
+	"alg": "SALT_MD5",
+	"code": 200,
+	"data": {
+		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //手环
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
+
+	},
+	"md5": "5f7db2059c7e09259edca244025949a9",
+	"message": "激活成功"
+}
+```
 ### 线上线下商品调整
@@ -553,11 +561,10 @@
 ### 请求参数
 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 
 | :-- | :--  | :--  | :-- | :-- | :-- |
-| method | string | 是 | app.OfflineS.adjust | | |
-| type | int | 是 | 1:从线下调整到线上；2：线上调整到线下 | | |
-| uid | int | 否 | 5772257 | | |
+| method | string | 是 | app.OfflineS.swap | | |
 | shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | |  手环|
-| swap_data | string | 是 | [{"buy_number":11,"selected":"Y","new_product_sku":"886593","old_product_sku":"131874"}] |  | 更换商品信息 |
+| swap_data | string | 是 |  "swap_data":"[{\"new_product_sku\":1019799,\"old_product_sku\":1019799,\"buy_number\":3,\"old_delivery_way\":1,\"new_delivery_way\":100}]"
+ |  | 更换商品信息 |
 ### 正常返回结果
 ```json
@@ -565,13 +572,14 @@
 	"alg": "SALT_MD5",
 	"code": 200,
 	"data": {
-		"goods_count": "7",				//调整的商品数量
+		"goods_count": "7",				//购物车商品数量
 		"shopping_key": "c36408a268e9b9418189d9a71967379e"   //shopping_key
+		"md5_qr_key": "c36408a268e9b9418189d9a719673734e"   //md5后的手环
+
 	},
 	"md5": "f9a4a776eb18b6d62a7b3ba992fa6041",
-	"message": "调整成功"
+	"message": "加入成功"
 }
-```
 ## 线下店结算接口 ##