Get Order Details

Description

取得訂單明細。

Resource

GET /v1/order/{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	門市代碼 (optional) 備註：LINE@訂單此項為必填
line_id	string	LINE UID (optional)
modified_user_id	string	異動人員編號 (optional)
language	string (enum)	語系 ALLOWED VALUES: TRADITIONAL_CHINESE: 繁體中文 JAPANESE: 日語 KOREAN: 韓語 ENGLISH: 英語 FRENCH: 法語 INDONESIAN: 印尼語 THAI: 泰語 VIETNAMESE: 越南語 SPANISH: 西班牙語 GERMAN: 德語 RUSSIAN: 俄語 (optional)

Request Example

GET /v1/order/A0121071500001?store_id=A01

Response Body Parameters

Name	Type	Description
current_state	string (enum)	訂單狀態 ALLOWED VALUES: CREATED ACCEPTED CANCELLED COMPLETED ERROR PICKED_UP
order_type	string	訂單類型 ALLOWED VALUES: ONLINE OFFLINE
paid	bool	是否已付款
placed_at	string	提交時間 ISO 8601 format EXAMPLE "2020-01-01T15:16:54.723Z"
pickup_at	string	取貨時間 ISO 8601 format EXAMPLE "2020-01-01T15:16:54.723Z"
type	string (enum)	銷售方式 ALLOWED VALUES: DINE_IN PICK_UP DELIVERY
machine_id	string	機號
store	Store	接單門市
customer	Customer	消費者資訊
purchaser	Purchaser	購買者資料
payments	Payment[]	付款資訊
charges	Charges	費用
service_charge	Service Charges	服務費
cart	Cart	購物車資訊
receipt	Receipt	發票資訊，發票組合詳細範例 (optional)
special_instructions	string	特殊要求 (optional)
display_id	string	取餐號 (optional)
table_number	string	桌號 (optional)
client_device	string (enum)	客戶端裝置 ALLOWED VALUES: APP KIOSK RETAIL 掃碼下單 掃碼下單後結 EC_STD EC_QUICK_ORDER EC_BUY_GOOD EC_8WAY EC_Just_Kitchen EC_HAO_SPEED EC_CTI 3SPOS CUSTOMER_TICKET TOUR_TICKET MPOS EC_Leezen HSA_EXTRA
source_id	string	外部訂單編號
admission_ticket	Admission Ticket	門票資訊 (optional)
tour	Tour	導覽資訊 (optional)
pickup_method	Pickup Method	取貨方式 (optional)
activity_message	string	活動訊息 (optional)
good_status	string (enum)	貨物狀態 ALLOWED VALUES: COLLECTION (撿貨中) STOCKED (已備貨) ARRIVED (已到貨) PICKED_UP (已取貨) (optional)
ticket_info	TicketInfo	優惠券資訊
return_reason	string	退貨原因 (optional)
open_table	bool	開桌狀態 (optional)
tracking_status	string	取餐狀態 ALLOWED VALUES: PENDING: 等待接單 ACCEPTED: 已接單 PREPARE: 準備中 CAN_PICK_UP: 可取餐 PICKED_UP: 取餐完畢 CANCELED: 已取消 (optional)
credential_info	Credential Info	憑證資訊 (optional)

Response Body Parameters - Store

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

Response Body Parameters - Customer

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

Response Body Parameters - Purchaser

Name	Type	Description
name	string	姓名 (optional)
mobile	string	手機號碼 (optional)

Response Body Parameters - Payment

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

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 - Service Charges

Name	Type	Description
amount	integer	最小單位金額
currency_code	string	貨幣代碼 ISO 4217 code
formatted_amount	string	顯示用金額
service_rate	integer	服務費倍率(%)

Response Body Parameters - Cart

Name	Type	Description
items	Item[]	品項資料

Response Body Parameters - Receipt

Name	Type	Description
type	string (enum)	發票類型 ALLOWED VALUES: PAPER ELECTRONIC
tax_ID_number	string	買方統一編號 (optional)
npoban	string	捐贈碼 (optional)
carrier_type	string	買方載具類別 (optional)
carrier	string	買方載具 (optional)
receipt_number	string	發票號碼 (optional)
random_number	string	隨機碼 (optional)
AESKey	string	AESKey (optional)
title	string	發票標題 (optional)
begin_ym	string	起始年月 (optional)
end_ym	string	結束年月 (optional)
gui_number	string	賣方統一編號 (optional)

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	商品第二名稱
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)
car	Car	汽車資訊 (optional)
course	Course	課程資訊 (optional)
show_certificate	boolean	是否出示證明文件
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	套餐序號

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	boolean	是否為套餐加值 (optional)

