Alternates

Akce pro práci s náhradníky na skupinových lekcích.
Akce Popis
POST /v1/Alternates/AddToAppointment

Přihlásí zákazníka jako náhradníka na konkrétní událost.
POST /v1/Alternates/AddToCourse

Přihlásí zákazníka jako náhradníka na konkrétní kurz.
POST /v1/Alternates/GetAppointmentAlternates

Načte seznam náhradníků, kteří jsou přihlášeni na konkrétní událost.
POST /v1/Alternates/GetAppointmentsSubscribedByCustomer

Vrátí všechny události, na kterých je předaný zákazník registrován jako náhradník.
POST /v1/Alternates/GetCourseAlternates

Načte seznam náhradníků, kteří jsou přihlášeni na konkrétní kurz.
POST /v1/Alternates/GetCoursesSubscribedByCustomer

Vrátí všechny kurzy, na kterých je předaný zákazník registrován jako náhradník.
POST /v1/Alternates/RemoveFromAppointment

Odhlásí náhradníka z konkrétní události.
POST /v1/Alternates/RemoveFromCourse

Odhlásí náhradníka z konkrétního kurzu.

Authorize

Akce pomocí kterých lze získat autorizační tokeny.
Akce Popis
POST /v1/Authorize/GetShortTimeToken

Získá ShortTimeToken (STT) pro komunikaci s API. Jeho platnost je 30 minut.

Booking

Akce pro práci s rezervacemi. Tyto akce lze použít univerzálně pro jakýkoliv typ zaměření.
Akce Popis
POST /v1/Booking/AddPaymentViaCredit

Zaplatí již existující rezervaci předaným množstvím kreditu (pokud je požadovaná úhrada menší než cena rezervace, rezervace bude uhrazena částečně, pokud je požadovaná úhrada větší než cena rezervace, bude zákazníkovi stržena pouze cena rezervace).
POST /v1/Booking/AddPaymentViaPass

Zaplatí již existující rezervaci předanou permanentkou.
POST /v1/Booking/AddPaymentViaServiceSubstitution

Zaplatí již existující rezervaci náhradami zákazníka, který se na ni rezervoval (má dostatek náhrad).
POST /v1/Booking/Cancel

Stornuje již vytvořenou rezervaci.
POST /v1/Booking/Confirm

Potvrdí rezervaci, která se nachází ve stavu čekání na potvrzení.
POST /v1/Booking/EditCustomValues

Upraví vlastní hodnoty u již existující rezervace.
POST /v1/Booking/GetActivities

Od zadaného data vrací seznam akcí, co se stalo s rezervacemi vytvořenými přes API.
POST /v1/Booking/GetBookingsForCustomer

Načte všechny rezervace pro konkrétního zákazníka v daném časovém rozmezí.
POST /v1/Booking/GetBookingsForPeriod

Načte všechny rezervace v daném časovém rozmezí.
POST /v1/Booking/GetCancelLink

Získá odkaz, pomocí kterého lze stornovat rezervaci, pokud je to ještě možné.
POST /v1/Booking/GetPaymentLink

Získá odkaz, pomocí kterého lze zaplatit rezervaci, pokud je to ještě možné.
POST /v1/Booking/Reject

Zamítne rezervaci, která se nachází ve stavu čekání na potvrzení.
POST /v1/Booking/SetNoShowState

Nastaví rezervace příznak, zda-li se zákazník dostavil či nikoliv.

BookingResource

Akce pro práci se zdroji.
Akce Popis
POST /v1/BookingResource/Get

Načte konkrétní zdroj podle jeho interního id.
POST /v1/BookingResource/GetAvailability

Načte časovou dostupnost daných zdrojů pro dané období.
POST /v1/BookingResource/GetList

Načte seznam všech zdrojů od právě přihlášeného obchodníka.

BookingService

Akce pro práci se službami.
Akce Popis
POST /v1/BookingService/Get

Načte konkrétní službu, podle jejího interního id od právě přihlášeného obchodníka.
POST /v1/BookingService/GetForBookingResource

