POST https://restoranas.kitchenforce.lt/api/discountcards
Užklausos parametrai paduodami JSON formatu
{
"agreementId" : 67,
"amount" : 50,
"physical" : true,
"ownerName" : "Vardenis",
"ownerLastname" : "Pavardenis",
"ownerPhone" : "+37000000000",
"ownerEmail" : "vardenis.pavardenis@pastas.lt"
}
| Parametras | Tipas | Aprašymas | Būtinas |
|---|---|---|---|
| agreementId | integer | Nuolaidų / lojalumo sutarties ID | Taip |
| amount | double | Nuolaidų / lojalumo kortelės vertė | Taip |
| physical | boolean | Požymis ar tai bus fizinė nuolaidų / lojalumo kortelė | |
| ownerName | string | Nuolaidų / lojalumo kortelės savininko(-ės) vardas | Taip |
| ownerLastname | string | Nuolaidų / lojalumo kortelės savininko(-ės) pavardė | |
| ownerPhone | string | Nuolaidų / lojalumo kortelės savininko(-ės) telefono numeris | |
| ownerEmail | string | Nuolaidų / lojalumo kortelės savininko(-ės) el. paštas |
{
"number": "901633718685",
"api": true,
"physical": true,
"locked": true,
"ownerFullName": "Vardenis Pavardenis",
"discountSize": 3,
"loyaltyMoneySize": 3,
"balance": 50
}
| Parametras | Tipas | Aprašymas |
|---|---|---|
| discountLoyaltyCards | array | Nuolaidų / lojalumo kortelės |
| number | string | Kortelės numeris |
| api | boolean | Požymis ar kortelė buvo sukurta per API |
| physical | boolean | Požymis ar kortelė yra fizinė (naudojamas kuriant korteles per API) |
| locked | boolean | Požymis ar kortelė yra užrakinta. Užrakintų kortelių panaudojimas negalimas tol kol jai nebus suteiktas fizinės kortelės numeris (naudojamas kuriant korteles per API) |
| ownerFullName | string | Kortelės savininko(-ės) vardas ir pavardė |
| discountSize | double | Kortelei taikomos nuolaidos dydis % |
| loyaltyMoneySize | double | Kortelės nuo užsakymo gaunamų lojalumo pinigų dydis % |
| balance | double | Kortelės lojalumo pinigų likutis |
{
"errorCode": 5,
"errorDescription": "Nenurodyta sutartis"
}
Žemiau pateikiami tik su nuolaidų / lojalumo kortelių kūrimu susiję klaidų kodai. Klaidų kodai susiję su API raktu ir jo leidimais aprašyti skyriuje naudojimas.
| Kodas | Aprašymas |
|---|---|
| 5 | Nenurodyta sutartis |
| 6 | Sutartis nerasta |
| 7 | Sutartis nėra nuolaidų / lojalumo kortelių sutartis |
| 8 | Sutartis negalioja |
| 9 | Šios sutarties nuolaidų / lojalumo kortelių kūrimas per API negalimas |
| 10 | Nenurodyta nuolaidų / lojalumo kortelės vertė |
| 11 | Nurodyta neteisinga nuolaidų / lojalumo kortelės vertė |
| 12 | Nenurodytas nuolaidų / lojalumo kortelės savininko(-ės) vardas |
| 13 | Nurodyti neteisingi nuolaidų / lojalumo kortelės savininko(-ės) duomenys |
| 14 | Nurodyta neteisinga nuolaidų / lojalumo kortelės fizinė reikšmė |
| 15 | Sisteminė problema. Nepavyko sukurti nuolaidų / lojalumo kortelės |