Get a list of available vouchers

Using this endpoint you can get a list of available vouchers to be displayed on your own website or in an application.

The Voucher Object

Request

Headers

GET REQUEST (/vouchers)

Header: Content-Type application/json
Header: Accept application/json
Header: Smart-Auth sk_XXXXXXXXXXXXXXXXXX

Response

There are 2 types of voucher; monetary and experience. Monetary vouchers are supplied with a minimum, maximum, and increment value, these are used to show the customer the possible selections for the voucher value - using an example of a voucher with a min of 10, a max of 40 and an increment of 10, the options would be 10, 20, 30, and 40. Experience vouchers have a fixed value and this is stored in the value field. Experience vouchers may be for one or more participants; if orders are created using the Smart Gift API and a 'persons' value is provided, this will act as a multiplier making a £215.00 voucher for 2 persons worth (and priced at) £430.00.
The status of the voucher is listed as one of the following: active, hidden, disabled, or at_counter_only. These options detail how the voucher is used in the system and by using this field, you can tailor the available selection to your use-case.

{
    "data": [
        {
            "id": 37,
            "title": "Monetary Gift Voucher",
            "selling_description": "Create your own personalised experience at Rathfinny Wine Estate with this voucher. This voucher can be redeemed at the Cellar Door, Tasting Room restaurant and Flint Barns. \r\n\r\nThis voucher is valid for 24 months after purchase.",
            "type": "monetary",
            "status": "active",
            "value": null,
            "min": "10.00",
            "max": "1000.00",
            "persons_min": 1,
            "persons_max": 1,
            "increments": "5.00",
            "available_count": null,
            "expiry": null,
            "image": "https://smart-gift-uk-dev.s3.eu-west-2.amazonaws.com/product-images/Vso02R4k9vPSexEztVAhhvKxrGgz7ECE6xsdNaDr.jpeg",
            "created_at": "2020-10-25T15:58:30.000000Z",
            "updated_at": "2020-11-13T14:35:04.000000Z"
        },
        {
            "id": 38,
            "title": "Dinner, Bed & Breakfast for two at the Flint Barns",
            "selling_description": "Enjoy a short break away in the heart of the vineyard with this experience, including a three-course dinner for two in the Flint Barns dining room, one night’s accommodation in a double room followed by a delicious home cooked breakfast. The Flint Barns is nestled in the heart of the South Downs so is the perfect place for a relaxing night away. Enjoy a three-course dinner of comforting and wholesome dishes, led by our Estate Head Chef Chris Bailey, in a relaxed and informal setting. To book, please call the Flint Barns on 01323 874030 or email flintbarns@rathfinnyestate.com. Booking in advance is essential and please mention the voucher at the time of booking. \r\n\r\nThis voucher is valid for 24 months after purchase.",
            "type": "experience",
            "status": "active",
            "value": "215.00",
            "min": null,
            "max": null,
            "persons_min": 1,
            "persons_max": 4,
            "increments": null,
            "available_count": 23,
            "expiry": null,
            "image": "https://smart-gift-uk-dev.s3.eu-west-2.amazonaws.com/product-images/ex9OgRxR9rYzvwyhsoIZKtdeeXxO6iAZ6sqPxlzz.jpeg",
            "created_at": "2020-10-30T12:19:27.000000Z",
            "updated_at": "2020-12-07T10:23:27.000000Z"
        }
    ]
}

Statuses