スタンプ特典利用

このAPIは、顧客がすべてのスタンプを集め、特典(例:無料ドリンク、割引など)を利用した後に、そのスタンプを「使用完了」状態に変更します。

特典を使用するとそのスタンプは再利用できず、顧客は新しいスタンプを発行する必要があります。
来店・購入履歴に応じてスタンプを蓄積し、特典を処理するシステムで利用されます。

このAPIはパーソナルプラン以上でご利用いただけます。

PUT

/api/stamp/v1/redeem

{
    "stampIdx": 394,
    "onsitePwd": "12345"
}

Request Parameters

stampIdxintegerrequired
スタンプIDX。
onsitePwdstring
店舗で使用する従業員認証用パスワードです。
スタンプが onsiteYn = Y に設定されている場合のみ必須項目となり、
従業員が特典利用(例:無料ドリンク交換など)を承認する際に入力します。
入力時は Validate API で返される onsitePwd の値を参照してください。
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
応答コード: 0 = 成功、それ以外の値 = エラー
messagestring
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
resultnull