Response Body Parameters - Money

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

Response Body Parameters - Car

Name	Type	Description
id	string	車號
name	string	車名

Response Body Parameters - Course

Name	Type	Description
classroom_id	string	教室編號
classroom_name	string	教室名稱
class_time	string	上課時間 EXAMPLE "2020-01-01 12:00:00"

Response Body Parameters - Point

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

Response Body Parameters - Admission Ticket

Name	Type	Description
type	string (enum)	門票類型 ALLOWED VALUES: PAPER ELECTRONIC
verification_code	string	驗證碼
expected_admission_date	string	預計入園日期 EXAMPLE "2020-01-01 12:00:00"
actual_admission_date	string	實際入園日期 EXAMPLE "2020-01-01 12:00:00"
extended_expiration_date	string	系統展延有效日期 EXAMPLE "2020-01-01 12:00:00"

Response Body Parameters - Tour

Name	Type	Description
travel_agency_id	string	旅行社編號
travel_agency_name	string	旅行社名稱
guide_id	string	導遊編號
group_name	string	團體名稱
group_type_id	string	團體類別編號
group_type_name	string	團體類別名稱
need_tour	boolean	是否需要導覽
course_quantity	integer	課程數量

Response Body Parameters - Pickup Method

Name	Type	Description
id	string	取貨方式編號
name	string	取貨方式名稱

Response Body Parameters - Ticket Info

Name	Type	Description
product_tickets	Ticket[]	單品票券
order_tickets	Ticket[]	訂單票券

Response Body Parameters - Ticket

Name	Type	Description
name	string	票劵名稱
quantity	int	票劵數量
discount	float	折價金額
detail	Detail[]	票券明細

Response Body Parameters - Detail

Name	Type	Description
id	string	票劵編號
expired_date	string	票券效期
discount	float	折價金額

Response Body Parameters - Credential Info

Name	Type	Description
id	string	憑證編號
name	string	憑證名稱
discount_type	string (enum)	折扣類型 ALLOWED VALUES: DISCOUNT_PERCENTAGE: 折扣 FIXED_AMOUNT: 折價 (optional)
discount_rate	float	折扣率 (optional)
discount_amount	integer	折價金額 (optional)
description	boolean	憑證描述

General Order Response

