富群線上點餐 x 達鈦POS

Webhook

Security

Hash

TOKEN = sha256({POST BODY} + {PRIVATE_KEY})

Header Auth Structure

X-Auth-Token: {TOKEN}

查詢主機是否上線

Path: ~/api/host
Method: GET
Auth: required

Header:

X-Auth-Token: {TOKEN}

Body:

{
    "data": {
        "store": {                //商店資訊
            "id": <string>,               //商店代號
            "serial_number": <string>     //POS端商店代號
        }
    },
    "notification_id": "stores.state"    //通知類型 
}

POS收到後重新發送富群API【傳送POS機開機通知給富群】

訂單通知

Path: ~/api/order
Method: POST
Auth: required

Header:

X-Auth-Token: {TOKEN}

Body:

{
    "data": {
        "order_id":<string>,     //訂單編號
        "store": {                //商店資訊
            "id": <string>,               //商店代號
            "serial_number": <string>     //POS端商店代號
        }
    },
    "has_reservation" : <boolean>,               //true:排程預約訂單 false:即時
    "notification _id":  "orders.notifi cation"   //傳送取得訂單通知給富群(即時、預約)

收到通知後，發送富群 API 【傳送取得訂單通知給富群(即時、預約)】，再發送訂單資訊給POS

訂單狀態查詢

Path: ~/api/order
Method: GET
Auth: required

Header:

X-Auth-Token: {TOKEN}

Body:

{
    "data": {
        "order_ids": [
            { "id":<string> },     //訂單編號1
            { "id":<string> },     //訂單編號2
            //...
        ],
        "store": {                //商店資訊
            "id": <string>,               //商店代號
            "serial_number": <string>    //POS端商店代號
        },
    },
    "notification_id": "orders.query"    //通知類型 
}

POS收到後重新發送富群API【傳送訂單狀態給富群】

回傳

Code: 200

OK

Code: 400

// error messenge
<string>

Code: 403

Please Check Your Permission

Code: 422

// error messenge
<string>

---

訂單串接範例API

僅為範例使用，目前不使用

取得訂單資料

Method: GET
Path: https://<doamin>/api/pos/v1/order?id={order_id}
Auth: required

Response

{
    data: {
        "id": <string>,        //訂單編號
        "store": {             //商店資訊
            "id": <string>,
            "name": <string>,
            "phone": <string>,
            "tax_id_number": <string>,
            "address": {
                "value": <string>,
            },
        },
        "shipping": {           //訂單購買資訊 
            "id": <string>,
            "name": <string>,
            "phone": <string>,
            "address": <string>,
            "expeditionType": <string>,    //外送或自取
        },
        "buyer": {    //買家資訊
            "name": <string>,
            "phone": <string>,
            ...etc
        },    
        "items": [
            {
                "id": <string>,       
                "name": <string>,
                "serial_number": <string>, //POS自訂代號
                "amount": <number>,        //產品單價 加上 相關附加項目的價格
                "quantity": <number>,
                "price": <number>,         //產品單價
                "selected_specs_group": [   
                {
                    "id": <string>,    
                    "name": <string>,      //附加項目群組名稱(糖度,冰量,...)
                    "serial_number": <string>, //附加項目群組POS自訂代號
                    "selected_specs":{
                        "id": <string>,
                        "name": <string>,    //附加項目名稱(去冰,微冰,...)
                        "serial_number": <string>, //附加項目POS自訂代號
                        "amount": <number>,    
                        "quantity": <number>,
                        "price": <number>,     
                    }
                }],
            }
        ],
        "total": <number>    //訂單總額(店家發票金額=訂單總額-折扣)
        "sub_totals": {
            <Totals>,
        },
        "discount": <number>    //折扣總額
        "sub_discounts": {
            <discounts>,
        }, 
        "status": {
            "order": "string"
        },
        "created_at": <Datetime>,
    },
    success: true,
    expired_at: null
}

確認訂單

Method: POST
Path: https://<doamin>/api/pos/v1/order/confirm
Auth: required

Request

{
    "order_id": <string>
}

Response

{
    "success": true
}

取消訂單

Method: POST
Path: https://<doamin>/api/pos/v1/order/cancel
Auth: required

Request

{
    "order_id": <string>
}

Response

{
    "success": true
}

---

文件修改記錄

2023/01/17

1. 查詢主機是否上線
   methods：POST -> GET
2. 訂單狀態查詢
   methods：POST -> GET
   order_id -> order_ids

tags: 接單程式,Fortune