Coupons
Kommunikationsprotokoll für Coupons.
Verwendete Rest-Methoden, Kontrakt: Comarch.B2.DataService.Contracts.dll
VoucherEntity[] GetInternalVouchers(string number)
Die Methode sollte eine aktuelle Liste der Coupons zurückgeben, die der angegebenen Nummer entsprechen (normalerweise ist dies ein Gutschein).
VoucherResult UpdateVouchers(VoucherEntity[] vouchers);
Mit dieser Methode sollten die einzelnen Coupons, die als Parameter übergeben werden, hinzugefügt/aktiviert/deaktiviert/aktualisiert werden.
Welche Aktion für bestimmte Kassenbelege durchgeführt werden soll, hängt von den Daten ab, die in der VoucherEntity enthalten sind. Relevante Daten, die von POS gesendet werden:
| VoucherEntity | |
| Id : int | ID des Vouchers (0, wenn es erstellt werden soll) |
| TypeId : VoucherKindEnum | Typ des Coupons
(Unknown, InternalSold, InternalReleased, External, GiftCard) |
| SortId : int | Art des Coupons |
| CurrencyId : int | Währung des Coupons |
| IsActive : bool | Status des Coupons
True – interner Coupon (verkauft, ausgestellt, Karte) zur Verwendung (Deaktivierung) oder, im Falle einer Karte, zur Aktualisierung des Status Amount |
| Number : string | Nummer des Coupons |
| Amount : decimal | Wert des Coupons |
Die erwartete Aktion hängt von der Konfiguration der VoucherEntity-Parameter ab, die über die UpdateVouchers-Methode an den Voucher-Service (DataService) gesendet werden:
| Id | SortId | IsActive | Aktion |
| – | External | – | Internenen Coupon nutzen
Wird in der Datenbank als verwendet und inaktiv für den in Amout angegebenen Wert mit CurrencyId und Number. |
| 0 | InternalReleased | – | Internen ausgestellten Coupon erzeugen
Wird in der Datenbank als aktiv und nicht verwandet für den in Amout angegebenen Wert mit Number (Nummer) und CurrencyId (Währung). |
| >0 | InternalReleased
InternalSold GiftCard |
true | Coupon nutzen oder Gutscheinwert aktualisieren
|
| >0 | InternalReleased | false | Bestenden, intern ausgegebenen Coupon aktivieren |
Bool IsExternalVoucherExists(string numer, int sortId)
Die Methode sollte prüfen, ob ein externer Gutschein mit der angegebenen Nummer und dem Typ bereits in der Datenbank vorhanden ist.