Načte seznam všech viditelných služeb poskytovaných konkrétním zdrojem.
POST /v1/BookingService/GetList

Načte seznam všech služeb od právě přihlášeného obchodníka.

Classes

Akce pro práci s událostmi. Tyto akce lze použít pouze v zaměřeních typu Classes,
např. skupinové lekce, sportoviště, obecné - skupina zákazníků v pevný čas, ...
Akce Popis
POST /v1/Classes/CreateBooking

Vytvoří novou rezervaci na vypsaný termín se zadaným zákazníkem.
POST /v1/Classes/Get

Získá vypsaný termín podle jeho interního identifikátoru.
POST /v1/Classes/GetAvailableAppointments

Získá vypsané termíny pro vybraný segment a provozovnu (s možností omezení na kalendář).

Course

Akce pro práci s kurzy.
Akce Popis
POST /v1/Course/Get

Vrací kurz podle jeho identifikátoru.
POST /v1/Course/GetCustomerEvents

Načte rezervace daného zákazníka na daný kurz.

Credit

Akce pro práci s kreditovými pohyby.
Akce Popis
POST /v1/Credit/GetHistory

Načte historii kreditových pohybů.

Customer

Akce pro práce se zákazníky.
Akce Popis
POST /v1/Customer/Create

Vytvoří nového zákazníka u právě přihlášeného obchodníka.
POST /v1/Customer/CreateAccount

Načte zákazníka podle jeho interního id a vytvoří mu účet. Po vytvoření zákazníkovi přijde e-mail s výzvou na doplnění hesla. Zákazník bude moci účet používat až po doplnění hesla, pomocí odkazu v obdrženém e-mailu.
POST /v1/Customer/CreateAccountWithPassword

Načte zákazníka podle jeho interního id a vytvoří mu potvrzený zákaznický účet. Zákazník se následně bude moct ihned přihlásit pomocí předaného hesla.
POST /v1/Customer/CreditTransactions

Vrací obrat kreditů daného zákazníka za vybraný interval.
POST /v1/Customer/DeleteAccount

Načte zákazníka podle jeho interního id a odebere mu zákaznický účet.
POST /v1/Customer/Details

Načte detaily jednotlivého zákazníka podle jeho interního Id.
POST /v1/Customer/Edit

Upraví existujícího zákazníka u právě přihlášeného obchodníka.
POST /v1/Customer/EditCustomValues

Upraví vlastní hodnoty u již existujícího zákazníka.
POST /v1/Customer/Get

Načte jednotlivého zákazníka podle jeho interního Id.
POST /v1/Customer/GetList

Načte seznam zákazníků, případně filtrovaný nejmenším datem registrace.
POST /v1/Customer/Login

Vytvoří přihlašovací token pro daného zákazníka. Token lze použít pro přihlášení do správy rezervací, případně do rezervačního formuláře. Tento token je platný 3 minuty.
POST /v1/Customer/Note

Přidá (upraví) poznámku u daného zákazníka.
POST /v1/Customer/Search

Načte seznam zákazníků (omezený na 15 záznamů), vyhledaných podle zadaných kritérií.
POST /v1/Customer/TryReturnPassUsage

Pokusí se danému zákazníkovi navrátit daný počet použití z permanentky.
POST /v1/Customer/TryUseCredit

Pokusí se danému zákazníkovi odečíst kredit z jeho kreditového účtu.
POST /v1/Customer/TryUsePass

Pokusí se vyčerpat danému zákazníkovi vstup z permanentky.
POST /v1/Customer/WebHook/Create

Vytvoří nový webhook - reakci na událost ohledně zákazníků.
POST /v1/Customer/WebHook/Delete

Smaže webhook - reakci na událost ohledně zákazníků.
POST /v1/Customer/WebHook/GetList

Načte seznam všech webhooků - reakcí na události ohledně zákazníků.

CustomValue

Akce pro práci s vlastními hodnotami.
Akce Popis
POST /v1/CustomValue/GetCustomerDefinitions

