Skip to content

Get Shop Order Details

Description

取得店長APP訂單明細。

Resource

GET /v1/shop_order/{order_id}

Authorization

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

Path Parameters

Name Type Description
order_id string 訂單編號

Request

GET /v1/shop_order/00003021080300966

Response Body Parameters

Name Type Description
id string 訂單編號
order_date string 交易日期
EXAMPLE "2020-01-01 12:00:00"
machine_id string 機號
order_status string
(enum)
訂單狀態
ALLOWED VALUES:
  • CREATED
  • COMPLETED
  • CANCELED
payment_status string
(enum)
付款狀態
ALLOWED VALUES:
  • UNPAID
  • PAID
  • CANCELED
last_update_time string 最後異動時間
EXAMPLE "2020-01-01 12:00:00"
company Info 公司資訊
store Info 門市資訊
operator Info 操作人員
modified_user Info 異動人員
shift Info 班別資訊
order_status_history OrderStatusHistory[] 訂單狀態歷程
charges Charges 費用
cart Cart 購物車資訊

Response Body Parameters - Info

Name Type Description
id string 代碼
name string 名稱

Response Body Parameters - OrderStatusHistory

Name Type Description
update_time string 異動時間
EXAMPLE "2020-01-01 12:00:00"
order_status string
(enum)
訂單狀態
ALLOWED VALUES:
  • CREATED
  • COMPLETED
  • CANCELED
payment_status string
(enum)
付款狀態
ALLOWED VALUES:
  • UNPAID
  • PAID
  • CANCELED

Response Body Parameters - Charges

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

Response Body Parameters - Cart

Name Type Description
items Item[] 品項資料

Response Body Parameters - Item

Name Type Description
id string 商品編號
title string 商品名稱
serial_number integer 序號
quantity integer 數量
price ItemPrice 售價
ticket_no_list list 票卷號碼列表
categories Category[] 商品類別

Response Body Parameters - ItemPrice

Name Type Description
unit_price integer 單價
discount integer 折價
total_price integer 合計售價

Response Body Parameters - Category

Name Type Description
id string 分類編號
title string 分類名稱

Response

{
  "id": "00003021080300966",
  "order_date": "2021-08-24 14:18:30",
  "machine_id": "02",
  "order_status": "CREATED",
  "payment_status": "UNPAID",
  "last_update_time": "2021-08-24 14:18:30",
  "company": {
    "id": "0123456789",
    "name": "車容坊"
  },
  "store": {
    "id": "A01",
    "name": "台南店"
  },
  "operator": {
    "id": "1234",
    "name": "李小鐵"
  },
  "modified_user": {
    "id": "1234",
    "name": "李小鐵"
  },
  "shift": {
    "id": "1",
    "name": "早班"
  },
  "order_status_history": [
    {
      "update_time": "2021-08-24 14:18:30",
      "order_status": "CREATED",
      "payment_status": "UNPAID"
    }
  ],
  "charges": {
    "product_amount": 1000,
    "discount_amount": 0,
    "total_amount": 1000
  },
  "cart": {
    "items": [
      {
        "id": "Z10002",
        "title": "雨刷16吋",
        "serial_number": 1,
        "quantity": 1,
        "price": {
          "unit_price": 600,
          "discount": 0,
          "total_price": 600
        },
        "ticket_no_list": [],
        "categories": [
          {
            "id": "281",
            "title": "雨刷"
          }
        ]
      },
      {
        "id": "ZMJ0001",
        "title": "折價券",
        "serial_number": 2,
        "quantity": 100,
        "price": {
          "unit_price": -1,
          "discount": 0,
          "total_price": -100
        },
        "ticket_no_list": [
          "AA0001",
          "AA0002"
        ],
        "categories": []
      }
    ]
  }
}