Skip to content

Sync Transaction Value Added Data

Description

同步交易加值資料。

NEW POS 交易結束後,會來呼叫此 API 將會員該筆交易的加值資料(點數、集章、儲值) 同步到 WISE,進行核銷或返還。

Resource

POST /v1/order/sync_transaction_value_added_data

Authorization

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

Request Body Parameters

Name Type Description
store_id string 門市編號
input_date string 交易日期,格式範例: 2024-05-16 17:29:11
id string 交易編號
sale_type string
(enum)
交易類型
ALLOWED VALUES:
  • SALE: 銷售
  • SALE_RETURN: 銷退
returned_id string 被退貨單號
(optional)
modified_user_id string 異動人員編號
vip_id string 會員編號
(optional)
type string
(enum)
傳送類型
ALLOWED VALUES:
  • IMMEDIATE: 即時
  • RETRY: 補傳
points Point[] 點數資料
(optional)

Request Body Parameters - Point

Name Type Description
type string 點數異動類型
ALLOWED VALUES:
  • NEW_CONSUMPTION: 消費新增
  • SALES_RETURN_REDUCTION: 銷退返還
  • EXCHANGE: 點數兌換
  • EXCHANGE_SELL_BACK: 點數兌換銷退
  • TRANSFER_OUT: 點數轉出
  • TRANSFER_IN: 點數轉入
  • ACTIVITY_DEDUCTION_POINTS: 活動扣點
  • ACTIVITY_ACCUMULATED_POINTS: 活動累點
  • ZERO: 點數歸零
point integer 點數
create_date string 建立日期,格式範例: 2024-05-16 17:29:11
create_user string 建立人員編號

Request

{
  "store_id": "000030",
  "input_date": "2020-01-01 20:00:00",
  "id": "0000302024051500001",
  "sale_type": "SALE",
  "modified_user_id":"admin",
  "vip_id": "VIP007",
  "type": "IMMEDIATE",
  "points": [
    {
      "type": "NEW_CONSUMPTION",
      "point": 20,
      "create_date": "2020-01-01 20:00:00",
      "create_user": "admin123"
    },
    {
      "type": "EXCHANGE",
      "point": 72,
      "create_date": "2020-01-01 20:00:00",
      "create_user": "admin123"
    }
  ]
}

Response Body Parameters

Name Type Description
vip_id string 會員編號
vip_group_id string 會員群組編號
vip_group_name string 會員群組名稱
points integer 會員持有點數

Response

Status-Code: 200 OK

{
  "vip_id": "VIP007",
  "vip_group_id": "A",
  "vip_group_name": "A級會員",
  "points": 998
}

Response

Status-Code: 400 Bad Request

{
  "code": "VipAppService 回傳的錯誤代碼",
  "message": "VipAppService 回傳的錯誤訊息"
}