API說明
API位置 |
/new_ezding/members/coupon_list |
需求描述 |
取得會員優惠券清單,排序規則優先順序如下:luse_status:0(可兌換)>1(轉贈中)>2(已轉贈)>3(已兌換)>999(已過期),expired:依到期日最近到最遠排序、created_date:依建立時間最新到最舊排序。APP適用:狀態為未兌換:依到期日最近到最遠排序、狀態為已兌換:依使用日最近到最遠排序、狀態為已過期:依到期日最近到最遠排序,f_status為3locked的要濾掉不顯示 |
傳輸物件格式 |
json |
方法 |
GET |
範例
curl -X GET \
-H " X-Ftcsys-key: {KEY}" \
-H " X-Ftc-Authorization: {token}" \
-H " X- Accept-Language: {language}" \
-H "Content-Type: application/json" \
http:
回傳範例
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=UTF-8
{
"result": {
"total_pages": 10,
"total_records": 100,
"page": 1,
"list": [
{
"coupon_id": "123",(<--這個欄位6/7上線先不傳)
"coupon_number": "N1234567",
"sid": 1,(<--這個欄位6/7上線先不傳)
"public_sid": 1,(<--這個欄位6/7上線先不傳)
"sys_group_id": 3,(<--這個欄位6/7上線先不傳)
"coupon_name": "test33",
"coupon_type": "QQ",(<--這個欄位6/7上線先不傳)
"status": 1,(<--這個欄位6/7上線先不傳)
"use_status": 0,
"order_id": "",(<--這個欄位6/7上線先不傳)
"generate_behavior": 2,(<--這個欄位6/7上線先不傳)
"begin_date": 1488011127000,
"expired": 1488011127000,
"created_date": 1488011027000,(<--這個欄位6/7上線先不傳)
"remark": null
},
{
"coupon_id": "120",(<--這個欄位6/7上線先不傳)
"coupon_number": "SDF4SDF",
"sid": 1,(<--這個欄位6/7上線先不傳)
"public_sid": 1,(<--這個欄位6/7上線先不傳)
"sys_group_id": 3,(<--這個欄位6/7上線先不傳)
"coupon_name": "test3",
"coupon_type": "QQ",(<--這個欄位6/7上線先不傳)
"status": 1,(<--這個欄位6/7上線先不傳)
"use_status": 0,
"order_id": null,(<--這個欄位6/7上線先不傳)
"generate_behavior": 2,(<--這個欄位6/7上線先不傳)
"begin_date": 1488011127000,
"expired": 1488011127000,
"created_date": 1488011027000,(<--這個欄位6/7上線先不傳)
"remark": null
}
]
},
"code": "200",
"status": "success"
}
回傳錯誤 - 優惠券查詢失敗
< HTTP/1.1 404 Not Found
< Content-Type: application/json; charset=UTF-8
{
"result": "",
"code": 404,
"status": "failure"
}
接收URL參數
參數 |
名稱 |
範例 |
必填 |
備註 |
use_status |
使用狀態 |
0 |
N |
預設為0,傳回全部資料、1:未使用、2:轉贈中、3:已轉贈、4:已使用、999:已過期 |
page |
頁碼 |
1 |
N |
|
page_size |
每頁傳回資料筆數 |
10 |
N |
回傳json的參數
參數 |
名稱 |
範例 |
必填 |
備註 |
total_pages |
總頁數 |
10 |
Y |
|
total_records |
結果筆數 |
100 |
Y |
|
page |
所在頁數 |
1 |
Y |
|
coupon_id |
優惠券ID |
00001 |
Y |
|
coupon_number |
優惠券序號 |
N123456 |
Y |
|
sid |
平台ID |
1 |
Y |
1:ez訂、2:ND |
public_sid |
發行優惠券平台ID |
1 |
Y |
同上 |
sys_group_id |
適用平台群組ID |
3 |
Y |
1:僅適用於ez訂、2:僅適用於niceday、3:適用於ez訂及niceday(各適用平台群組ID將陸續定義) |
coupon_name |
優惠券名稱 |
TEST |
Y |
|
coupon_type |
優惠券類型 |
TEST |
Y |
|
status |
有效狀態 |
1 |
Y |
1:有效、0:無效 |
use_status |
使用狀態 |
1 |
Y |
0:可兌換、1:轉贈中、2:已轉贈、3:已兌換、4:凍結、999 :已過期 |
order_id |
訂單編號 |
00001 |
N |
|
generate_behavior |
優惠券產生行為 |
1 |
Y |
1: 歸戶、2:活動贈與、3:兌換、4:退貨 |
begin_date |
有效開始日期 |
1488011117000 |
N |
|
expired |
到期日 |
1488011127000 |
Y |
|
created_date |
建立日期 |
1488011027000 |
Y |
|
remark |
備註說明 |
|
N |
use_status 新舊DB 代碼mapping
舊DB f_status 代碼 |
新DB use_status 代碼 |
說明 |
0 |
0 |
已建立 |
1 |
0 |
可兌換 |
2 |
3 |
已兌換 |
3 |
4 |
凍結 |
4 |
1、2 |
轉贈中、已轉贈 |
無,看expired_time |
999 |
已過期 |
1:已過期,但是expire time大於今天為手動重啟
2:已兌換(我猜),但是有trans_id為空值的,也有expire time大於今天的
0:可兌換(有owner代表已歸戶)
4:轉贈中(但是領取人領到後status不會變)