Skip to content

Get Order Out Of Stock Items

Description

取得訂單缺貨商品。

Resource

GET /v1/order/out_of_stock/{order_id}

Authorization

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

Path Parameters

Name Type Description
order_id string 訂單編號

Query Parameters

Name Type Description
store_id string 門市代碼

Response

{
  "items": [
    {
      "id": "PS00000001",
      "title": "招牌鍋貼",
      "serial_number": 1,
      "quantity": 1,
      "special_instructions": null,
      "price": {
        "unit_price": {
          "amount": 5.5,
          "currency_code": "TWD",
          "formatted_amount": "5.5",
          "discount": 0
        },
        "total_price": {
          "amount": 5.5,
          "currency_code": "TWD",
          "formatted_amount": "5.5",
          "discount": 0
        }
      },
      "selected_modifier_groups": [],
      "ticket_no": null,
      "redeem_point": 0,
      "is_hidden": false,
      "combo_id": "1",
      "is_combo": true,
      "is_combo_item": false,
      "fresh": {
        "is_fresh": true,
        "weight": 25
      }
    }
  ]
}

Response Body Parameters - Item

Name Type Description
id string 編號
title string 名稱
serial_number int 序號
quantity int 缺貨數量
special_instructions string 特殊要求
(optional)
price ItemPrice 售價
selected_modifier_groups ModifierGroup[] 可選群組
(optional)
ticket_no string 票卷號碼
(optional)
redeem_point int 兌換點數
is_hidden boolean 是否隱藏商品
combo_id string 套餐編號
is_combo boolean 是否為套餐
is_combo_item boolean 是否為套餐子項目
image string 圖檔或圖片URL
fresh Fresh 生鮮資訊
(optional)

Response Body Parameters - ItemPrice

Name Type Description
unit_price Money 單價
total_price Money 合計售價

Response Body Parameters - ModifierGroup

Name Type Description
id string 編號
title string 名稱
selected_items Item[] 被選擇的品項
removed_items Item[] 沒被選擇的品項

Response Body Parameters - Fresh

Name Type Description
is_fresh bool 是否為生鮮商品
weight float 生鮮重量