{
  "current_state": "ACCEPTED",
  "order_type": "ONLINE",
  "placed_at": "2020-05-01T22:25:49Z",
  "pickup_at": "2020-05-01T22:25:49Z",
  "type": "DELIVERY",
  "machine_id": "k1",
  "store": {
    "id": "A01",
    "name": "台南店"
  },
  "customer": {
    "name": "王大明",
    "mobile": "0910123456",
    "address": "台南市安平區健康三街999號"
  },
  "payments": [
    {
      "type": "CASH",
      "name": "臨櫃結帳",
      "payment_amount": 1000,
      "transaction_id": "test"
    }
  ],
  "charges": {
    "total": {
      "amount": 1100,
      "currency_code": "TWD",
      "formatted_amount": "1100"
    },
    "sub_total": {
      "amount": 1100,
      "currency_code": "TWD",
      "formatted_amount": "1100"
    },
    "discount": {
      "amount": 100,
      "currency_code": "TWD",
      "formatted_amount": "100"
    },
    "total_fee": {
      "amount": 1000,
      "currency_code": "TWD",
      "formatted_amount": "1000"
    },
    "total_extra": {
      "amount": 0,
      "currency_code": "TWD",
      "formatted_amount": "0"
    },
    "points": {
      "before_transaction": 120,
      "exchange_amount": 10,
      "after_transaction": 21,
      "add": 1
    }
  },
  "service_charge": {
    "amount": 0,
    "currency_code": "TWD",
    "formatted_amount": "0",
    "service_rate": 0
  },
  "cart": {
    "items": [
      {
        "type": "GENERAL_PRODUCT",
        "id": "P001",
        "title": "番茄泡菜炒豆包",
        "second_title": "",
        "abbreviated_title": "",
        "serial_number": 1,
        "quantity": 2,
        "price": {
          "unit_price": {
            "amount": 40000,
            "currency_code": "TWD",
            "formatted_amount": "400"
          },
          "total_price": {
            "amount": 80000,
            "currency_code": "TWD",
            "formatted_amount": "800"
          }
        },
        "selected_modifier_groups": [
          {
            "id": "1",
            "title": "辣度",
            "selected_items": [
              {
                "id": "1-1",
                "title": "小辣",
                "quantity": 1,
                "price": {
                  "unit_price": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                  },
                  "total_price": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                  }
                },
                "selected_modifier_groups": null
              }
            ],
            "removed_items": null
          }
        ],
        "ticket_no": "",
        "redeem_point": 0,
        "is_hidden": false,
        "combo_id": "1",
        "is_combo": true,
        "is_combo_item": false,
        "pack_id": "",
        "is_pack": false,
        "is_pack_item": false
      },
      {
        "type": "GENERAL_PRODUCT",
        "id": "P002",
        "title": "紫蘇籽油腐乳炒飯",
        "second_title": "",
        "abbreviated_title": "",
        "serial_number": 5001,
        "special_instructions": "不要洋蔥",
        "quantity": 1,
        "price": {
          "unit_price": {
            "amount": 20000,
            "currency_code": "TWD",
            "formatted_amount": "200"
          },
          "total_price": {
            "amount": 20000,
            "currency_code": "TWD",
            "formatted_amount": "200"
          }
        },
        "selected_modifier_groups": [
          {
            "id": "2",
            "title": "加飯",
            "selected_items": [
              {
                "id": "2-1",
                "title": "白飯",
                "quantity": 1,
                "price": {
                  "unit_price": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                  },
                  "total_price": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                  }
                },
                "selected_modifier_groups": null
              }
            ],
            "removed_items": null
          },
          {
            "id": "3",
            "title": "加胡椒",
            "selected_items": [
              {
                "id": "3-1",
                "title": "胡椒",
                "quantity": 0,
                "price": {
                  "unit_price": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                  },
                  "total_price": {
                    "amount": 0,
                    "currency_code": "TWD",
                    "formatted_amount": "0"
                  }
                },
                "selected_modifier_groups": null
              }
            ],
            "removed_items": null
          }
        ],
        "ticket_no": "",
        "redeem_point": 0,
        "is_hidden": false,
        "combo_id": "2",
        "is_combo": true,
        "is_combo_item": false,
        "pack_id": "",
        "is_pack": false,
        "is_pack_item": false
      }
    ]
  },
  "receipt": {
    "type": "PAPER",
    "tax_ID_number": "24436074",
    "npoban": "",
    "carrier_type": "",
    "carrier": "",
    "receipt_number": "WE00011771",
    "random_number": "3931",
    "AESKey": "",
    "title": "",
    "begin_ym": "202007",
    "end_ym": "202008",
    "gui_number": "24916968"
  },
  "special_instructions": "訂單備註內容",
  "display_id": "k006",
  "table_number": "12",
  "client_device": "APP",
  "source_id": "MCSF0221051300006",
  "open_table": false,
  "pickup_method": {
    "id": "1",
    "name": "現場取貨"
  },
  "return_reason": "",
  "tracking_status": "ACCEPTED",
  "credential_info": {
      "id": "CX0001",
      "name": "員工證",
      "discount_type": "DISCOUNT_PERCENTAGE",
      "discount_rate": 0.9,
      "discount_amount": 0,
      "description": "員工證可以打九折"
    }
}

Admission Ticket Order Response

