Skip to content

Get Group Order List

Description

取得特定團購主訂單下的所有參與者訂單列表(包含團主訂單本身)。

Resource

GET /v1/order/group/{group_order_id}

Authorization

採用 OAuth 2.0 Bearer Token。

Path Parameters

Name Type Description
group_order_id string 團主訂單編號

Query Parameters

Name Type Description
store_id string 門市編號

Request

GET /v1/order/group/2401010001

Response

{
    "orders": [
        {
            "current_state": "CREATED",
            "order_type": "ONLINE",
            "paid": false,
            "placed_at": "2026-01-21 15:21:34",
            "pickup_at": "2026-01-21 15:51:34",
            "type": "DINE_IN",
            "type_name": "內用",
            "machine_id": "",
            "store": {
                "id": "000030",
                "name": "台北訓練機"
            },
            "customer": {
                "name": "簡阿銜",
                "mobile": "",
                "address": ""
            },
            "purchaser": {
                "name": null,
                "mobile": null
            },
            "payments": [
                {
                    "type": "CASH",
                    "name": "臨櫃結帳",
                    "payment_amount": 100,
                    "transaction_id": null,
                    "paid": false
                }
            ],
            "charges": {
                "total": {
                    "amount": 100,
                    "currency_code": "TWD",
                    "formatted_amount": "100"
                },
                "sub_total": {
                    "amount": 100,
                    "currency_code": "TWD",
                    "formatted_amount": "100"
                },
                "discount": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "total_discharge": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "total_fee": {
                    "amount": 100,
                    "currency_code": "TWD",
                    "formatted_amount": "100"
                },
                "total_extra": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "sale_event_coupon": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "points": {
                    "before_transaction": 0,
                    "add": 10,
                    "after_transaction": 10,
                    "exchange_amount": 0,
                    "use": 0
                }
            },
            "cart": {
                "items": [
                    {
                        "type": "GENERAL_PRODUCT",
                        "id": "UC00000008",
                        "title": "單點炸排骨-D",
                        "translate_title": "",
                        "english_title": "",
                        "second_title": "",
                        "translate_second_title": "",
                        "english_second_title": "",
                        "abbreviated_title": "(單)炸排D",
                        "translate_abbreviated_title": "",
                        "english_abbreviated_title": "",
                        "serial_number": 1,
                        "quantity": 1,
                        "unit": "PCS",
                        "special_instructions": "",
                        "price": {
                            "unit_price": {
                                "amount": 100,
                                "currency_code": "TWD",
                                "formatted_amount": "100",
                                "discount": 0
                            },
                            "total_price": {
                                "amount": 100,
                                "currency_code": "TWD",
                                "formatted_amount": "100",
                                "discount": 0
                            }
                        },
                        "selected_modifier_groups": [],
                        "ticket_no": null,
                        "redeem_point": 0,
                        "is_hidden": false,
                        "external_id": "",
                        "prod_external_data": null,
                        "taste_memo": "",
                        "show_certificate": false,
                        "image": "",
                        "unique_code": "1768979628268-129654692",
                        "prom_calctype": false,
                        "is_limited": false,
                        "combo_no": null,
                        "ai_recommend": false,
                        "is_fare": false,
                        "combo_id": "",
                        "is_combo": false,
                        "is_combo_item": false,
                        "pack_id": "",
                        "is_pack": false,
                        "is_pack_item": false,
                        "pack_suit_id": null,
                        "price_specs": null
                    }
                ]
            },
            "receipt": {
                "random_number": "",
                "AESKey": "DE92AE7B79AE53D56B32F89D8B57C587",
                "title": "QA",
                "gui_number": "24436074",
                "begin_ym": "",
                "end_ym": "",
                "type": "ELECTRONIC",
                "tax_ID_number": "",
                "npoban": "",
                "carrier_type": "",
                "carrier": "",
                "receipt_number": null,
                "use_member_carrier": false
            },
            "special_instructions": "",
            "display_id": null,
            "table_number": "",
            "client_device": "PWA",
            "client_device_name": "PWA",
            "source_id": "00003026012100048",
            "external_store_id": null,
            "ticket_info": {},
            "return_reason": "",
            "person_count": {},
            "open_table": false,
            "pickup_method": {
                "id": "0",
                "name": "自取"
            },
            "is_sync_to_pos": false,
            "tracking_status": null,
            "credential_info": null,
            "promotion_activity_info": {
                "id": null,
                "name": null,
                "discount_type": null,
                "discount_rate": null,
                "discount_amount": null,
                "description": null
            },
            "status_code": "0",
            "delivery_list": [],
            "id": "00003026012100048",
            "is_host": true
        },
        {
            "current_state": "CREATED",
            "order_type": "ONLINE",
            "paid": false,
            "placed_at": "2026-01-21 15:13:39",
            "pickup_at": "2026-01-21 15:43:39",
            "type": "PICK_UP",
            "type_name": "外帶",
            "machine_id": "",
            "store": {
                "id": "000030",
                "name": "台北訓練機"
            },
            "customer": {
                "name": "簡阿銜",
                "mobile": "",
                "address": ""
            },
            "purchaser": {
                "name": null,
                "mobile": null
            },
            "payments": [
                {
                    "type": "CASH",
                    "name": "臨櫃結帳",
                    "payment_amount": 100,
                    "transaction_id": null,
                    "paid": false
                }
            ],
            "charges": {
                "total": {
                    "amount": 100,
                    "currency_code": "TWD",
                    "formatted_amount": "100"
                },
                "sub_total": {
                    "amount": 100,
                    "currency_code": "TWD",
                    "formatted_amount": "100"
                },
                "discount": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "total_discharge": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "total_fee": {
                    "amount": 100,
                    "currency_code": "TWD",
                    "formatted_amount": "100"
                },
                "total_extra": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "sale_event_coupon": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                },
                "points": {
                    "before_transaction": 0,
                    "add": 10,
                    "after_transaction": 10,
                    "exchange_amount": 0,
                    "use": 0
                }
            },
            "cart": {
                "items": [
                    {
                        "type": "GENERAL_PRODUCT",
                        "id": "UC00000008",
                        "title": "單點炸排骨-D",
                        "translate_title": "",
                        "english_title": "",
                        "second_title": "",
                        "translate_second_title": "",
                        "english_second_title": "",
                        "abbreviated_title": "(單)炸排D",
                        "translate_abbreviated_title": "",
                        "english_abbreviated_title": "",
                        "serial_number": 1,
                        "quantity": 1,
                        "unit": "PCS",
                        "special_instructions": "",
                        "price": {
                            "unit_price": {
                                "amount": 100,
                                "currency_code": "TWD",
                                "formatted_amount": "100",
                                "discount": 0
                            },
                            "total_price": {
                                "amount": 100,
                                "currency_code": "TWD",
                                "formatted_amount": "100",
                                "discount": 0
                            }
                        },
                        "selected_modifier_groups": [],
                        "ticket_no": null,
                        "redeem_point": 0,
                        "is_hidden": false,
                        "external_id": "",
                        "prod_external_data": null,
                        "taste_memo": "",
                        "show_certificate": false,
                        "image": "",
                        "unique_code": "1768979619707-670352323",
                        "prom_calctype": false,
                        "is_limited": false,
                        "combo_no": null,
                        "ai_recommend": false,
                        "is_fare": false,
                        "combo_id": "",
                        "is_combo": false,
                        "is_combo_item": false,
                        "pack_id": "",
                        "is_pack": false,
                        "is_pack_item": false,
                        "pack_suit_id": null,
                        "price_specs": null
                    }
                ]
            },
            "receipt": {
                "random_number": "",
                "AESKey": "DE92AE7B79AE53D56B32F89D8B57C587",
                "title": "QA",
                "gui_number": "24436074",
                "begin_ym": "",
                "end_ym": "",
                "type": "ELECTRONIC",
                "tax_ID_number": "",
                "npoban": "",
                "carrier_type": "",
                "carrier": "",
                "receipt_number": null,
                "use_member_carrier": false
            },
            "special_instructions": "",
            "display_id": null,
            "table_number": "",
            "client_device": "PWA",
            "client_device_name": "PWA",
            "source_id": "00003026012100049",
            "external_store_id": null,
            "ticket_info": {},
            "return_reason": "",
            "person_count": {},
            "open_table": false,
            "pickup_method": {
                "id": "0",
                "name": "自取"
            },
            "is_sync_to_pos": false,
            "tracking_status": null,
            "credential_info": null,
            "promotion_activity_info": {
                "id": null,
                "name": null,
                "discount_type": null,
                "discount_rate": null,
                "discount_amount": null,
                "description": null
            },
            "status_code": "0",
            "delivery_list": [],
            "id": "00003026012100049",
            "is_host": false
        }
    ]
}