Načte seznam definic vlastních hodnot zákazníků aktuálně přihlášeného obchodníka (s možností omezit dotaz pouze na daný segment).
POST /v1/CustomValue/GetEventDefinitions

Načte seznam definic vlastních hodnot událostí aktuálně přihlášeného obchodníka (s možností omezit dotaz pouze na daný segment).

EmsLike

Akce pro práci s rezervacemi. Tyto akce lze použít pouze v zaměřeních typu EmsLike.
Akce Popis
POST /v1/EmsLike/CreateBooking

Vytvoří novou rezervaci na požadovaný termín se zadaným zákazníkem.
POST /v1/EmsLike/UpdateBooking

Upraví rezervaci daného zákazníka.

Event

Akce pro práci s událostmi. Tyto akce lze použít univerzálně pro jakýkoliv typ zaměření.
Akce Popis
POST /v1/Event/Get

Načte konkrétní událost, podle jejích identifikátorů.
POST /v1/Event/GetByCode

Načte konkrétní událost, podle jejího kódu.
POST /v1/Event/GetList

Načte seznam událostí v daném rozsahu dat.
POST /v1/Event/GetListByCustomer

Načte události konkrétního zákazníka.
POST /v1/Event/WebHook/Create

Vytvoří nový webhook - reakci na událost ohledně událostí.
POST /v1/Event/WebHook/Delete

Smaže webhook - reakci na událost ohledně událostí.
POST /v1/Event/WebHook/GetList

Načte seznam všech webhooků - reakcí na události ohledně událostí.

ExternalIdentifier

Akce pro práci s externími identifikátory. Jedná se o dodatečné informace, které lze ke konkrétním objektům v Reservantu ukládat a následně podle nich zpětně objekty dohledávat.
Akce Popis
POST /v1/ExternalIdentifier/Add

Přidá k objektu v Reservantu externí identifikátor.
POST /v1/ExternalIdentifier/Delete

Odebere od objektu v Reservantu externí identifikátor.
POST /v1/ExternalIdentifier/Edit

Upraví u objektu v Reservantu externí identifikátor.
POST /v1/ExternalIdentifier/Get

Získá objekt z Reservanta na základě hodnoty externího identifikátoru.

FreeTime

Akce pro práci s volny.
Akce Popis
POST /v1/FreeTime/Create

Vytváří nové volno pro konkrétní zdroj na daný termín.
POST /v1/FreeTime/Delete

Smaže volno podle jeho identifikátoru.
POST /v1/FreeTime/Get

Vrací informace o konkrétním volnu podle jeho identifikátoru.
POST /v1/FreeTime/WebHook/Create

Vytvoří nový webhook - reakci na událost ohledně volen.
POST /v1/FreeTime/WebHook/Delete

Smaže webhook - reakci na událost ohledně volen.
POST /v1/FreeTime/WebHook/GetList

Načte seznam všech webhooků - reakcí na události ohledně volen.

Location

Akce pro práci s provozovnami.
Akce Popis
POST /v1/Location/Get

Načte konkrétní provozovnu podle jejího interního id.
POST /v1/Location/GetList

Načte seznam všech provozoven od právě přihlášeného obchodníka.

Merchant

Akce pro získávání informací o obchodníkovi, který API aktuálně využívá.
Akce Popis
POST /v1/Merchant/GetInfo

Vrátí základní informace o obchodníkovi.

OneToOne

Akce pro práci s událostmi. Tyto akce lze použít pouze v zaměření typu OneToOne,
např. masáže, kosmetika, obecné - jeden zákazník v libovolný čas, ...
Akce Popis
POST /v1/OneToOne/CreateBooking

Vytvoří novou rezervaci danému zdroji s předanou službou a zákazníkem na daný termín.
POST /v1/OneToOne/GetAvailableStarts

Načte seznam všech právě teď dostupných začátků pro rezervaci s vybranou službou pro daný zdroj v daném časovém úseku.
POST /v1/OneToOne/GetAvailableStartsForLocation

