Skip to main content

Can Use Voucher Now

Retrieve voucher info and whether the member can use it now

Request​

GET:/{integrationId}/voucher/canusenow

Request Parameters​

ParameterDescriptionTypeRemark
memberIdThe Id of member record.numberrequired
voucherNoThe voucher record number.stringrequired
spendingAmountAmount spent on the transaction. Return records that matches the spending requirement.numberSet it to null if want to ignore checking the minimum spending requirement.

Example of Request URL:

Parameters:
memberId = 1
voucherNo = 00001-00001-000001
spendingAmount = 100
integrationId = d9cdb75e-da7c-43dc-8dee-7d786b464c59

URL:
GET: https://onerewards-integration-api.autocountcloud.com/d9cdb75e-da7c-43dc-8dee-7d786b464c59/voucher/canusenow?memberId=1&voucherNo=00001-00001-000001&spendingAmount=100

Response​

Success Response​

Status Code: 200

Response Body​

Voucher Can Use Now View Model
FieldDescriptionType
voucherInfoVoucher info.Voucher Info View Model
cantUseNowReasonReason of voucher unusable. Refer here for more informations.numbernullable
Example of Success Response Body
{
  "voucherInfo": {
    "voucherId": 2,
    "voucherName": "PWP 10% off",
    "isPercent": true,
    "discountValue": 10,
    "description": "10% off for second purchase.",
    "numberOfVoucherToIssue": null,
    "numberOfVoucherIssued": 1,
    "mobileTitle": "10% off for second purchase.",
    "getIsReobtainable": true,
    "getStartDate": "2021-01-01T00:00:00",
    "getEndDate": null,
    "getRequiredPoints": 0,
    "getTermAndCondition": null,
    "getMemberLevelIds": [],
    "useStartDate": null,
    "useEndDate": null,
    "useStartTime": "2000-11-10T00:00:00",
    "useEndTime": "2000-11-10T23:59:00",
    "useEndDateTime": null,
    "useValidDays": [
      1,
      2,
      3,
      4,
      5,
      6,
      0
    ],
    "useValidOnMemberBirthday": false,
    "useValidOnMemberBirthMonth": false,
    "useRepeatable": true,
    "useMinimumSpending": 0,
    "useNumberOfDaysAllowedBeforeMemberBirthday": null,
    "useNumberOfDaysAllowedAfterMemberBirthday": null,
    "useTermAndCondition": null
  },
  "cantUseNowReason": null
}

Error Response​