Skip to content

Ready For Pickup Orders

Description

取得會員的待取貨訂單列表。

Resource

GET /v1/orders

Authorization

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

Query Parameters

Name Type Description
status string 訂單狀態

Response

{
  "orders": [
    {
      "id": "STORE2005010001",
      "current_state": "Ready For Pickup",
      "create_at": "2020-05-01T22:25:49Z",
      "store": {
        "id": "A01",
        "name": "台南店"
      },
      "payments": [
        {
          "type": "CASH",
          "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"
            }
          }
        }
      ]
    },
    {
      "id": "STORE2005020001",
      "current_state": "Ready For Pickup",
      "create_at": "2020-05-02T19:25:49Z",
      "store": {
        "id": "A01",
        "name": "台南店"
      },
      "payments": [
        {
          "type": "CASH",
          "charges": {
            "total": {
              "amount": 888,
              "currency_code": "TWD",
              "formatted_amount": "888"
            },
            "sub_total": {
              "amount": 888,
              "currency_code": "TWD",
              "formatted_amount": "888"
            },
            "discount": {
              "amount": 100,
              "currency_code": "TWD",
              "formatted_amount": "100"
            },
            "total_fee": {
              "amount": 788,
              "currency_code": "TWD",
              "formatted_amount": "788"
            }
          }
        }
      ]
    }
  ]
}

Response Body Parameters

Name Type Description
id string 訂單編號
current_state string 訂單狀態
create_at string 訂單建立時間
store Store 門市資訊
payments Payment[] 付款資訊

Response Body Parameters - Store

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

Response Body Parameters - Payment

Name Type Description
type string 付款方式
ALLOWED VALUES:
  • LINE_PAY
  • PI_PAY
  • CREDIT_CARD
  • EASY_CARD
  • CASH
charges Charges 費用

Response Body Parameters - Charges

Name Type Description
total Money 整張訂單總金額
sub_total Money 所有品項總金額
discount Money 折扣金額
total_fee Money 實際付款金額

Response Body Parameters - Money

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