Balíkuj Website Documentation

Balíkuj Website Documentation

Schemas

Vítejte v Balíkuj API
Account
- Slouží k získání informací o uživateli
- Slouží k updatu informací o uživateli
- Slouží k přihlášení ke službě
- Slouží pro zjisštění zda je email validní
- Slouží pro registraci uživatele
- Aktivuje účet podle zadaných údajů
- Vytvoří odkaz pro reset hesla
- Nastaví nové heslo uživatele
- Slouží pro odhlášení uživatele
- Slouží pro změnu emailové adresy uživatele
- Slouží pro změnu hesla uživatele
- Umožňuje zažádat o zrušení účtu, po schválení žádosti dojde ke kompletnímu zrušení účtu
- Enable two factor authentication with Google Authenticator
- Aktivuje dvoufázové ověření pomocí aplikace Google Authenticator pomocí dodaného kódu
- Vypne dvoufázové ověřování pomocí aplikace Google Authenticator
- Slouží k získání url na avatar uživatele
- (Auth)
- (Auth)
- Vrátí seznam podporovaných časových zón pro využití v systému Balíkuj.cz
- (Auth)
- (Auth)
- (Auth)
- (Auth)
Address
- Vrátí seznam adress dle zadaných kritérií
- Vytvoří adresu dle zadaného modelu
- Vyhledá adresu dle zadaného ID a vrátí ji jako výsledek
- Smaže adresu dle zadaného ID. Pokud je adresa použita někde jinde, bude pouze označena jako neaktivní
Application
- Vrátí seznam aplikací dle zadaných kritérií
- Vrátí seznam aplikací, které jsou k dispozici pro aktivaci
- Vrátí informace o nainstalované aplikaci
- Aktualizuje nastavení aplikace dle zadaných dat
- Nastaví zvolenou aplikaci jako smazanou. K fyzickému odstranění dat objednávek, stavů, platebních metod a dalšího dojde automaticky za 30 dnů nebo požádání ihned.
- Vytvoří novou aplikaci dle zvoleného typu aplikace
- Vrátí seznam namapovaných dopravců, které máte v systému Balíkuj vytvořeny
- (Auth)
- (Auth)
- (Auth)
- (Auth)
BankAccount
- Vrátí seznam podporovaných bank a kódu
- Vrátí seznam bankovních účtů dle zadaných kritérií
- Vrátí informace o zvolené fakturační firmě
- (Auth)
- (Auth)
- (Auth)
Batch
- (Auth)
- Vrátí informace o dané dávce
- Nastaví zvolenou dávku jako archivovanou
Billing
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- Vrátí PDF fakturu
- Vrátí PDF fakturu
Carrier
- Vrátí seznam dopravců a informace o tom, zda jsou aktivní
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí seznam manipulačních jednotek u daného dopravce
Cp
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
Dpd
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Odešle do systému daného dopravce všechny zvolené zásilky nebo pokud nejsou zadány žádné zásilky, tak odešle všechny nezpracované.
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
DpdSk
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
EmailAccount
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
EmailTemplate
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- Pomocí této metody můžeme nahrát přílohu ve formátu .pdf k emailové šabloně. V tuto chvíli je možné přiložit k šabloně pouze jeden soubor.
Geis
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Odešle do systému daného dopravce všechny zvolené zásilky nebo pokud nejsou zadány žádné zásilky, tak odešle všechny nezpracované.
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
Gls
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
GlsSk
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
Invoice
- Vrátí seznam faktur dle zadaných kritérií
- Vrátí informace o zvolené faktuře
- Upraví zvolenou fakturu
- Smaže zvolenou fakturu
- Vytvoří novou fakturu
- Vytvoří fakturu z objednávky
- Aktivuje modul Fakturace podle zvolených nastavení
- Vrátí binární PDF faktur
- Vrátí HTML fakturu
- Vráti podklady pro poslání emailu
- Vráti podklady pro poslání emailu
- Upraví poznámku u faktury
- Uzamkne/odemkne fakturu
- Vrátí seznam dokladů k přijaté platbě k zúčtování
- Vrátí seznam fakturačních firem dle zadaných kritérií
- Vrátí informace o zvolené fakturační firmě
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- Vrátí seznam plateb
- Vrátí informace o zvolené platbě
- Přidá platbu ke zvolené faktuře
- Vytvoří doklad k přijaté platbě u zálohové faktury
- Zruší zaplacení faktury - smaže všechny platby
- (Auth)
- (Auth)
InvoiceExport
- Vrátí seznam exportů, které uživatel vytvořil
- Vrátí detailní informace o daném exportu
- Odstraní existující export
- Vytvoří nový export dle zadaných parametrů
- Stáhne existující export
Label
- Vygeneruje odkaz na štítky pro všechny nevytisknuté zásilky
- Vygeneruje odkaz na štítky pro zásilky dle zadaných ID zásilek
- Vytiskne stítky pro zásilky z Eshopu
- Vygeneruje odkaz na štítky pro zásilky dle zadaných ID objednávek
NumberSeries
- Vrátí seznam číselných řad dle zadaných kritérií
- Vrátí informace o zvolené číselné řadě
- Upraví existující číšelnou řadu
- (Auth)
- Vytvoří novou číselnou řadu
- Vrátí poslední použitelné číslo z číselné řady
Order
- Vrátí seznam objednávek dle zadaných kritérií
- (Auth)
- Aktualizuje všechny objednávky dle zadaného modelu.
- Vytvoří novou jednu nebo více objednávek dle zaslaných dat
- Vrátí preview dané objednávky a vrátí detaily stavů ostatní objednávek daného zákazníka. Zákazníci se párují pomocí emailu.
- Vrátí binární PDF detailu objednávky
- (Auth)
- Vrátí seznam stavových kódů objednávek, které máte v systému vytvořeny včetně systémových stavů, které jsou vráceny vždy první
- (Auth)
- Vrátí detaily stavového kódu dle zvoleného ID
- Upraví zvolený stavový kód dle ID stavového kódu pro danou aplikaci
- (Auth)
- Vrátí seznam stavových kódů objednávek, které máte v systému vytvořeny včetně systémových stavů, které jsou vráceny vždy první
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- Vrátí seznam událostí dle zadaných podmínek
- Umožňuje vložit nový záznam do logu změn u objednávky
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
Package
- (Auth)
- Vrátí seznam podporovaných služeb daného dopravce
- (Auth)
- (Auth)
- /api/Package/EshopInfo
Packeta
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Zruší zvolené zásilky
- Vráti seznam všech packeta dopravců
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
Pdf
- Vytiskne štítky pro dané zásilky
- /api/pdf/label/{hash}
- /api/pdf/pl/{hash}
- Vytiskne předávací protokol dle zadaného hash
- Vytiskne předávací protokol dle zadaného id protokolu
- /api/pdf/order/{hash}
Picking
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
Pickup
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Odešle do systému daného dopravce všechny zvolené zásilky nebo pokud nejsou zadány žádné zásilky, tak odešle všechny nezpracované.
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
- (Auth)
Ppl
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Vytvoří svoz pro zvolené zásilky
- Vrátí seznam adres pro pickup, které má uživatel nastevené v PPL systému
- Odešle do systému daného dopravce všechny zvolené zásilky nebo pokud nejsou zadány žádné zásilky, tak odešle všechny nezpracované.
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
Printer
- Vrátí seznam pravidel s možností filtrace
- Vrátí informace o dané tiskárně
- Upraví existující tiskárnu
- Vrátí seznam všech tokenů tiskáren, které lze využívat na vzdáleném počítači k tisku dokumentů
- Vytvoří nový token pro použití při tisku dokumentů. Tento token se nastaví v programu, který je třeba si nainstalovat na počítač, kde jsou připojeny tiskárny
- Upraví existující token
- Odstraní existující token a všechny tiskárny, které jsou s tímto tokenem svázané
- (Auth policies: ApiToken)
- /api/Printer/PrintLabelFromEshopButton
- (Auth policies: ApiToken)
- (Auth policies: ApiToken)
- Nastaví zvolenou dávku jako archivovanou
Rule
- Vrátí seznam pravidel s možností filtrace
- Vrátí seznam všech vlastností/sloupců, podle kterých lze vytvářet pravidla
- Vrátí informace o zvoleném pravidle
- Upraví existující pravidlo
- Odstraní existující pravidlo
- Vytvoří nové pravidlo
- Změní pořadí vybraného pravidla o jedno místo nahoru
- Změní pořadí vybraného pravidla o jedno místo dolů
Search
- Vrátí seznam nalezených objektů dle zadaných kritérií
- Vrátí seznam deseti posledních hledáných frází
Stats
- Vrátí počet zásílek
- (Auth)
- Vrátí statistiky počtu zásilek za zvolené období
- (Auth)
- Vrátí počet zásilek s dobírkou (Dobírka, bez dobírky, celkem)
- Vrátí počet zásilek v jednotlivých stavech (Doručeno, v přepravě, vyjímka, celkem)
- Vrátí počet zásilek podle typu doručení (Home, Branch, Box)
- Vrátí počty zásilek podle času vyzvednutí z výdejního místa (D+0, D+1,... D+5+). Možné filtrovat pouze nevyzvednuté zásilky pomocí parametru OnlyNotDelivered.
- Vrátí počty zásilek podle času doručení (D+0, D+1,... D+5+). Možné filtrovat pouze nedoručené zásilky pomocí parametru OnlyNotDelivered.
- (Auth)
- (Auth)
- (Auth)
- (Auth)
- (Auth)
Template
- Vrátí seznam templatů s možností filtrace
- Vrátí informace o zvoleném templatu
- Upraví existující template
- Odstraní existující template
- Vytvoří nový template
- (Auth)
TrackingPage
- Vrátí seznam Tracking Page
- Upraví Tracking Page
- (Auth)
Webhook
- Vrátí seznam webhooks s možností filtrace
- Vrátí seznam všech podporovaných typů webhooků
- Vrátí informace o Webhook s daným ID
- Smaže Webhook s daným ID
- Vytvoří nový webhook podle zadaných hodnot
- Upraví Webhook s daným ID
Wedo
- (Auth)
- Vrátí informace o balíku se zvoleným ID. ID je číselný identifikátor zásilky v našem systému
- Zruší zvolené zásilky
- Vrátí seznam podporovaných manipulačních jednotek
- Vrátí seznam podporovaných služeb daného dopravce
- Vrátí pro každou službu seznam zemí v ISO-2 formátu, kam dopravce doručuje
- Vrací seznam doplňkových služeb podle daného dopravce. Pokud dopravce umožňuje při přidání zásilky specifikovat doplňkové služby, můžete použít hodnoty code z této metody.
- Vrátí seznam poboček, dle zadaných parametrů
- Vyhledá stav zvolených zásilek
- Vytvoří předávací protokol pro daného dopravce
Schemas
- Schemas

Schemas

AccountRegisterModel

{
    "fullName": "Josef Novák",
    "email": "email@info.cz",
    "password": "pass123",
    "helpMe": true,
    "phone": "string"
}