Response Body Parameters

Name Type Description
orders array 訂單列表

Response Body Parameters - Order

Name Type Description
id string 訂單編號
current_state string 訂單狀態代碼
order_type string 訂單類型 (ONLINE/OFFLINE)
type string 用餐類型代碼 (DINE_IN/PICK_UP/DELIVERY)
type_name string 用餐類型名稱
is_host bool 是否為團主
paid bool 是否已付款
placed_at string 下單時間
pickup_at string 取餐時間
store Store 門市資訊
customer Customer 訂購人資訊
purchaser Customer 購買人資訊
receipt Receipt 發票資訊
payments Payment[] 付款資訊
charges Charges 費用
cart Cart 購物車資訊
machine_id string 機號
special_instructions string 備註
display_id string 叫號編號
table_number string 桌號
client_device string 點餐裝置代碼
client_device_name string 點餐裝置名稱
source_id string 來源編號
external_store_id string 外部門市編號
ticket_info object 票券資訊
return_reason string 退貨原因
person_count object 人數資訊
open_table bool 是否開桌
pickup_method object 取餐方式 (id, name)
is_sync_to_pos bool 是否同步至 POS
tracking_status string 追蹤狀態
credential_info object 憑證資訊
promotion_activity_info object 促銷活動資訊
status_code string 狀態碼
delivery_list array 外送列表

