Mohist Use Or Get Ticket

Description

墨攻核銷或查詢票券。
此 API 會去呼叫 Laravel 墨攻核銷或查詢 API，根據 API 回應結果回傳。

Resource

POST /v1/ticket/mohist/use_or_get_ticket

Authorization

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

Request Body Parameters

Name	Type	Description
store_id	string	門市代碼
module	string	執行模組( Query / Used ) Query：查詢票券資料(禮券編號/核銷碼) Used：核銷票券(核銷碼)
number	string	票劵號碼

Request

{
  "store_id": "0",
  "module": "Query",
  "number": "AAAA160420000002"
}

Response Body Parameters

Name	Type	Description
ReturnCode	Code Instruction	回傳代碼
ReturnMsg	Code Instruction	回傳訊息
TickInfo	TickInfo	票券資訊

Request Body Parameters - Code Instruction

ReturnCode	ReturnMsg	kiosk顯示訊息(回傳此訊息)
0000	執行成功	N/A
0002	使用日期不在優惠期間內	票券優惠期間已過，如有疑問請洽票券原購買平台商
0003	票券信託過期	票券信託已過期，如有疑問請洽票券原購買平台商
E011	Query，查無對應之票券	查無票券，如有疑問請洽票券原購買平台商
E100	QueryDetail，查無對應之票券	查無票券，如有疑問請洽票券原購買平台商
E014	{{Module}}，查無對應之票券	查無票券，如有疑問請洽票券原購買平台商
E024	{{Module}}，此票券已使用	此票券已使用，如有疑問請洽票券原購買平台商
E034	{{Module}}，此票券已作廢	此票券已作廢，如有疑問請洽票券原購買平台商
E012	此廠商尚未啟用 API 核銷權限	店家尚未申請票券服務，如有疑問請洽服務人員
E022	此廠商尚未啟用 API 查詢權限	店家尚未申請票券服務，如有疑問請洽服務人員
E013	此 PlatFormID 無票券核銷之權限	店家尚未申請票券服務，如有疑問請洽服務人員
E023	此 PlatFormID 無票券查詢之權限	店家尚未申請票券服務，如有疑問請洽服務人員
E006	參數 Module 內容有誤	票券服務異常，請洽服務人員
E007	此 PlatFormID 已被關閉	票券服務關閉中，請洽服務人員
E008	PlatFormID 不存在	店家尚未申請票券服務，如有疑問請洽服務人員
9999	串接異常，不為 json 格式	票券服務異常，請洽服務人員

Response Body Parameters - TickInfo

Name	Type	Description
OrderId	string	訂單編號
OrderDate	string	交易日期
OrderTime	string	交易時間
TickNo	string	票券序號
DnNum	string	自訂編號。由廠商自定規則,於交易當下產生
TickStatus	string	票券狀態。未使用已使用已作廢請款中已審核票券狀態異常
TickUnitAmt	string	票券金額-終端售價
ProdSetPrices	string	商品設定金額
ProdName	string	商品名稱
PlatformProdCode	string	商品編號
DnPID	string	商品自訂編號(固定值)。為商品設定之自訂編號前置碼,不包含流水號
is_special	string	是否有優惠期限。y:有設定優惠期限
ProdSpecialS	string	優惠期限 – 起
ProdSpecialE	string	優惠期限 – 訖
ETT_cost	string	進貨淨值
UsedDate	string	核銷日期
CancelDate	string	作廢日期
SaleFrom	string	通路來源

Response

{
    "ReturnCode": "0003",
    "ReturnMsg": "票券信託已過期，如有疑問請洽票券原購買平台商",
    "TickInfo": {
        "OrderId": "AAAA16042015232266",
        "OrderDate": "2016-04-20",
        "OrderTime": "15:23:22",
        "TickNo": "AAAA160420000002",
        "DnNum": "",
        "TickStatus": "請款中",
        "TickUnitAmt": "199",
        "ProdName": "滚动巴士 - A台北-台中日月潭一日游",
        "is_special": "n",
        "ProdSpecialS": null,
        "ProdSpecialE": null,
        "UsedDate": null,
        "CancelDate": null,
        "ETT_cost": "199",
        "ProdSetPrices": "199",
        "SaleFrom": "線上旅展",
        "PlatformProdCode": "3028",
        "DnPID": null
    }
}

Mohist Use Or Get Ticket API Workflow

sequenceDiagram
    autonumber
    participant C as Client
    participant O as Omniplatform
    participant LA as LaravelAPI

    C->>O: [POST] /v1/ticket/mohist/use_or_get_ticket
    activate O
    O->>O: Check Params
    alt if missing require params
      O->>C: Return response(400, message:'缺少 {column} 欄位')
    end

    O->>LA: Call auth login API
    activate LA
    LA->>O: Return response
    deactivate LA

    alt if response['status_code'] != 200
      O->>C: Return response(400)
    end

    O->>LA: Call mohist use or get ticket API
    activate LA
    LA->>O: Return response
    deactivate LA

    alt if response['status_code'] != 200
      O->>C: Return response(400)
    end

    O->>O: 根據錯誤代碼轉換錯誤訊息

    O->>C: Return response(200)
    deactivate O