Skip to content

Set Delivery Status

Description

設置外送功能開關狀態。

Resource

PATCH /v1/basic/delivery/status

Authorization

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

Request Body Parameters

Name Type Required Description
store_id string 否 門市編號
source string 是 客戶端裝置
ALLOWED VALUES:
  • PWA
enabled boolean 是 是否啟用外送功能
  • true: 啟用
  • false: 停用

Request Body Example

範例 1: 更新店舖層級外送狀態

{
    "store_id": "000030",
    "client_device": "PWA",
    "enabled": true
}

範例 2: 更新公司層級外送狀態

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

Response Body Parameters

Name Type Description
message string 系統訊息

Response Example - Http code = 204

HTTP/1.1 204 No Content
成功時回傳 204 No Content，無回應內容。

Error Response Examples

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

{
    "message": "參數驗證失敗: client_device: client_device 目前僅支援 PWA"
}

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

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

Http code = 401 (未授權)

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

Http code = 403 (無權限)

{
    "message": "無權限操作店舖 STORE001"
}

Http code = 404 (店舖不存在)

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