Dovanų čekio informacija

Užklausa

GET https://restoranas.kitchenforce.lt/api/giftvouchers/{giftVoucherNumber}

Sėkmingas atsakymas

{
    "series": 1,
    "number": "931076120054012",
    "value": 50,
    "balance": 0,
    "status": 3,
    "multiple": true,
    "group": false,
    "expirationDate": "2023-01-03",
    "usage": [
        {
            "date": "2022-10-05",
            "amount": 19.01
        },
        {
            "date": "2022-10-05",
            "amount": 1.99
        },
        {
            "date": "2022-10-05",
            "amount": 18.5
        },
        {
            "date": "2022-10-05",
            "amount": 10.5
        }
    ]
}

Parametrų sąrašas

Parametras Tipas Aprašymas
series integer Dovanų čekio serija
number string Dovanų čekio numeris
value double Dovanų čekio vertė
balance double Dovanų čekio likutis
status integer Būsena: 0 - išleistas, 1 - rezervuotas, 2 - parduotas (galima naudoti), 3 - išnaudotas, 4 - pasibaigęs galiojimas, 5 - panaikintas
multiple bool Daugkartinis dovanų čekis (galima panaudoti keletą kartų)
group bool Tinklinis dovanų čekis (galima naudoti sistemų grupėje)
expirationDate string Dovanų čekio galiojimo data
usage array Dovanų čekio panaudojimo istorija
- date string Panaudojimo data
- amount double Panaudota suma

Klaidos atsakymas

{
    "errorCode": 5,
    "errorDescription": "Dovanų čekis nerastas"
}

Klaidos kodai

Žemiau pateikiami tik su dovanų čekiu susiję klaidų kodai. Klaidų kodai susiję su API raktu ir jo leidimais aprašyti skyriuje naudojimas.

Kodas Aprašymas
5 Dovanų čekis nerastas arba buvo ištrintas