Skip to content

Get Ticket Info V2

Description

取得票劵資訊。

Resource

GET /v2/ticket/info

Authorization

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

Request Body Parameters

Name Type Description
id string 票券編號
order_id string 訂單編號
(optional)
store_id string 門市代碼
(optional)
language string
(enum)
語系
ALLOWED VALUES:
  • TRADITIONAL_CHINESE: 繁體中文
  • JAPANESE: 日語
  • KOREAN: 韓語
  • ENGLISH: 英語
  • FRENCH: 法語
  • INDONESIAN: 印尼語
  • THAI: 泰語
  • VIETNAMESE: 越南語
  • SPANISH: 西班牙語
  • GERMAN: 德語
  • RUSSIAN: 俄語
(optional)

Request

GET /v2/ticket/info?id=xxPkOwMnrV6J/EWqacTxYQ==&order_id=test21092200001

Response Body Parameters

Name Type Description
id string 票劵編號
product_id string 商品編號
product_name string 商品名稱
price integer 商品金額
redeem_product_id string 兌換商品編號
kind_id string 種類編號
kind_name string 種類名稱
kind_type string 種類屬性
ALLOWED VALUES:
  • GIFT_VOUCHER
  • SALE_EVENT_COUPON
  • ENTRANCE_TICKET
  • DISCOUNT_COUPON
  • CASH_COUPON
  • PRODUCT_SPECIFIC_COUPONS
product_ticket_type string 商品票券型態
ALLOWED VALUES:
  • PRODUCT_VOUCHER
  • PRODUCT_SPECIFIC_DISCOUNT_COUPON
  • PRODUCT_SPECIFIC_CASH_COUPON
(option)
available bool 是否可以使用票券
start_date string 有效起日
EXAMPLE "2020-01-01 12:00:00"
end_date string 有效迄日
EXAMPLE "2020-01-01 12:00:00"
message string 提示訊息
discount integer 折扣率/折價金額
假設此值為70
若為折價券、商品折價券,代表折價70元
若為折扣券、商品折扣券,代表打7折
(optional)
vip_id string 會員編號
ticket_status string 票券狀態
ALLOWED VALUES:
  • 0=建立
  • 1=銷售
  • 2=兌回
  • 3=黑名單
  • 4=銷毀
  • 5=領用
  • 6=公關
back_shop string 核銷門市編號
(optional)
back_date string 核銷日期
(optional)
decrypted_id string 票券明碼編號,公司有使用票券加密功能才回傳此參數
(optional)

Response kind_type

kind_type description
GIFT_VOUCHER 禮券
SALE_EVENT_COUPON 抵用券
ENTRANCE_TICKET 入場券
DISCOUNT_COUPON 折扣券
CASH_COUPON 折價券
PRODUCT_SPECIFIC_COUPONS 商品券

Response product_ticket_type

product_ticket_type description
PRODUCT_VOUCHER 商品提貨券
PRODUCT_SPECIFIC_DISCOUNT_COUPON 商品折扣券
PRODUCT_SPECIFIC_CASH_COUPON 商品折價券

Response

{
    "id": "wNcOYVd/uBrbnazAAK1ipQ==",
    "product_id": "A01001",
    "product_name": "90元折價券",
    "price": 90,
    "redeem_product_id": "",
    "kind_id": "T2",
    "kind_name": "折價券",
    "kind_type": "CASH_COUPON",
    "product_ticket_type": "PRODUCT_SPECIFIC",
    "start_date": "2021-09-15 15:26:59",
    "end_date": "2022-08-17 23:59:59",
    "available": true,
    "message": "",
    "discount": 90,
    "vip_id": "ABC001",
    "ticket_status": "2",
    "back_shop": "000030",
    "back_date": "2022-08-16 23:59:59"
}