Slouží k uložení celních dokumentů k zásilce

Význam a použití

Tato metoda slouží k nahrání celních dokumentů k existující zásilce do systému PPL. Používá se u mezinárodních zásilek, kde je potřeba k zásilce připojit celní dokumentaci (faktury, proforma faktury, celní prohlášení apod.), která je nutná pro celní odbavení.

Parametry

Path parametry:

shipmentNumber (string, povinný) — číslo zásilky, ke které se dokumenty nahrávají. Zásilka musí již existovat v systému PPL (tj. musela být předtím vytvořena přes POST /shipment/batch).

Query parametry:

documentFileType (povinný) — typ nahrávaného dokumentu. Hodnoty musí odpovídat číselníku „Typy dokumentů" (codelist/documentType), který je k dispozici v sekci Codelist v dokumentaci. V jednom requestu lze vždy nahrávat pouze jeden typ dokumentu. Pokud k zásilce patří více typů dokumentů, je nutné je nahrát zvlašť zavoláním dalšího requestu.

Body:

files — samotný soubor (nebo soubory) s celním dokumentem. Nahrává se jako multipart/form-data, tedy standardní file upload.

Omezení pro soubory:

Podporované formáty: pdf, doc, docx, xls, xlsx, jpg, jpeg, png, odt, ods, txt

Maximální velikost všech souborů na jeden request: 1 MB

Maximální počet souborů na jeden request: 5

Typický workflow

Vytvořit zásilku přes POST /shipment/batch → metodou GET /shipment/batch/{batchId} počkat na stav Complete a získat shipmentNumber

Zjistit a vybrat povolené typy dokumentů z GET /codelist/documentFileType

Nahrát celní dokumenty přes tento endpoint

V případě potřeby ověřit stav zásilky přes GET /shipment/{shipmentNumber}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Slouží k uložení celních dokumentů k zásilce

Význam a použití#

Parametry#

Body:#

Typický workflow#

Request

Request Code Samples

Responses

Význam a použití

Parametry

Body:

Typický workflow