{
  "current_state": "ACCEPTED",
  "order_type": "ONLINE",
  "placed_at": "2021-10-02T22:25:49Z",
  "pickup_at": "2021-10-10T15:00:00Z",
  "type": "DELIVERY",
  "machine_id": "k1",
  "store": {
    "id": "A01",
    "name": "台南店"
  },
  "customer": {
    "name": "王大明",
    "mobile": "0910123456",
    "address": "台南市安平區健康三街999號"
  },
  "payments": [
    {
      "type": "LINE_PAY",
      "name": "LINE Pay",
      "payment_amount": 800
    }
  ],
  "charges": {
    "total": {
      "amount": 800,
      "currency_code": "TWD",
      "formatted_amount": "800"
    },
    "sub_total": {
      "amount": 800,
      "currency_code": "TWD",
      "formatted_amount": "800"
    },
    "discount": {
      "amount": 0,
      "currency_code": "TWD",
      "formatted_amount": "0"
    },
    "total_fee": {
      "amount": 800,
      "currency_code": "TWD",
      "formatted_amount": "800"
    },
    "total_extra": {
      "amount": 0,
      "currency_code": "TWD",
      "formatted_amount": "0"
    },
    "admission_tickets": {
      "amount": 800,
      "currency_code": "TWD",
      "formatted_amount": "800"
    },
    "courses": {
      "amount": 200,
      "currency_code": "TWD",
      "formatted_amount": "200"
    },
    "points": {
      "before_transaction": 20,
      "exchange_amount": 0,
      "after_transaction": 20,
      "add": 0
    }
  },
  "service_charge": {
    "amount": 0,
    "currency_code": "TWD",
    "formatted_amount": "0",
    "service_rate": 0
  },
  "cart": {
    "items": [
      {
        "type": "ADMISSION_TICKET",
        "id": "T01",
        "title": "全票",
        "second_title": "",
        "abbreviated_title": "",
        "serial_number": 1,
        "quantity": 2,
        "price": {
          "unit_price": {
            "amount": 300,
            "currency_code": "TWD",
            "formatted_amount": "300"
          },
          "total_price": {
            "amount": 600,
            "currency_code": "TWD",
            "formatted_amount": "600"
          }
        },
        "selected_modifier_groups": [],
        "ticket_no": "",
        "redeem_point": 0,
        "is_hidden": false,
        "allocated_quantity": 1,
        "remaining_quantity": 1,
        "verified_quantity": 0,
        "unverified_quantity": 2,
        "car": {
          "id": "1",
          "name": "A車"
        },
        "show_certificate": false
      },
      {
        "type": "ADMISSION_TICKET",
        "id": "T03",
        "title": "學生票",
        "second_title": "",
        "abbreviated_title": "",
        "serial_number": 2,
        "special_instructions": "",
        "quantity": 1,
        "price": {
          "unit_price": {
            "amount": 200,
            "currency_code": "TWD",
            "formatted_amount": "200"
          },
          "total_price": {
            "amount": 200,
            "currency_code": "TWD",
            "formatted_amount": "200"
          }
        },
        "selected_modifier_groups": [],
        "ticket_no": "",
        "redeem_point": 0,
        "is_hidden": false,
        "allocated_quantity": 1,
        "remaining_quantity": 0,
        "verified_quantity": 1,
        "unverified_quantity": 0,
        "car": {
          "id": "2",
          "name": "B車"
        },
        "show_certificate": true
      },
      {
        "type": "COURSE",
        "id": "P03",
        "title": "DIY體驗課程",
        "second_title": "",
        "abbreviated_title": "",
        "serial_number": 3,
        "special_instructions": "",
        "quantity": 2,
        "price": {
          "unit_price": {
            "amount": 100,
            "currency_code": "TWD",
            "formatted_amount": "100"
          },
          "total_price": {
            "amount": 200,
            "currency_code": "TWD",
            "formatted_amount": "200"
          }
        },
        "selected_modifier_groups": [],
        "ticket_no": "",
        "redeem_point": 0,
        "is_hidden": false,
        "course": {
          "classroom_id": "1",
          "classroom_name": "教室A",
          "class_time": "2021-10-03 16:00:00"
        },
        "show_certificate": false
      }
    ]
  },
  "receipt": {
    "type": "ELECTRONIC",
    "tax_ID_number": "24436074",
    "npoban": "",
    "carrier_type": "3J0002",
    "carrier": "/ABC+123",
    "receipt_number": "VB17566068",
    "random_number": "1963",
    "AESKey": "",
    "title": "",
    "begin_ym": "202007",
    "end_ym": "202008",
    "gui_number": "24916968"
  },
  "special_instructions": "訂單備註內容",
  "display_id": "",
  "table_number": "",
  "client_device": "APP",
  "source_id": "MCSF0221051300006",
  "open_table": false,
  "admission_ticket": {
    "type": "ELECTRONIC",
    "verification_code": "134679",
    "expected_admission_date": "2021-10-10 15:00:00",
    "actual_admission_date": "2021-10-10 15:00:00",
    "extended_expiration_date": null
  },
  "tour": {
    "travel_agency_id": "group_a",
    "travel_agency_name": "雄獅旅行社",
    "guide_id": "G001",
    "group_name": "ABC旅行團",
    "group_type_id": "A001",
    "group_type_name": "國內社客團",
    "need_tour": true,
    "course_quantity": 1
  },
  "good_status": "ARRIVED",
  "return_reason": ""
}

Response Body Parameters

