Nuolaidų / lojalumo kortelių sąrašas

Užklausa

GET https://restoranas.kitchenforce.lt/api/discountcards?agreement={agreementId}

Sėkmingas atsakymas

{
    "discountLoyaltyCards": [
        {
            "number": "8156233565335",
            "api": false,
            "physical": false,
            "locked": false,
            "ownerFullName": "Vardenis Pavardenis",
            "discountSize": 3,
            "loyaltyMoneySize": 3,
            "balance": 316.93
        }
    ]
}

Parametrų sąrašas

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

Klaidos atsakymas

{
    "errorCode": 5,
    "errorDescription": "Sutartis nerasta"
}

Klaidos kodai

Žemiau pateikiami tik su nuolaidų / lojalumo kortelių peržiūra susiję klaidų kodai. Klaidų kodai susiję su API raktu ir jo leidimais aprašyti skyriuje naudojimas.

Kodas Aprašymas
5 Sutartis nerasta
6 Sutartis nėra nuolaidų / lojalumo kortelių sutartis
7 Sutartis negalioja