Skip to content

Get Delivery Status

Description

取得外送功能開關狀態。

Resource

GET /v1/basic/delivery/status

Authorization

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

Query Parameters

Name Type Required Description
store_id string 門市編號
client_device string 客戶端裝置
ALLOWED VALUES:
  • PWA

Request Example

範例 1: 查詢店舖層級外送狀態

GET /v1/basic/delivery/status?store_id=000030&client_device=PWA

範例 2: 查詢公司層級外送狀態

GET /v1/basic/delivery/status?client_device=PWA

Response Body Parameters

Name Type Description
client_device string 客戶端裝置
enabled boolean 外送功能狀態
true: 已啟用
false: 已停用

Response Example - Http code = 200

{
    "client_device": "PWA",
    "enabled": false
}

Error Response Examples

Http code = 400 (參數驗證失敗)

{
    "message": "參數驗證失敗: client_device: Input should be 'PWA'"
}

Http code = 400 (缺少必填欄位)

{
    "message": "缺少必填欄位 客戶端裝置"
}

Http code = 401 (未授權)

{
    "message": "headers缺少authorization參數"
}

Http code = 404 (門市不存在)

{
    "message": "店舖編號 000035 不存在"
}