Dovanų čekio kūrimas

Užklausa

POST https://restoranas.kitchenforce.lt/api/giftvouchers

Užklausos duomenys

Užklausos parametrai paduodami JSON formatu

{
    "series" : 2,
    "value" : 10,
    "multiple" : true,
    "expirationDays" : 30
}

Užklausos parametrų sąrašas

Parametras Tipas Aprašymas Būtinas
series integer Dovanų čekių serijos ID Taip
value double Dovanų čekio vertė Taip
multiple bool Požymis ar dovanų čekį galima panaudoti keletą kartų
expirationDays integer Dovanų čekio galiojimas dienomis

Sėkmingas atsakymas

{
    "series": 2,
    "number": "61061124101105121",
    "value": 10,
    "balance": 10,
    "status": 0,
    "multiple": true,
    "group": false,
    "expirationDate": ""
}

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

Klaidos atsakymas

{
    "errorCode": 5,
    "errorDescription": "Nenurodyta dovanų čekio serija"
}

Klaidos kodai

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

Kodas Aprašymas
5 Nenurodyta dovanų čekio serija
6 Neteisinga dovanų čekio serija
7 Šios serijos dovanų čekio kūrimas per API negalimas. Prašome kreiptis į sistemos administratorių
8 Nenurodyta dovanų čekio vertė
9 Nurodyta neteisinga dovanų čekio vertė
10 Nurodyta neteisinga dovanų čekio daugkartinio naudojimo reikšmė
11 Nurodytas neteisingas dovanų čekio galiojimo dienų skaičius. Galutinė čekio galiojimo data nustatoma po jo pardavimo
12 Sisteminė problema. Nepavyko sukurti dovanų čekio