Schemas

HTTP stavový kód odpovědi.

Textová zpráva k provedené akci.

Objekt zásilek klíčovaný identifikátorem zásilky (tracking_number).

Objekt klíčovaný identifikátorem zásilky (tracking_number).

Pole identifikátorů dotčených kontaktů.

Kontaktní osoba a adresa pro podání nebo doručení zásilky. Lze uvést buď existující kontakt odkazem na id, nebo plné údaje.

Kontaktní osoba a adresa pro podání nebo doručení zásilky. Lze uvést buď existující kontakt odkazem na id, nebo plné údaje.

Kód měny (ISO 4217) pro ceny v odpovědi.

Typ svozu zásilky.

Požadované datum svozu.

Omezí nabídku na konkrétního dopravce. Povinné, pokud je uveden kód místa v pickup_branch nebo delivery_branch.

Kód podacího místa (ParcelPoint.code), spolu s carrier. Hodnota true znamená podání na libovolné pobočce dopravce — vrátí i nabídky služeb, které jinou variantu podání nenabízejí (např. Balíkovna, Zásilkovna).

Kód výdejního místa, spolu s carrier.

Kód měny objednávky. Pokud není uvedena, použije se výchozí měna účtu.

Způsob úhrady objednávky. Pokud není uveden, použije se výchozí způsob platby účtu (u nového účtu ONLINE). Neautentizované požadavky (bez platného x-apikey) mohou použít pouze ONLINE. CREDIT je dostupný každému přihlášenému účtu s nabitým kreditem; INVOICE pouze smluvním zákazníkům (aktivuje Zaslat na vyžádání). U CREDIT a INVOICE se zásilky předají dopravci ihned po vytvoření, u ONLINE až po zaplacení objednávky.

Kontakt plátce. Nepovinné, pokud je požadavek autentizován přes x-apikey — plátcem se pak stává přihlášený uživatel.

Slevový kód.

Kód přepravní společnosti.

Konkrétní přepravní služba dopravce.

Identifikátor přepravní služby dopravce.

Nejbližší možné datum svozu.

Začátek okna pro svoz, formát H:m:s.

Konec okna pro svoz, formát H:m:s.

Předpokládané datum doručení.

Cena přepravy bez DPH.

Cena přepravy včetně DPH.

Limit odpovědnosti dopravce včetně DPH.

Příznak vlastní faktury.

Váhový limit zásilky.

Možnost předání na podacím místě. Pokud je nabídka vrácena jen na dotaz s pickup_branch: true, uveďte tento příznak i v /shipments/create.

Povinnost předání na podacím místě.

Povinnost doručení na výdejní místo.

Kategorie zásilky podle směru přepravy.

Dostupnost trackingu zásilky.

Dostupnost tisku štítku.

Identifikátor existujícího kontaktu z adresáře. Pokud je uveden, ostatní parametry jsou nepovinné.

Název firmy.

Jméno kontaktní osoby.

Příjmení kontaktní osoby.

Ulice a číslo popisné.

Město/obec.

PSČ.

Kód země (ISO 3166-1 alpha-2).

Telefonní kontakt.

E-mailový kontakt.

IČ.

DIČ.

Kontaktní osoba a adresa pro podání nebo doručení zásilky. Lze uvést buď existující kontakt odkazem na id, nebo plné údaje.

Kontaktní osoba a adresa pro podání nebo doručení zásilky. Lze uvést buď existující kontakt odkazem na id, nebo plné údaje.

Kód přepravní společnosti.

Identifikátor konkrétní přepravní služby dopravce.

Typ svozu zásilky.

Požadované datum svozu.

Požadovaný čas svozu ve formátu H:i:s (např. 08:00:00).

⚠️ Hodnotu zohledňuje jen část dopravců; u ostatních se from_time k zásilce uloží a vrací se v odpovědích, ale dopravci se nepředává:

• grid.online — určuje začátek okna pro vyzvednutí. Čas se zaokrouhluje nahoru na celou hodinu a okno je dlouhé 2 hodiny, takže 08:00:00 znamená svoz mezi 09:00 a 11:00. Čas v minulosti se posouvá na nejbližší možný termín.

Pokud spolu s from_time uvedete i pickup_date, zohlední se obojí i při výpočtu předpokládaného termínu svozu a doručení.

Kód podacího místa — uveďte i carrier, pokud vybíráte konkrétní podací místo. Hodnota true (přijímá se i "1") znamená podání na libovolné pobočce dopravce; v odpovědi se tato volba vrací jako "1" spolu s pickup_branch_location: 1. Varianta podání musí odpovídat nabídce z /rates/get — viz Doručení na výdejní místo.

