Skip to content

Get Brands

Description

取得品牌牆列表。

Resource

GET /v1/basic/brands

Authorization

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

Query Parameters

Name Type Description
shop_id string 門市編號
(optional)
shop_group_id string 門市群組編號
(optional)
language string
(enum)
語系
ALLOWED VALUES:
  • TRADITIONAL_CHINESE: 繁體中文
  • JAPANESE: 日語
  • KOREAN: 韓語
  • ENGLISH: 英語
  • FRENCH: 法語
  • INDONESIAN: 印尼語
  • THAI: 泰語
  • VIETNAMESE: 越南語
  • SPANISH: 西班牙語
  • GERMAN: 德語
  • RUSSIAN: 俄語
(optional)

Request Example

GET /v1/basic/brands

Response Body Parameters

Name Type Description
brands Brand 品牌列表

Response Body Parameters - Brand

Name Type Description
shop_id string 門市編號
shop_name string 門市名稱
pwa_small_logo_url string PWA (WiXGO) 小 LOGO
brand_logo_url string 品牌 LOGO
translate_name string 門市翻譯名稱
translate_english_name string 門市英文名稱
translate_nickname string 門市翻譯簡稱
translate_english_nickname string 門市英文簡稱
pending_order_quantity integer 等待訂單數量
company_authkey string 公司金鑰
is_kiosk_open boolean KIOSK 是否開啟
is_pwa_open boolean PWA (WIXGO) 是否開啟
business_begin_time string 營業開始時間
business_end_time string 營業結束時間

Response Example - Http code = 200

{
    "brands": [
        {
            "shop_id": "000030",
            "shop_name": "台北訓練機",
            "pwa_small_logo_url": null,
            "brand_logo_url": null,
            "translate_name": null,
            "translate_english_name": null,
            "translate_nickname": null,
            "translate_english_nickname": null,
            "pending_order_quantity": 2,
            "company_authkey": "7kamxm7j2baumz34gm2gbgehxsh1cbnq",
            "is_kiosk_open": true,
            "is_pwa_open": false,
            "business_begin_time": "10:00",
            "business_end_time": "19:00"
        }
    ]
}