Get Shop Orders

Description

取得店長APP訂單列表。

Resource

GET /v1/shop_order

Authorization

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

Request Body Parameters

Name	Type	Description
store_id	string	門市編號
order_status	string (enum)	訂單狀態 ALLOWED VALUES: CREATED COMPLETED CANCELED (optional)
start_date	string	開始日期 EXAMPLE "2020-01-01" (optional)
end_date	string	結束日期 EXAMPLE "2020-01-01" (optional)
machine_id	string	機台編號 (optional)
shift_id	string	班別代號 ALLOWED VALUES: ALL NO_SHIFT 班別代號
keyword	string	關鍵字 (optional)

Request

GET /v1/shop_order?store_id=A01&order_status=CREATED&start_date=2021-08-01&end_date=2021-08-01&machine_id=1

Response Body Parameters

Name	Type	Description
id	string	訂單編號
company_name	string	公司名稱
order_date	string	交易日期 EXAMPLE "2020-01-01 12:00:00"
store	Info	門市資訊
shift	Info	班別資訊
machine_id	string	機台編號
charges	Charges	費用
order_status	string (enum)	訂單狀態 ALLOWED VALUES: CREATED COMPLETED CANCELED
payment_status	string (enum)	付款狀態 ALLOWED VALUES: UNPAID PAID CANCELED

Response Body Parameters - Info

Name	Type	Description
id	string	代碼
name	string	名稱

Response Body Parameters - Charges

Name	Type	Description
product_amount	integer	商品加油金額
discount_amount	integer	折扣金額
total_amount	integer	總金額

Response

{
  "orders": [
    {
      "id": "00003021080300966",
      "company_name": "測試公司",
      "order_date": "2021-08-03 12:00:00",
      "store": {
        "id": "A01",
        "name": "台南店"
      },
      "shift": {
        "id": "1",
        "name": "早班"
      },
      "machine_id": "1",
      "charges": {
        "product_amount": 1000,
        "discount_amount": 0,
        "total_amount": 1000
      },
      "order_status": "COMPLETED",
      "payment_status": "PAID"
    },
    {
      "id": "00003021080300974",
      "company_name": "測試公司",
      "order_date": "2021-08-03 18:00:00",
      "store": {
        "id": "A01",
        "name": "台南店"
      },
      "shift": {
        "id": "3",
        "name": "晚班"
      },
      "machine_id": "1",
      "charges": {
        "product_amount": 580,
        "discount_amount": 0,
        "total_amount": 580
      },
      "order_status": "COMPLETED",
      "payment_status": "UNPAID"
    }
  ]
}