API to use coupon. This api can be called together with before confirm transaction. However the sequence of api calls may be different based on integration flow requirement.
Method :
/api/v1/store/use-coupons| Aura tab collection |
|---|
| params | eyJ0YWIiOjEsInNldHRpbmdzIjoie1wiZ2VuZXJhbFNldHRpbmdzXCI6e1widGFiU3BhY2luZ1wiOjAsXCJ0YWJXaWR0aFwiOjEwMCxcInRhYkhlaWdodFwiOjQ1LFwiZGlyZWN0aW9uXCI6XCJob3Jpem9udGFsXCJ9LFwiYWN0aXZlU2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiIzI2ODRmZmI4XCJ9LFwidGV4dFwiOntcImZvbnRTaXplXCI6MTYsXCJjb2xvclwiOlwiI2ZmZmZmZlwiLFwidGV4dEFsaWduXCI6XCJsZWZ0XCIsXCJmb250V2VpZ2h0XCI6XCJib2xkXCJ9fSxcImluYWN0aXZlU2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiI2ZmZmZmZlwifSxcInRleHRcIjp7XCJmb250U2l6ZVwiOjE2LFwiY29sb3JcIjpcIiM1ZTZjODRcIixcInRleHRBbGlnblwiOlwibGVmdFwiLFwiZm9udFdlaWdodFwiOlwibGlnaHRlclwifX0sXCJjb250ZW50U2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiI2ZmZlwifSxcInBhZGRpbmdcIjp7XCJ0b3BcIjoxMCxcInJpZ2h0XCI6MTAsXCJib3R0b21cIjoxMCxcImxlZnRcIjoxMH0sXCJib3JkZXJcIjp7XCJzdHlsZVwiOlwic29saWRcIixcIndpZHRoXCI6MixcInRvcFwiOnRydWUsXCJib3R0b21cIjp0cnVlLFwibGVmdFwiOnRydWUsXCJyaWdodFwiOnRydWUsXCJjb2xvclwiOlwiI2Y0ZjVmN1wifX0sXCJob3ZlclNldHRpbmdzXCI6e1wiYmFja2dyb3VuZENvbG9yXCI6e1wiY29sb3JcIjpcIiNmNGY1ZjdcIn0sXCJ0ZXh0XCI6e1wiZm9udFNpemVcIjoxNixcImNvbG9yXCI6XCIjNWU2Yzg0XCIsXCJ0ZXh0QWxpZ25cIjpcImxlZnRcIixcImZvbnRXZWlnaHRcIjpcImJvbGRcIn19fSJ9 |
|---|
|
| Aura tab |
|---|
| params | eyJ0aXRsZSI6IlJlcXVlc3QgIn0= |
|---|
|
Param | Required | Type | Default Value & Description |
|---|
apiId | Y | string | | apiKey | Y | string | | authenticationType | Y | Enum | Sys2Sys integration value must be 1 → i.e. POS, ERP For client system integration value must be 2 → Customer portal
| sessionId | Y | string | To get session id refer to → Authenticate | voucherText | Y | string | coupon text can be fetch from QR code that has been send to customer by email or sms |
| Aura tab |
|---|
| params | eyJ0aXRsZSI6IkV4YW1wbGUgUmVxIn0= |
|---|
|
| Code Block |
|---|
{
"apiId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb",
"apiKey": "K96fWH1zjZrI7tt1rBTEgP06Zs0laaMEW5f6h1Jmk1YgYwPMdbB865LxTvrwm+IJ",
"authenticationType": 1,
"sessionId": "7GSZN6LWCB9L1V2SVGL5S5A7UZ12NKBM6GZII0ILI3NBU56XAG",
"voucherText": "{\"MB\":\"7NUKP/oFYgdUX4c+uvqS2w==\",\"CD\":\"RjcMy9+g0pZ7aWh4E+Ls8g==\",\"FreeText\":null}"
} |
| Aura tab |
|---|
| params | eyJ0aXRsZSI6IlJlc3BvbnNlIn0= |
|---|
|
true → Coupon updated as used , other than true relevant 500 code will be returned
Failed example 1 | Code Block |
|---|
{
"ErrorCode": 77,
"Message": "Member has used this voucher."
} |
Failed Example 2 | Code Block |
|---|
{
"ErrorCode": 66,
"Message": "Invalid voucher code"
} |
| Aura tab |
|---|
| params | eyJ0aXRsZSI6IkV4YW1wbGUgUmVzcCJ9 |
|---|
|
|