Tento přehled slouží jako referenční dokumentace pro zákazníky, kteří využívají import objednávek do ZP nebo API metodu pro zadání objednávky. Přehled obsahuje vesměs jen vstupní parametry.
| Typ | Popis |
|---|---|
string(xx) |
Textový řetězec o maximální délce xx znaků |
number(xx) |
Číslo o maximální délce xx číslic. Pokud je počet číslic ve formátu a,b, např. 10,2, pak první číslo znamená počet číslic před desetinnou čárkou a druhé maximální počet desetinných míst. |
bool |
Boolean (logické hodnota ano/ne). Možné hodnoty jsou 0 a 1 |
date |
Datum ve formátu dd.mm.rrrr nebo rrrr-mm-dd (ve vstupech jsou možné obě varianty, ve výstupech je vždy varianta první) |
time |
Čas ve formátu hh:mm |
datetime |
Datum a čas ve formátu dd.mm.rrrr hh:mm:ss (používá se jen ve výstupech) |
entity(xx) |
Odkaz na jinou datovou entitu |
set |
Výběř z dané množiny hodnot (číselníku) |
V první tabulce uvádíme vstupní data, která zadává zákazník. Drtivá většina atributů je nepovinná a minimální objednávka si vystačí s adresou nakládky a vykládky, hmotností zásilky a definicí obsahu (jeden obal).
| Parametr | Typ | Povinný | Výchozí hodnota | Popis | |
|---|---|---|---|---|---|
| term_id | set |
ANO | 1 | Termín. Viz číselník termínů | |
| label | string(40) |
- | - | Označení | |
| loading_date | date |
- | Automaticky dle termínu | Datum nakládky | |
| loading_time_from | time |
- | - | Čas nakládky od | |
| loading_time_to | time |
- | - | Čas nakládky do | |
| discharge_date | date |
- | - | Plánované doručení | |
| discharge_time_from | time |
- | - | Plánované doručení - čas od | |
| discharge_time_to | time |
- | - | Plánované doručení - čas do | |
| payer_select | set |
- | 1 | Výběr plátce přepravy. Možné hodnoty:1: plátce=příkazce2: plátce=příjemce4: platba při nakládce,3: jiný plátce popis |
|
| loading_select | set |
- | 1 | Výběr nakládky přepravy. Možné hodnoty:1: adresa objednavatele2: jiná adresa3: osobní podej |
|
| loading_personal_branch_id | typ |
pokud loading_select=3 |
- | ID střediska pro osobní podej. Viz číselník středisek | |
| discharge_personal_branch_id | typ |
pokud term_id=5 |
- | ID střediska pro osobní odběr. Viz číselník středisek | |
| payer | entity(obj_partner) |
pokud payer_select=3 |
- | Plátce přepravy | |
| loading | entity(obj_partner) |
pokud loading_select=2 |
- | Nakládka | |
| discharge | entity(obj_partner) |
ANO | - | Vykládka | |
| twoway_shipment | bool |
- | 0 | Obousměrná zásilka | |
| twoway_shipment_description | string(50) |
- | - | Popis obousměrné zásilky | |
| yard | bool |
- | 0 | Sběrný dvůr | |
| delivery_notes_back | bool |
- | 0 | Dodací listy zpět. 0: Ne, 1: Elektronicky, 2: Fyzicky, 3: Elektronicky + fyzicky |
|
| aviso_sms | bool |
- | 1 | SMS avizace vykládky | |
| loading_aviso | bool |
- | 0 | Telefonická avizace nakládky | |
| discharge_aviso | bool |
- | 0 | Telefonická avizace vykládky | |
| loading_comfort_id | set |
- | 1 | Služba Comfort na nakládce (viz číselník) | |
| loading_floors | number |
- | 0 | Počet pater na nakládce (pro některé varianty služby Comfort) | |
| discharge_comfort_id | set |
- | 1 | Služba Comfort na vykládce (viz číselník) | |
| discharge_floors | number |
- | 0 | Počet pater na vykládce (pro některé varianty služby Comfort) | |
| return_pack_id | set |
- | - | Služba vratný obal. Hodnoty viz číselník vratných obalů | |
| return_pack_count | number |
pokud return_pack_id > 0 |
- | Počet vratných obalů | |
| return_pack_description | string(255) |
- | - | Popis vratného obalu | |
| freight_cash_id | set |
- | - | Služba přepravné v hotovnosti. Hodnoty viz číselník | |
| cash_on_delivery_type | bool |
- | Automaticky podle cash_on_delivery_price |
Služba dobírka | |
| cash_on_delivery_price | number(10,2) |
pokud cash_on_delivery_type=1 |
- | Výše dobírky | |
| cash_on_delivery_price_cur_id | set |
pokud cash_on_delivery_type=1 |
- | ID měny (viz číselník) | |
| cash_on_delivery_account1 | string(6) |
- | - | Číslo účtu - předčíslí | |
| cash_on_delivery_account2 | string(10) |
- | - | Číslo účtu | |
| cash_on_delivery_bank | string(4) |
- | - | Kód banky | |
| cash_on_delivery_iban | string(60) |
- | - | IBAN | |
| cash_on_delivery_swift | string(60) |
- | - | SWIFT | |
| var_symbol | string(20) |
- | - | Variabilní symbol | |
| oversize | bool |
- | 0 | Nadrozměr | |
| consider | bool |
- | 0 | Převážit | |
| label_fragile | bool |
- | 0 | Křehké | |
| label_dont_tilt | bool |
- | 0 | Nestohovat | |
| label_this_side_up | bool |
- | 0 | Neklopit | |
| hydraulic_front_loading | bool |
- | 0 | Hydraulické čelo na nakládce | |
| hydraulic_front_discharge | bool |
- | 0 | Hydraulické čelo na vykládce | |
| dimensions | string(60) |
- | - | Rozměry zásilky !deprecated | |
| dimensions_d | number |
- | - | Rozměry - délka !deprecated, nově v entitě pack | |
| dimensions_s | number |
- | - | Rozměry - šířka !deprecated, nově v entitě pack | |
| dimensions_v | number |
- | - | Rozměry - výška !deprecated, nově v entitě pack | |
| num_epals | number |
- | 0 | Počet euro palet | |
| kg | number(12,2) |
ANO | - | Hmotnost zásilky | |
| m3 | number(12,2) |
- | - | Kubatura zásilky. Jsou-li vyplněny všechny rozměry (dimensions_d,s,v), spočítá se automatickys | |
| note_loading | string(2000) |
- | - | Poznámka na nakládce | |
| note_discharge | string(2000) |
- | - | Poznámka na vykládce | |
| order_value | number(12,1) |
- | - | Hodnota zásilky | |
| order_value_currency_id | number(12,1) |
- | - | Hodnota zásilky - ID měny (viz číselník) | |
| packs | entity[](pack) |
ANO | - | Obsah zásilky - kusy | |
| adrs | entity[](adr) |
- | - | Definice ADR - přeprava nebezpečných látek |
Vytvořená objednávka má další atributy generované systémem. Uvádíme ty nejdůležitější. Upozorňujeme, že čísla kusů objednávek se můžou změnit při změně počtu kusů v rámci objednávky
| Parametr | Typ | Popis |
|---|---|---|
| order_number | number |
Číslo objednávky (nebo také číslo přepravního listu) |
| source | set |
Zdroj (odkud se objednávka dostala do aplikace ZP). Možné hodnoty:1: formulářem v aplikaci ZP2: importem v aplikaci ZP3: Přes API |
| labels_printed | bool |
Příznak, že byly vytištěny štítky (a jsou tím pádem s jistotou vygenerovaná čísla kusů) |
| quantity_sum | number |
Celkový počet kusů v objednávkce. |
| piece_number_from | number |
První číslo kusu. Objednávky má spojité číslování kusů, tj. pokud je v objednávce celkem 5 kusů a číslo prvního kusu je 500103, dá se spolehnout, že čísla kusů jsou 500103, 500104, 500105, 500106, 500107 |
| piece_numbers | number[] |
Jednotlivá čísla kusů objednávky |
| Parametr | Typ | Povinný | Výchozí hodnota | Popis |
|---|---|---|---|---|
| name | string(60) |
ANO | - | Název firmy / jméno |
| registration_code | number(10) |
povinné pro firmy | - | IČ |
| vat_code | string(20) |
- | - | DIČ |
| first_name | string(60) |
- | - | Jméno kontaktní osoby |
| last_name | string(60) |
- | - | Příjmení kontaktní osoby |
| phone | string(60) |
- | - | Telefon kontaktní osoby |
string(200) |
- | - | E-mail kontaktní osoby | |
| address | entity(address) |
ANO | - | Adresa |
| Parametr | Typ | Povinný | Výchozí hodnota | Popis |
|---|---|---|---|---|
| city | string(200) |
ANO | - | Město nebo obec |
| city_part | string(200) |
- | - | Část obce |
| street | string(200) |
- | - | Název ulice (může být včetně čísla) |
| house_num | string(200) |
- | - | Číslo popisné. Může obsahovat i číslo orientační. Může být také automaticky detekováno v parametru street |
| zip | string(20) |
- | - | PSČ |
Pozn. země se neuvádí, protože je implikovaná parametry city a zip. Pokud v budoucnu bude třeba zemi rozlišit, parametr doplníme.
| Parametr | Typ | Povinný | Výchozí hodnota | Popis |
|---|---|---|---|---|
| pack_id | set |
ANO | - | ID obalu (viz číselník) |
| quantity | number(3) |
ANO | - | Počet kusů (min 1, max 250) |
| description | string(100) |
- | - | Popis |
| dimensions_d | number |
- | - | Rozměry - délka |
| dimensions_s | number |
- | - | Rozměry - šířka |
| dimensions_v | number |
- | - | Rozměry - výška |
Atributy generované systémem. Upozorňujeme, že čísla kusů objednávek se můžou změnit při změně počtu kusů v rámci objednávky
| Parametr | Typ | Popis |
|---|---|---|
| piece_number_from | number |
První číslo kusu. Analogicky jako u objednávky. |
| piece_numbers | number[] |
Jednotlivá čísla kusů pro tento obal |
| Parametr | Typ | Povinný | Výchozí hodnota | Popis |
|---|---|---|---|---|
| un | set |
ANO | - | ADR UN (viz číselník) |
| count | number(3) |
ANO | - | Počet kusů (min 1, max 250) |
| kg | number |
ANO | - | Hmotnost |
| description | string(100) |
- | - | Popis |
| environment_danger | bool |
- | 0 | Ohrožující životní prostředí |