Bony

Aplikacja Bony pochodzi z modułu Sprzedaż wielokanałowa systemu Comarch ERP Enterprise. Aplikacja służy do tworzenia pojedynczych bonów oraz do przeglądania i edycji istniejących bonów. Każdy bon tworzony w aplikacji opiera się na zdefiniowanym wcześniej rodzaju bonu (aplikacja Rodzaje bonów), z którego dziedziczy domyślną konfigurację (waluta, wartość, okres ważności, sposób użycia, parametry księgowe).

Otwarcie pojedynczego bonu oraz wprowadzenie zmian jest możliwe wyłącznie w trybie jednostkowym – aplikacja prezentuje wówczas dane jednej, wskazanego bonu. Do zarządzania bonami hurtowo (przegląd, filtrowanie wielu bonów) służy aplikacja Lista: Bony.

Wskazówka

Aplikacja składa się z nagłówka. Zawiera on kluczowe atrybuty bonu, które jednoznacznie identyfikują bon i opisują jej aktualny stan.

W nagłówku znajdują się pola identyfikujące bon i opisujące jej aktualny stan. Pola w panelu:

  • Numer – składa się z dwóch pól:
    • Rodzaj – rodzaj bonu pobierany z aplikacji Rodzaje bonów. Pole obowiązkowe, dostępne pod przyciskiem [Pomoc uzupełniania wartości]. Po wybraniu rodzaju bonu pola bonu są wstępnie wypełniane wartościami domyślnymi z rodzaju.
    • Numer – unikalny numer bonu. Pole obowiązkowe. Numer musi być unikalny w obrębie rodzaju bonu. Długość numeru wynika z konfiguracji pola Długość numerów w rodzaju bonu.
  • Status – aktualny status bonu. Pole nieedytowalne – wartość ustawiana automatycznie przez system. Dostępne wartości: Utworzony, Aktywne, Zablokowane, Nieaktywne. Wartość domyślna dla nowego bonu: Utworzony. Szczegółowy opis statusów znajduje się w dokumencie ogólnym Bony.
  • Wartość – aktualna wartość pieniężna bonu (kwota i waluta). Wartość domyślna pobierana jest z pola Kwota bonu rodzaju bonu. Waluta musi być zgodna z walutą zdefiniowaną w rodzaju bonu.
  • Czas utworzenia bonu – data i godzina utworzenia bonu w systemie. Pole wypełniane automatycznie.
  • Obowiązuje od – do – okres ważności bonu. Wartością domyślną dla daty Obowiązuje od jest data bieżąca, natomiast Obowiązuje do jest wyliczana jako Obowiązuje od + Okres obowiązywania w dniach (pole rodzaju bonu). Po utracie ważności bonu status bonu zostaje automatycznie zmieniony na Nieaktywne.
  • Klient – klient (partner o roli Klient), do którego bon jest przypisany. Pole dostępne wyłącznie dla bonów, których rodzaj ma zaznaczony parametr Spersonalizowany. Pole obowiązkowe dla bonów spersonalizowanych. Pole edytowalne wyłącznie do momentu zapisu nowego bonu. Lista dostępnych klientów obejmuje partnerów posiadających rolę Klient w jednej z organizacji przyporządkowanych do rodzaju bonu.

Bony są wymieniane między systemem a adapterami za pośrednictwem aplikacji Eksport bonów oraz webserwisów i interfejsów BIS. Sposób obsługi bonu może różnić się w zależności od adaptera.

Adapter Comarch POS obsługuje pełen cykl życia bonu wewnętrznego.

Informacje na temat obsługi bonów w Comarch POS można znaleźć w dokumencie Obsługa bonów.

Adapter Cloud udostępnia webserwis com.sem.ext.app.mcs.loyalty.giftcard.rest.GiftCardsService obsługujący tworzenie i realizację bonów w sklepach internetowych. W zakresie obsługiwanym przez adapter:

  • sklep internetowy wywołuje webserwis żądający utworzenia nowego bonu (lub kilku bonów) podając rodzaj bonu oraz opcjonalnie wartość i okres ważności; jeżeli wartość lub okres ważności nie są podane, używane są wartości domyślne z rodzaju bonu
  • po utworzeniu bonu webserwis zwraca numer bonu oraz jej status (początkowo Utworzony)
  • bon może zostać aktywowany w dowolnym momencie po jej utworzeniu (np. po potwierdzeniu płatności) za pomocą metody activateGiftCard – status zmienia się z Utworzony na Aktywne
  • przy dodaniu bonu do koszyka sklep internetowy może opcjonalnie wywołać webserwis weryfikujący ważność bonu i jej dostępne saldo
  • przed potwierdzeniem zamówienia sklep wykonuje obowiązkową weryfikację bonu – blokuje to wykorzystanie tej samego bonu równolegle w innym kanale
  • po potwierdzeniu płatności sklep przekazuje numer bonu oraz wykorzystaną kwotę; system aktualizuje saldo bonu i jeżeli saldo wyniesie zero, automatycznie zmienia status bonu na Nieaktywne

REST

Ścieżka bazowa: com.sem.ext.app.mcs.loyalty.giftcard.rest.GiftCardsService

Wszystkie punkty końcowe: POST,

Format danych wejściowych i wyjściowych: application/json

Dostępne metody:

  • POST /createGiftCards

  Tworzy jeden lub więcej bonów.

  Treść żądania: List<GiftCardCreateData> (tablica JSON).

Pole wymagane: rodzaj. Pola opcjonalne: wartość, data ważności od, data ważności do, klient.

  • POST /isGiftCardValid

  Zwraca aktualny stan istniejącego bonu.

  Treść żądania: pojedynczy obiekt GiftCardData

Pola wymagane: numer, rodzaj..

  • POST /redeemGiftCard

  Pobiera kwotę z aktywnego bonu i zapisuje wpis w historii.

  Treść żądania: GiftCardData

Pola wymagane: numer, rodzaj, kwota. Pole opcjonalne: documentData.

  • POST /activateGiftCard

  Zmienia status karty podarunkowej z CREATED na ACTIVE.

 Treść żądania: GiftCardData

Pola wymagane: numer, rodzaj.

Czy ten artykuł był pomocny?