Kód výdejního místa.

⚠️ ID podacího místa (viz mapa výdejních míst). Hodnota 1 znamená podání na libovolné pobočce (bez konkrétního místa).

⚠️ ID výdejního místa.

Vlastní označení zásilky.

Poznámka pro řidiče/kurýra.

Bezštítková zásilka (PPL SmartPIN) — true objedná zásilku bez tisku štítku, dopravce přidělí šestimístný kód pro podání, který API po exportu vrací v packages[].package_password. Podmínky: dopravce PPL, právě jeden balík, odesílatel i příjemce v ČR; jinak 400. Podrobnosti v Bezštítková zásilka PPL (SmartPIN).

⚠️ V odpovědi říká, zda zásilka bezštítková skutečně zůstala — pokud dopravce bezštítkový export odmítne, zásilka se vytvoří s klasickým štítkem a pole je false. Vrací se pouze vlastníkovi zásilky, jinak null.

Objekt celní deklarace pro zásilky podléhající celnímu řízení (mimo EU) — strukturu a číselníky popisuje Objednávka celní zásilky.

Stav zásilky/balíku.

Identifikátor místa.

Kód přepravní společnosti.

Kód místa.

Název místa.

Kód země (ISO 3166-1 alpha-2).

Souřadnice místa.

Místo umožňuje podání zásilky.

Výdejní box: 1 ano, 0 ne.

Sklad/depo: 1 ano, 0 ne.

Platba kartou: 1 ano, 0 ne.

Bezbariérový přístup: 1 ano, 0 ne.

Bez polední pauzy: 1 ano, 0 ne.

Otevřeno v sobotu: 1 ano, 0 ne.

Otevřeno v neděli: 1 ano, 0 ne.

Otevírací doba podle dne v týdnu (klíč 1–7, pondělí = 1).

⚠️ Identifikátor sdílený dopravci na stejné adrese.

Váha [kg].

Šířka [cm].

Výška [cm].

Délka [cm].

Peněžní hodnota v dané měně.

Obsah balíku.

⚠️ Aktuální stav balíku (návratový parametr).

⚠️ Historie stavů balíku (návratový parametr).

⚠️ URL trackingu u dopravce (návratový parametr).

⚠️ Heslo pro podání balíku / vratky do boxu / výdejního místa u vybraných dopravců (Zásilkovna, Balíkovna) a šestimístný SmartPIN u bezštítkových zásilek PPL — kód, který odesílatel zadá nebo napíše na balík při jeho předání. Dostupné až po exportu zásilky k dopravci (stav EXPORTED), do té doby null. Vyplněno pouze pro vlastníka zásilky, jinak null (návratový parametr).

Textový popis události.

Stav zásilky/balíku.

Doplňující informace o místě.

Kód služby, viz číselník služeb.

Parametry služby dle jejího typu — objekt ServiceCOD/Money nebo řetězec u slevového kódu.

Dobírková částka. Minimum je 30 CZK / 1 EUR; částka v CZK musí být celé číslo (bez desetinných míst).

Číslo účtu pro výplatu dobírky — český formát (předčíslí-číslo nebo jen číslo) spolu s bank_code, nebo IBAN (pak se bank_code neuvádí). Povinné při vytvoření zásilky; pokud máte číslo účtu uloženo v nastavení účtu, předvyplní se automaticky.

Čtyřmístný kód banky k účtu. Nevyplňuje se, pokud je v bank_account uveden IBAN.

Variabilní symbol pro výplatu dobírky — pouze číslice, max. 10 znaků.

Měna bankovního účtu (ISO 4217).

Připočíst k dobírkové částce i cenu přepravy.

⚠️ Identifikátor žádosti o svoz (návratový parametr).

Požadované datum svozu ve formátu YYYY-MM-DD. Musí to být pracovní den, nesmí být v minulosti ani dnes; svoz na následující den lze objednat pouze do 18:00.

Kód přepravní společnosti.

Identifikátor existující svozové adresy (kontaktu).

Začátek dopolední otevírací doby, formát H:m.

Konec dopolední/celodenní otevírací doby, formát H:m.

Začátek odpolední otevírací doby (pokud je uvedena, jde o polední pauzu).

Konec odpolední otevírací doby.

Částka v dané měně.

Kód měny (ISO 4217).

Název parametru, který chybu způsobil.

Textový popis chyby.

Hodnota parametru, která byla odeslána.