Send Ticket
Description
配發票劵,有兩種應用方式:
1.SendData中不要帶入quantity,將於收到request之後立刻response http state code 204,並於配發票劵完成後WEBHOOK通知event ticket.complete。(一次最多可配發1000筆)
2.SendData中帶入quantity,將於票券配發完成後才回應response http state code 204。(為避免久候建議配發票券總數量為20張以下)
Resource
POST /v2/ticket/send
Authorization
採用 OAuth 2.0 Bearer Token,詳細使用流程請參考 Auth Login。
Request Body Parameters
| Name | Type | Description |
|---|---|---|
| id | string | 任務編號,不可重複(若需要銷毀票券時會以此任務編號進行) |
| send_data | SendData | 配送資訊 |
| quantity | int | 配發的票券總數量 |
Request Body Parameters - SendData
| Name | Type | Description |
|---|---|---|
| ticket_no | string | 活動票劵編號 |
| vip_id_list | List[string] | 會員編號列表 |
| quantity | int | 配送票券張數 (option) |
Request Example
{
"id": "A0001",
"send_data": [
{
"ticket_no": "12",
"vip_id_list": [
"APP000000001",
"APP000000002"
],
"quantity": 2
},
{
"ticket_no": "13",
"vip_id_list": [
"APP000000001",
"APP000000002",
"APP000000003"
],
"quantity": 1
}
],
"quantity": 7
}
Response
Status-Code: 204 No Content (全部票券配送成功)
Status-Code:400 (部分票券配送失敗)
{
"send_successful_data": [
{
"ticket_no": "13",
"vip_id_list": [
"APP000000001",
"APP000000002",
"APP000000003"
],
"quantity": 1
}
],
"send_failed_data": [
{
"quantity": 2,
"ticket_no": "12",
"vip_id_list": [
"APP000000001",
"APP000000002"
]
}
]
}
Response Body Parameters
| Name | Type | Description |
|---|---|---|
| send_successful_data | SendData | 配送成功票劵列表 |
| send_failed_data | SendData | 配送失敗票劵列表 |