Skip to content

Get Stores

Description

取得門市列表。

Resource

GET /v1/stores

Authorization

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

Path Parameters

Name Type Description
area string
(enum)		 區域編號
ALLOWED VALUES:
  • NORTH
  • CENTREL
  • SOUTH
  • EAST
  • OUTLYING_ISLAND

(optional)
city string 縣市編號
(optional)
districts string 地區編號
(optional)
purchase_type string
(enum)		 購買類型
ALLOWED VALUES:
  • RESTAURANT
  • SHOPPING
  • QUICK

(optional)
language string
(enum)		 語系
ALLOWED VALUES:
  • TRADITIONAL_CHINESE: 繁體中文
  • JAPANESE: 日語
  • KOREAN: 韓語
  • ENGLISH: 英語
  • FRENCH: 法語
  • INDONESIAN: 印尼語
  • THAI: 泰語
  • VIETNAMESE: 越南語
  • SPANISH: 西班牙語
  • GERMAN: 德語
  • RUSSIAN: 俄語
(optional)
latitude number 緯度
(Optional)
longitude number 經度
(Optional)
client_device string 客戶端裝置
ALLOWED VALUES:
  • KIOSK
  • PWA
  • EC_QUICK_ORDER
  • UBER_EATS
  • FOODPANDA
  • APP
  • EC_HAO_SPEED
  • EC_NIDIN
  • MPOS
  • POS
      • (optional)

Request Example

GET /v1/stores/

Response Body Parameters

Name Type Description
id string 門市代碼
name string 門市名稱
translate_name string 門市翻譯名稱
type string
(enum)		 門市類型
ALLOWED VALUES:
  • REGULAR_CHAIN
  • VOLUNTARY_CHAIN
phone string 電話
fax string 傳真
profile string 門市介紹
(HTML格式)
business_hours string 營業時間
can_use_receipt boolean 是否開立發票
location Location[] 地理資訊
support_phone string 支援電話
purchase_type list 購買類型
ALLOWED VALUES:
  • RESTAURANT
  • SHOPPING
authkey string 公司代碼
(optional)
company string 公司名稱
image_url string 圖片網址
enable_quickclick boolean 是否啟用快一點
enable_uber_eats boolean 是否啟用UberEats
enable_foodpanda boolean 是否啟用Foodpanda
enable_app boolean 是否啟用APP
mstore_use_version integer mStore使用版本
mobile_report_url string 手機報表網址
enable_store_marketing boolean 是否啟用門市行銷
enable_ordering_system boolean 是否啟用訂貨系統
enable_business_analysis boolean 是否啟用商務分析
enable_store_management boolean 是否啟用店務管理
enable_ticket_redeem_management boolean 是否啟用核銷管理
brand_logo_url string 品牌 LOGO URL
pwa_small_logo_url string PWA (WIXGO) 小 LOGO
meal_btime string 取餐時間起
meal_etime string 取餐時間訖
enable_call_number boolean 是否啟用叫號
enable_pwa boolean 是否啟用 PWA (WIXGO)
enable_kiosk boolean 是否啟用 KIOSK
enable_jenda boolean 是否啟用鉦達
pwa_meal boolean 提供 PWA (WIXGO) 取餐
kiosk_meal boolean 提供 Kiosk 取餐
delivery Delivery 外送相關資訊
(optional)
distance integer 與商店的距離(in meters)。當請求體中有經緯度資訊時，返回與商店的直線距離
(Optional)
enable_delivery_service boolean 是否啟用外送服務
suspend_reason string 暫停服務原因
preparation_time integer 備餐時間
sale_methods Sale Methods[] 銷售方式列表
tax_id_number string 統一編號

Response Body Parameters - Sale Methods

Name Type Description
id string 編號
name string 名稱
has_address boolean 是否需填寫地址
type string
(enum)		 銷售方式
ALLOWED VALUES:
  • DINE_IN
  • PICK_UP
  • DELIVERY
translate_name string
(enum)		 翻譯名稱

Response Body Parameters - Location

Name Type Description
address string 地址
zip_code string 郵遞區號
latitude double 緯度
longitude double 經度

Response Body Parameters - Delivery

Name Type Description
mode string
(enum)		 外送模式
ALLOWED VALUES:
  • STANDARD
  • MALL
handoff_options string[] 外送遞交選項
EXPECTED VALUES:
  • 親自遞交
  • 放置門口
  • 管理室代收
estimated_delivery_time integer 預估最快送達時間(in minutes)
(Optional)
estimated_delivery_buffer_time integer 預估最慢送達時間(in minutes)
(Optional)

Response

[
  {
    "id": "001",
    "name": "台南安平店",
    "translate_name": "translate_name",
    "type": "REGULAR_CHAIN",
    "phone": "061234567",
    "fax": "069876543",
    "profile": "<p>門市介紹的內容HTML格式</p>",
    "business_hours": "09:00~21:00",
    "can_use_receipt": true,
    "location": {
      "address": "台南市安平區健康三街999號",
      "zip_code": "708",
      "latitude": 22.9999999,
      "longitude": 120.9999999
    },
    "support_phone": "069764310",
    "purchase_type": [
      "RESTAURANT"
    ],
    "authkey": "abcdefghijklimnopqrstuvwxyz",
    "company": "測試公司",
    "image_url": "https://omni.lafresh.com.tw/public/stores/13-1-1496974698.png",
    "enable_quickclick": true,
    "enable_uber_eats": true,
    "enable_foodpanda": true,
    "enable_app": true,
    "mstore_use_version": 1,
    "mobile_report_url": "http://cloud.lafresh.com.tw:28445",
    "enable_store_marketing": false,
    "enable_ordering_system": false,
    "enable_business_analysis": false,
    "enable_store_management": false,
    "enable_ticket_redeem_management": false,
    "brand_logo_url": "http://test.com/image.png",
    "pwa_small_logo_url": "http://test.com/image.png",
    "enable_call_number": true,
    "enable_pwa": true,
    "enable_kiosk": true,
    "enable_jenda": true,
    "pwa_meal": true,
    "kiosk_meal": true,
    "enable_delivery_service": true,
    "delivery": {
      "mode": "STANDARD",
      "handoff_options": [
        "親自遞交"
      ],
      "estimated_delivery_time": 30,
      "estimated_delivery_buffer_time": 40
    },
    "distance": 50,
    "suspend_reason": "維護中",
    "preparation_time": 5,
    "sale_methods": [
        {
            "id": "0",
            "name": "內建",
            "has_address": false,
            "type": "DEFAULT",
            "translate_name": "built-in"
        },
        {
            "id": "1",
            "name": "內用",
            "has_address": false,
            "type": "DINE_IN",
            "translate_name": "Internal use"
        },
        {
            "id": "2",
            "name": "外帶",
            "has_address": false,
            "type": "PICK_UP",
            "translate_name": "takeout"
        },
        {
            "id": "3",
            "name": "電取",
            "has_address": false,
            "type": "PHONE_PICK_UP",
            "translate_name": "Electropheresis"
        },
        {
            "id": "4",
            "name": "外送",
            "has_address": true,
            "type": "Unknown",
            "translate_name": "delivery"
        },
        {
            "id": "5",
            "name": "特殊訂單",
            "has_address": false,
            "type": "Unknown",
            "translate_name": "Special order"
        }
    ],
    "tax_id_number": "24436074"
  }
]