Get Vouchers

Service URL: GET /loyalty/vouchers

Response Body:

IListVouchersResponse

voucherList – List<IVoucherSerialNumber> – The vouchers issued to the customer

voucherTypes – List<IVoucherType> – The types of vouchers associated in the list of vouchers

Remarks:

This service is used to supply the list of vouchers issued to the customer associated with the access token.

Example Request:

GET: http://localhost:8080/WebRestApi/rest/loyalty/vouchers

Example Response:

{
    "vouchersList": [
        {
            "voucherSerialNumber": {
                "lastUpdated": 1556707671950,
                "voucherTypeId": {
                    "regionId": {
                        "id": "All",
                        "groupTypeId": "region",
                        "groupHierarchyId": "All"
                    },
                    "voucherTypeId": "10_POUND"
                },
                "serialNumber": "11111111",
                "value": 1000,
                "status": "ISSUED",
                "currencyId": "GBP",
                "customerId": {
                    "id": "1"
                },
                "usageCount": 1000
            }
        }
    ],
    "voucherTypes": [
        {
            "voucherType": {
                "lastUpdated": 1556707672001,
                "regionId": {
                    "id": "All",
                    "groupTypeId": "region",
                    "groupHierarchyId": "All"
                },
                "voucherTypeId": "10_POUND",
                "description": {
                    "string": [
                        {
                            "string": "£10 Pound off"
                        },
                        {
                            "country": "GB",
                            "language": "en",
                            "string": "£10 Pound off"
                        }
                    ]
                },
                "longDescription": {
                    "string": [
                        {
                            "string": "£10 Pound off when you spend £100"
                        },
                        {
                            "country": "GB",
                            "language": "en",
                            "string": "When you spend £100"
                        }
                    ]
                },
                "disabled": false,
                "allowReturn": false,
                "allowIssue": true,
                "allowTender": true,
                "appliesDiscount": false,
                "track": false,
                "captureSerialNumber": false,
                "generateSerialNumber": false,
                "allowIssueOffline": false,
                "allowRedemptionOffline": false,
                "saleable": false,
                "printed": false,
                "endorse": false,
                "openDrawer": false,
                "expiryPeriod": 0,
                "frankOnRedemption": false,
                "valueType": "FIXED",
                "redemptionOptions": {
                    "tenderValue": 1000,
                    "rewardType": "NONE",
                    "minimumSpend": 10000,
                    "itemPriceAbove": 0,
                    "itemPriceBelow": 0,
                    "markItemsUsed": false
                },
                "currencyKey": {
                    "id": "GBP"
                },
                "voucherValue": 10000,
                "allowReturnOffline": false,
                "usageLimit": 1000,
                "allowMultiUseInOneTransaction": true
            }
        }
    ]
}