Response Body Parameters - Store

Name Type Description
id string 門市代碼
name string 門市名稱

Response Body Parameters - Customer

Name Type Description
name string 姓名
mobile string 手機號碼
address string 地址

Response Body Parameters - Receipt

Name Type Description
type string
(enum)
發票類型
ALLOWED VALUES:
  • PAPER
  • ELECTRONIC
tax_ID_number string 買方統一編號
npoban string 捐贈碼
carrier_type string 買方載具類別
carrier string 買方載具
receipt_number string 發票號碼

Response Body Parameters - Payment

Name Type Description
type Payment Type 付款方式
name Payment Name 付款名稱
payment_amount integer 支付金額
transaction_id string 交易代碼

Response Body Parameters - Payment Instruction

type name
LINE_PAY LINE Pay
PI_PAY Pi Pay
CREDIT_CARD 信用卡
EASY_CARD 悠遊卡
CASH 臨櫃結帳
MWD_PAY 麥味登Pay
Easy_Wallet 悠遊付
APPLE_PAY Apple Pay
GOOGLE_PAY Google Pay
CASH_TICKET 禮券
POINT_DISCOUNT_AMOUNT 點數折抵金額
NCCC_EASY_CARD NCCC悠遊卡
NCCC_IPASS NCCC一卡通
NCCC_ICASH NCCC iCash
NCCC_HAPPY_CASH NCCC有錢卡
CASH_CAR 現金
CHARGE_CARD 簽帳
MOTORCADE 車隊
CREDIT_CARD_CAR 信用卡
CTBC_CARD 中信卡
BARCODE_PAY 條碼支付
TAIWAN_PAY 台灣 Pay
TK01 門票折抵
HAO_SPEED 全家外送自取
EC EC
PX_PAY 全支付
HSA_EXTRA 異質POS
NEWEB_PAY 藍新金流
I_CASH_PAY 愛金卡支付
DD_PAY 信用卡(DD_PAY)

Response Body Parameters - Charges

Name Type Description
total Money 整張訂單總金額
sub_total Money 所有品項總金額
discount Money 折扣金額
total_fee Money 實際付款金額
total_extra Money 總溢收金額
admission_tickets Money 門票總金額
(optional)
courses Money 課程總金額
(optional)
sale_event_coupon Money 抵用券金額
points Point 訂單點數使用明細
只有訂單狀態為CREATED,且有使用點數時回傳
(optional)

Response Body Parameters - Cart

Name Type Description
items Item[] 品項資料

Response Body Parameters - Item

Name Type Description
type string
(enum)
商品類型
ALLOWED VALUES:
  • GENERAL_PRODUCT
  • COURSE
  • ADMISSION_TICKET
id string 編號
title string 商品第一名稱
translate_title string 翻譯名稱
second_title string 商品第二名稱
translate_second_title string 商品第二翻譯名稱
abbreviated_title string 商品簡稱
translate_abbreviated_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 是否隱藏商品
allocated_quantity int 已分配數量
(optional)
remaining_quantity int 剩餘數量
(optional)
verified_quantity int 已入園數量
(optional)
unverified_quantity int 未入園數量
(optional)
combo_id string 套餐編號
is_combo boolean 是否為套餐
is_combo_item boolean 是否為套餐子項目
pack_id string 系列組合編號
is_pack boolean 是否為系列組合
is_pack_item boolean 是否為系列組合子項目
image string 圖檔或圖片URL
external_id string 外部商品編號
(optional)
unique_code string 訂單唯一碼
pack_suit_id string 系列組合編號
(optional)
is_limited boolean 是否為限量商品
combo_no string 套餐序號
ai_recommend boolean 是否為ai推薦
is_fare boolean 是否為運費

Response Body Parameters - ItemPrice

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

Response Body Parameters - ModifierGroup

Name Type Description
id string 編號
title string 名稱
translate_title string 翻譯名稱
selected_items Item[] 被選擇的品項
removed_items Item[] 沒被選擇的品項
combo_taste bool 是否為套餐加值
(optional)

Response Body Parameters - Money

Name Type Description
amount float 最小單位金額
discount float 折價金額
currency_code string 貨幣代碼 ISO 4217 code
formatted_amount string 顯示用金額

Response Body Parameters - Point

Name Type Description
before_transaction integer 本次交易前持有點數
exchange_amount integer 本次交易可折抵金額
after_transaction integer 本次交易後點數餘額
add integer 本次交易後新增點數
use integer 本次交易使用點數