List of Voucher Redemptions

GET https://api.e-guma.ch/v1/vouchers/redemptions.json?apikey={api-key}&from={from}&to={to}

Parameters


api-key `required`
from `required`	Shows voucher redemptions from this date (format: 2025-05-21T00:00:00).
to `required`	Shows voucher redemptions up to this date (format: 2025-05-21T23:59:59).
user_id	Optional UserId in order to only request redemptions of a specific user.

Return


code	Voucher code
redeemed_at	Date and time (ISO 8601 format) of the voucher redemption, e.g. 2025-05-21T16:28:17.
redeemed_amount_in_cents	Redeemed amount in cents.
derecognized	If the voucher has already been derecognized/cleared, this value is `true`, otherwise `false`.
is_complimentary	If the voucher has been issued as a complimentary voucher, this value is `true`, otherwise `false`.
user	User in e-guma who performed the voucher redemption.
product	Voucher type.

User object


id	The ID of the user in e-guma.
name	Username.

Product object


id	The ID of the voucher product.
name	The name of the voucher in the main language of the account (e.g. Candle Light Dinner).

Example

GET https://api.e-guma.ch/v1/vouchers/redemptions.json?apikey=YOUR-API-KEY&from=2025-05-21T00:00:00&to=2025-05-21T23:59:59

[
    {
        "code": "C2UV-WD75-7M75",
        "redeemed_at": "2025-05-21T16:28:17",
        "redeemed_amount_in_cents": 5000,
        "derecognized": false,
        "is_complimentary": false,
        "user": {
            "id": "9c456486-a5a2-4df2-a757-d875e9e15c25",
            "name": "gastronomie"
        },
        "product": {
            "id": "577c25f2-8a42-4573-96b2-373f943113ea",
            "name": "Wertgutschein"
        }
    },
    {
        "code": "HFP7-U6G3-G235",
        "redeemed_at": "2025-05-21T16:32:12",
        "redeemed_amount_in_cents": 10400,
        "derecognized": false,
        "is_complimentary": false,
        "user": {
            "id": "9c456486-a5a2-4df2-a757-d875e9e15c25",
            "name": "gastronomie"
        },
        "product": {
            "id": "2693e788-45c3-4f4a-add8-6af86a06ce96",
            "name": "Frühstücksbuffet"
        }
    }
]