Get Tickets Usage Records

Description

取得票券使用紀錄。

Resource

GET /v1/tickets_usage_records

Authorization

採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。

Request Query Parameters

Name	Type	Description
vip_id	string	(optional) 會員編號 (Wixtar 會員查找鍵，優先序：vip_id > phone_number)
phone_number	string	(optional) 會員手機號碼 (Wixtar 會員查找鍵，優先序：vip_id > phone_number)
start_date	string	(optional) 查詢起始日 (格式: YYYY-MM-DD 或 YYYY/MM/DD，預設為 30 天前)
end_date	string	(optional) 查詢結束日 (格式: YYYY-MM-DD 或 YYYY/MM/DD，預設為當日)
store_id	string	(optional) 門市代碼

Request Example

GET /v1/tickets_usage_records?phone_number=0912345678

Response

{
  "tickets": [
    {
      "id": "TE0020",
      "name": "麥味登",
      "ticket_type": "一般票券",
      "ticket_kind": "禮券",
      "product_name": "",
      "price": 100,
      "points": 0,
      "img": null,
      "can_transfer": true,
      "description": "",
      "begin_date": "2019/06/21",
      "end_date": "2099/12/31",
      "use_time": "2020-11-21 16:04:02",
      "is_hidden_ticket_no": true,
      "store": "台南陽光門市",
      "status": "CREATE"
    }
  ]
}

Response Body Parameters

Name	Type	Description
tickets	Ticket	票劵列表

Response Body Parameters - Ticket

Name	Type	Description
id	string	票劵編號
name	string	票劵名稱
ticket_type	string	票卷類型 ALLOWED VALUES: 一般票劵 點數票券
ticket_kind	string	票劵種類 ALLOWED VALUES: 禮券 抵用券 入場券 折扣券 折價券 商品券
product_name	string	商品名稱
price	integer	票卷商品面額
points	integer	票卷點數
img	string	票卷圖檔
can_transfer	Boolean	是否可轉送
description	string	票券描述。活動票券取活動描述；透過商品綁定配發或兌換的票券（無對應活動）改取該票券商品綁定設定的描述，兩者皆未設定時沿用原值
begin_date	string	票劵上架日
end_date	string	票劵下架日
use_time	string	票券兑回時間 ｜
is_hidden_ticket_no	boolean	是否隱藏票卷號碼
store	string	票券兑回門市
status	string	票券狀態 ALLOWED VALUES: CREATE DESTROY