Načte seznam všech právě teď dostupných začátků pro rezervaci s vybranou službou pro danou provozovnu v daném časovém úseku.
POST /v1/OneToOne/MoveBooking

Změní termín dané rezervace.

Pass

Akce pro práci s vytvořeními permanentkami.
Akce Popis
POST /v1/Pass/GetList

Načte seznam všech permanentek, které jsou definovány v systému.

PassToCustomer

Akce pro práci s permanentkami, které jsou již zakoupené zákazníky.
Akce Popis
POST /v1/PassToCustomer/AddIntermission

Pozastaví již zakoupenou permanentku.

POST /v1/PassToCustomer/AddPass

Přidá zákazníkovi permanentku.
POST /v1/PassToCustomer/GetPassesForCustomer

Vrací seznam permanentek pro daného zákazníka.

PaymentMethod

Akce pro práci s platebními metodami pokladních dokladů.
Akce Popis
POST /v1/PaymentMethod/GetList

Načte seznam všech dostupných platebních metod, kterými lze označit doklad jako uhrazený.

PriceLevel

Akce pro práci s cenovými hladinami.
Akce Popis
POST /v1/PriceLevel/GetList

Načte seznam všech cenových hladin.

Product

Akce pro práci s produkty.
Akce Popis
POST /v1/Product/GetList

Načte všechny produkty od právě přihlášeného obchodníka.

ProductCategory

Akce pro práci s kategoriemi produktů.
Akce Popis
POST /v1/ProductCategory/GetList

Načte všechny kategorie produktů od právě přihlášeného obchodníka.

RentalLike

Akce pro práci s událostmi. Tyto akce lze použít pouze v zaměřeních typu RentalLike,
např. půjčovna
Akce Popis
POST /v1/RentalLike/CreateBooking

Vytvoří novou rezervaci danému zdroji a zákazníkovi na daný termín.
POST /v1/RentalLike/GetAvailability

Načte časovou dostupnost zdrojů.

Segment

Akce pro práci se zaměřeními, ve kterých obchodník poskytuje své služby.
Akce Popis
POST /v1/Segment/GetList

Načte seznam všech zaměření od právě přihlášeného obchodníka.

ServiceSubstitution

Akce pro práci s náhradových systémem.
Akce Popis
POST /v1/ServiceSubstitution/GetForCustomer

Vrací náhrady (slouží pro hrazení rezervace), kterými disponuje určitý zákazník.

Tag

Akce pro práci se štítky.
Akce Popis
POST /v1/Tag/GetListForCustomer

Načte všechny štítky, které mohou být přiřazeny zákazníkům.
POST /v1/Tag/GetListForResource

Načte všechny štítky, které mohou být přiřazeny zdrojům.

Test

Akce pro testování dostupnosti API.
Akce Popis
POST /v1/Test/Echo

Slouží ke kontrole dostupnosti API.

Voucher

Akce pro práce s vouchery. Tyto akce má smysl využívat pouze za předpokladu, že má obchodník nastavenou automatickou validaci kódů voucherů.
Akce Popis
POST /v1/Voucher/GetList

Načte seznam všech voucherů, které jsou definovány v systému. Pokud obchodník vouchery nepoužívá vrací vždy prázdnou kolekci.
POST /v1/Voucher/IsValid

Zkontroluje existenci voucheru (zda-li předaný kód existuje v systému).
POST /v1/Voucher/PayForBooking

Pokusí se uhradit rezervaci pomocí voucheru.
POST /v1/Voucher/RefundBookingPayment

Pokusí se zrušit úhradu rezervace, která je uhrazena voucherem a zároveň obnovit platnost kódu.

WorkingHours

Akce pro práci s pracovními (otevíracími) hodinami.
Akce Popis
POST /v1/WorkingHours/GetForPeriod

Načte konkrétní pracovní hodiny v rámci daného časového období, respektuje i např. nastavení otevírací doby ve svátky.