Name	Type	Description
current_state	string (enum)	訂單狀態 ALLOWED VALUES: CREATED ACCEPTED CANCELLED COMPLETED ERROR PICKED_UP
order_type	string	訂單類型 ALLOWED VALUES: ONLINE OFFLINE
paid	bool	是否已付款
placed_at	string	提交時間 ISO 8601 format EXAMPLE "2020-01-01T15:16:54.723Z"
pickup_at	string	取貨時間 ISO 8601 format EXAMPLE "2020-01-01T15:16:54.723Z"
type	string (enum)	銷售方式 ALLOWED VALUES: DINE_IN PICK_UP DELIVERY
machine_id	string	機號
store	Store	接單門市
customer	Customer	消費者資訊
payments	Payment[]	付款資訊
charges	Charges	費用
service_charge	Service Charges	服務費
cart	Cart	購物車資訊
receipt	Receipt	發票資訊，發票組合詳細範例 (optional)
special_instructions	string	特殊要求 (optional)
display_id	string	取餐號 (optional)
table_number	string	桌號 (optional)
client_device	string (enum)	客戶端裝置 ALLOWED VALUES: APP KIOSK RETAIL 掃碼下單 掃碼下單後結 EC_STD EC_QUICK_ORDER EC_BUY_GOOD EC_8WAY EC_Just_Kitchen EC_HAO_SPEED EC_CTI 3SPOS CUSTOMER_TICKET TOUR_TICKET MPOS EC_Leezen HSA_EXTRA
source_id	string	外部訂單編號
admission_ticket	Admission Ticket	門票資訊 (optional)
tour	Tour	導覽資訊 (optional)
pickup_method	Pickup Method	取貨方式 (optional)
activity_message	string	活動訊息 (optional)
good_status	string (enum)	貨物狀態 ALLOWED VALUES: COLLECTION (撿貨中) STOCKED (已備貨) ARRIVED (已到貨) PICKED_UP (已取貨) (optional)
ticket_info	TicketInfo	優惠券資訊
return_reason	string	退貨原因 (optional)
open_table	bool	開桌狀態 (optional)

Response Body Parameters - Store

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

Response Body Parameters - Customer

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

Response Body Parameters - Payment

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

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 - Service Charges

Name	Type	Description
amount	integer	最小單位金額
currency_code	string	貨幣代碼 ISO 4217 code
formatted_amount	string	顯示用金額
service_rate	integer	服務費倍率(%)

Response Body Parameters - Cart

Name	Type	Description
items	Item[]	品項資料

Response Body Parameters - Receipt

Name	Type	Description
type	string (enum)	發票類型 ALLOWED VALUES: PAPER ELECTRONIC
tax_ID_number	string	買方統一編號 (optional)
npoban	string	捐贈碼 (optional)
carrier_type	string	買方載具類別 (optional)
carrier	string	買方載具 (optional)
receipt_number	string	發票號碼 (optional)
random_number	string	隨機碼 (optional)
AESKey	string	AESKey (optional)
title	string	發票標題 (optional)
begin_ym	string	起始年月 (optional)
end_ym	string	結束年月 (optional)
gui_number	string	賣方統一編號 (optional)

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	商品第二名稱
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)
car	Car	汽車資訊 (optional)
course	Course	課程資訊 (optional)
show_certificate	boolean	是否出示證明文件
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	套餐序號

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	boolean	是否為套餐加值 (optional)

Response Body Parameters - Money

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

Response Body Parameters - Car

Name	Type	Description
id	string	車號
name	string	車名

Response Body Parameters - Course

Name	Type	Description
classroom_id	string	教室編號
classroom_name	string	教室名稱
class_time	string	上課時間 EXAMPLE "2020-01-01 12:00:00"

Response Body Parameters - Point

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

Response Body Parameters - Admission Ticket

Name	Type	Description
type	string (enum)	門票類型 ALLOWED VALUES: PAPER ELECTRONIC
verification_code	string	驗證碼
expected_admission_date	string	預計入園日期 EXAMPLE "2020-01-01 12:00:00"
actual_admission_date	string	實際入園日期 EXAMPLE "2020-01-01 12:00:00"
extended_expiration_date	string	系統展延有效日期 EXAMPLE "2020-01-01 12:00:00"

Response Body Parameters - Tour

Name	Type	Description
travel_agency_id	string	旅行社編號
travel_agency_name	string	旅行社名稱
guide_id	string	導遊編號
group_name	string	團體名稱
group_type_id	string	團體類別編號
group_type_name	string	團體類別名稱
need_tour	boolean	是否需要導覽
course_quantity	integer	課程數量

Response Body Parameters - Pickup Method

Name	Type	Description
id	string	取貨方式編號
name	string	取貨方式名稱

Response Body Parameters - Ticket Info

Name	Type	Description
product_tickets	Ticket[]	單品票券
order_tickets	Ticket[]	訂單票券

Response Body Parameters - Ticket

Name	Type	Description
name	string	票劵名稱
quantity	int	票劵數量
discount	float	折價金額
detail	Detail[]	票券明細

Response Body Parameters - Detail

Name	Type	Description
id	string	票劵編號
expired_date	string	票券效期
discount	float	折價金額