Skip to content

Get Banners

Description

取得廣告輪播圖。

Resource

GET /v1/banners

Authorization

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

Query Parameters

Name Type Description
app_type string
(enum)
APP類型
ALLOWED VALUES:
  • KIOSK
  • CATERING
  • RETAIL
  • MINI_KIOSK
  • QR_ORDER
  • POP_UP
store_id string 門市代碼
(optional)

Request Example

GET /v1/banners?app_type=RETAIL

Response

{
  "banners": [
    {
      "id": "1",
      "position": 1,
      "subject": "menu2",
      "image_url": "https://omni.lafresh.com.tw/public/banner/14-1-1496974744.png",
      "redirect_url": "https://omni.lafresh.com.tw",
      "img_update_time": null
    },
    {
      "id": "2",
      "position": 2,
      "subject": "menu1",
      "image_url": "https://omni.lafresh.com.tw/public/banner/13-1-1496974698.png",
      "redirect_url": "https://omni.lafresh.com.tw",
      "img_update_time": null
    }
  ]
}

Response Body Parameters

Name Type Description
banners Banner[] 門市列表

Response Body Parameters - Banner

Name Type Description
id string 圖片代碼
position integer 排序位置
subject string 標題
image_url string 圖片網址
redirect_url string 外部頁面網址
img_update_time string 圖檔異動時間
(optional)
目前僅支援KIOSK圖檔,其餘該資料顯示null