Zásilky
Vytváření zásilek, štítky, seznam, detail, tracking, storno a manifest.
Vytvoření objednávky zásilek
Vytvoří jednu nebo více zásilek. Pokud nebude uvedena platba nebo měna, použijí se
výchozí hodnoty účtu. Pokud je požadavek autentizován přes x-apikey, není nutné uvádět
payer — plátcem se automaticky stává přihlášený uživatel.
Pro celní zásilky a svoz s vlastním tiskem štítků viz rozšířené specifikace výše.
Vytvoření objednávky zásilek › Request Body
currencyKód měny objednávky. Pokud není uvedena, použije se výchozí měna účtu.
payment_typeZpůsob úhrady objednávky. Neautentizované požadavky (bez x-apikey) mohou použít pouze
ONLINE; dostupnost CREDIT a INVOICE se řídí typem účtu/smlouvy zákazníka.
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.
voucherSlevový kód.
Vytvoření objednávky zásilek › Responses
Zásilky byly úspěšně vytvořeny.
statusHTTP stavový kód odpovědi.
messageTextová zpráva k provedené akci.
Získání štítků
Vrátí tiskové štítky pro vybrané zásilky, ve formátu PDF nebo jako URL ke stažení.
Štítek je dostupný až poté, co dopravce potvrdí přijetí dat o zásilce (stav EXPORTED
a novější).
Získání štítků › Request Body
shipmentsPole identifikátorů zásilek (tracking_number).
positionPozice prvního štítku na tiskovém archu.
formatFormát návratové hodnoty — pdf vrátí base64 zakódovaný soubor, url odkaz
ke stažení, stream odpoví přímo binárním PDF (bez JSON obálky).
paper_sizeFormát papíru štítku.
Získání štítků › Responses
Štítek(y) byly vygenerovány.
statusmessagedataOdkaz ke stažení (format=url) nebo base64 zakódovaný soubor (format=pdf).
Seznam zásilek
Vrátí stránkovaný seznam zásilek, který lze filtrovat podle stavu, data nebo identifikátorů.
query Parameters
statusFiltrace podle stavu zásilky.
offsetPosun výsledků pro procházení starších zásilek.
limitMaximální počet vrácených zásilek.
from_datePočáteční datum filtru (od data vytvoření).
to_dateKoncové datum filtru.
reference_numberFiltrace podle vlastní reference zásilky (reference).
tracking_numberFiltrace podle identifikátoru zásilky.
searchFulltextové vyhledávání v reference_number nebo tracking_number.
trackingPřiložit ke každé zásilce pole tracking_information s tracking historií.
Seznam zásilek › Responses
Seznam zásilek.
statusmessageObjekt zásilek klíčovaný identifikátorem zásilky (tracking_number).
Detail zásilek
Vrátí podrobné informace k vybraným zásilkám. S query parametrem tracking odpověď
u každé zásilky obsahuje navíc pole tracking_information s kompletní tracking
historií (stejný tvar jako odpověď endpointu /shipments/tracking).
U zásilek do boxů / výdejních míst vybraných dopravců (Zásilkovna, Balíkovna) obsahuje
objekt Package v odpovědi navíc parametr
package_password — heslo pro vložení balíku/vratky.
query Parameters
trackingPřiložit tracking historii ke každé zásilce (stačí přítomnost parametru).
Detail zásilek › Responses
Detail zásilek.
statusmessageObjekt zásilek klíčovaný identifikátorem zásilky (tracking_number).
Storno zásilek
Zruší vybrané zásilky, pokud ještě nebyly předány k přepravě.
Storno zásilek › Request Body
shipmentsPole identifikátorů zásilek ke stornování.
Storno zásilek › Responses
Zásilky byly stornovány.
statusHTTP stavový kód odpovědi.
messageTextová zpráva k provedené akci.
Předávací protokol (manifest)
Vygeneruje předávací protokol (soupiska) pro vybrané zásilky.
Předávací protokol (manifest) › Request Body
shipmentsPole identifikátorů zásilek.
formatFormát výsledného manifestu.
Předávací protokol (manifest) › Responses
Manifest byl vygenerován.
statusmessagedataOdkaz ke stažení (format=url) nebo base64 zakódovaný soubor (format=pdf).