GET v1/Voucher?code={code}
Get a Voucher.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
code |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of VoucherName | Description | Type | Additional information |
---|---|---|---|
CreatedDate |
Voucher Created Date |
date |
None. |
Status |
Status - Active: voucher has balance, Inactive: already fully redeemed |
string |
None. |
Code |
Voucher Code |
string |
None. |
Type |
Voucher Type |
string |
None. |
Description |
Promotion Description |
string |
None. |
ExpiryDate |
Voucher Expiry Date |
date |
None. |
Amount |
Voucher Amount |
decimal number |
None. |
CustomerID |
Customer ID of which voucher is assigned to |
integer |
None. |
CustomerEmail |
Customer Email of which voucher is assigned to |
string |
None. |
RedeemedCount |
Count on how many times the voucher has been redeemed. Only makes sense when RedeemedCountLimit=1 |
integer |
None. |
RedeemedCountLimit |
Limit on how many times the voucher can be fully redeemed, should always be 1 unless modified from backend. Cin7 vouchers don't have limit counts on partial redemptions as long as they have balance left. |
integer |
None. |
RedeemedAmount |
Voucher Redeemed Amount |
decimal number |
None. |
Response Formats
application/json, text/json
[ { "createdDate": "2024-11-20T10:35:19.1865248+13:00", "status": "sample string 2", "code": "sample string 3", "type": "sample string 4", "description": "sample string 5", "expiryDate": "2024-11-20T10:35:19.1865248+13:00", "amount": 7.0, "customerID": 8, "customerEmail": "sample string 9", "redeemedCount": 10, "redeemedCountLimit": 11, "redeemedAmount": 12.0 }, { "createdDate": "2024-11-20T10:35:19.1865248+13:00", "status": "sample string 2", "code": "sample string 3", "type": "sample string 4", "description": "sample string 5", "expiryDate": "2024-11-20T10:35:19.1865248+13:00", "amount": 7.0, "customerID": 8, "customerEmail": "sample string 9", "redeemedCount": 10, "redeemedCountLimit": 11, "redeemedAmount": 12.0 } ]