B2BZasilka API České pošty
Technical documentation
Download yaml - technical documentation: B2B-ZSKService.
Examples of answers, types of attributes and their limitations are given
Working with API key
Get API key
The API production environment is only available to contract customers.
You need to contact your sales manager to gain access to the API. You can find out which one is here: Sales managers .The sales manager will help you with registration and initial setup and assign rights.
You can log in to your account on the Posta Online website once you have obtained your access details. Under the For businesses tab, you can access B2B Profile Management, where you can create and change the keys that you need to encrypt the request that will be sent to the API.
There are also 4 test accounts where you can try out the API calls. The details for these are in the Test Accounts section.
API Key Generation Guide
When you receive an email with your login name and a text message with your password, log in to Pošta Online. Then under the Business Services tab, click on Manage B2B Profile
After clicking on Manage, you will be prompted to enter the SMS code
You will see a summary of your account information and can generate API keys. Keys are generated with an expiration date of OD and are valid indefinitely or until the new key starts
Api-Token
API authorization and authentication with a key that is generated in Správě profilu B2B. Through the administration interface, the customer has the option to invalidate the API key and issue a new one.
Example:Api-Token: b79b16c2-2f77-450f-91a5-868c3c698a82 | Security Scheme Type | API Key |
| Header parameter name | Api-Token |
Authorization-Timestamp
Authorization-Timestamp is used to calculate HMAC_SHA256_Auth. The external partner system generates a timestamp in the format 'UTC UNIX Timestamp'.
This item must be appended to the header as 'Authorization-Timestamp'.
This timestamp cannot be longer than 60 seconds, it cannot be in the future. An invalid timestamp request will be rejected with a response code of 403.
Authorization-Timestamp: 1593561601 | Security Scheme Type | API Key |
| Header parameter name | Authorization-Timestamp |
Authorization-content-SHA256
SHA256 request body. The external partner system counts the SHA256 hash 'requestBody' of the JSON request body.
This hash must be appended to the header as 'Authorization-Content-SHA256'.
If this hash does not match the body hash in the request, the request will be rejected with a response code of 403.
Authorization-Content-SHA256: f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbc2d1a3cd8 | Security Scheme Type | API Key |
| Header parameter name | Authorization-Content-SHA256 |
HMAC_SHA256_Auth
HMAC_SHA256_Auth is created using Api-Token, nonce (random slice) and signature. Secret key authorization is required for requests. This secret key is generated in the user application, the secret key is not part of the request. The external partner system generates a 'nonce' - in UUIDv4 format.
The signature is created as an HMAC256 hash of the following items:
Authorization-Content-SHA256;Authorization-Timestamp;nonce
as the first parameter of the HMAC function and
secretKey
as the second.
If the request does not have a body (e.g. GET operation), the signature is formed as follows:
;Authorization-Timestamp;nonce
as the first parameter of the HMAC function and
secretKey
as the second.
Signature must be in base64.
Example:Authorization: CP-HMAC-SHA256 nonce="74b03ffb-34e1-419e-8c6f-f8275bad9a41" signature="QGBaYeY8loQZXbJRmj91JV2yTwsuBTME6wQhUrEm7mI=" | Security Scheme Type | API Key |
| Header parameter name | Authorization |
Content-Type
It is necessary to encode the whole request in application/json;charset=UTF-8
Example of creating headers in JavaScript for Postman
const secret = 'dOJWwjp+BWqUcof3K+3OW6XGTnEpmWerx64TCNk0+0pZnonHdN99NFRIGaJSX0/HTtiu6AGYpKp0mjguzqp+wg==';
//set unix timestamp
var moment = require('moment');
pm.environment.set("utc_unix_timestamp", moment().unix());
//console.log('utc_unix_timestamp: ' + pm.variables.get('utc_unix_timestamp'));
var nonce = "0d8873f8-6cf8-4075-88df-f3518c7df527"
//console.log('nonce: ' + nonce);
//0d8873f8-6cf8-4075-88df-f3518c7df527
var payload = pm.request.body.toString();
//console.log('payload : ' + payload);
pm.environment.set("sha256payload", CryptoJS.SHA256(payload).toString());
//console.log('sha256payload : ' + pm.variables.get('sha256payload').toString());
var hash = CryptoJS.HmacSHA256(pm.variables.get('sha256payload') + ';' + pm.variables.get('utc_unix_timestamp') + ';' + nonce, secret);
//console.log('nonceDolni : ' + nonce);
var hashBase64 = CryptoJS.enc.Base64.stringify(hash);
pm.environment.set("signature", hashBase64);
console.log('signature : ' + pm.variables.get('signature').toString());
API operations
Basic information
Shipment data can be transferred using the POST sendParcel operation (Asynchronous) or using the POST parcelService (synchronous).
POST sendParcel is used for larger batches, as it is possible to send information on up to 1000 shipments via this operation. After sending data via the POST sendParcel operation, the customer receives information on whether the batch has been accepted for processing and obtains the transaction id. This id needs to be sent in the request of the sendParcels GET operation, after which you will find out whether the batch was received successfully or with an error.
POST parcelService is used to send data on one shipment (five when using the 70 - multi-piece service). During this operation, it is possible to enter the id of the form and also print the label immediately.
Multi - piece shipment - service 70
- The first shipment is the main shipment
- Multiple shipments must follow consecutive requests
- Service 70 must be listed for each shipment
- For each shipment, enter the quantityParcel element, which indicates the total number of multi-shipments
- For each shipment, enter the sequenceParcel element, which indicates the order of the shipment, such as the first shipment 1 out of three, the second shipment 2 out of three, and the third shipment 3 out of three. Only the value is displayed, ie 1 - 5.
- Indicate each shipment's weight and size
- List the stated price and cash on delivery only for the main shipment
- The maximum number of shipments in a multi-piece is 5
Finding unused barcodes
The application helps to determine the number of unused barcodes for a given technology number.
Parcel Shops and Post Offices
If you are sending data to a Parcel shop/post office, you need to specify the appropriate prefix of the parcel (NB/NP) and insert only the postal code of the Parcel shop/post office in the recipient's address. Each Parcel shop/Post office has its own unique postcode, which is used to identify where the parcel is to be delivered.
The best way to get data about package stores is to implement a map widget from the Package stores site.
In the feeds below, it may happen that due to temporary unavailability
http://napostu.ceskaposta.cz/vystupy/balikovny.xml
http://napostu.ceskaposta.cz/vystupy/napostu_1.xml
Customs categories
- Gift - 31
- Documents - 91
- Commercial sample - 32
- Returned goods - 21
- Sale of goods - 11
- Other (please specify) - 99
HS codes
The HS codebook for customs declarations can be downloaded from Customer outputs
Forms ID for label printing
Table which determines which form IDs can be used for each product.
List of error messages
List of error messages
| responseCode | responseString | responseText | CHYBA(ERROR) / INFO |
|---|---|---|---|
| 1 | OK | Vše v pořádku | INFO |
| 2 | INTERNAL_APPLICATION_ERROR | Interní chyba aplikace | CHYBA |
| 3 | UNAUTHORIZED_ACCESS | Login není evidován k uvedenému číslu podavatele | CHYBA |
| 10 | INVALID_CUSTOMER_ID | Neplatné technologické čislo | CHYBA |
| 11 | INVALID_LOCATION | Neplatné podací místo | CHYBA |
| 12 | INVALID_POST_CODE | Neplatné PSČ podací pošty | CHYBA |
| 13 | INVALID_TRANSMISSION_DATE | Chybné datum podání (menší než aktuální datum) | CHYBA |
| 14 | TRANSMISSION_OPENED | Podání otevřeno | CHYBA |
| 15 | TRANSMISSION_CLOSED | Podání již bylo uzavřeno | CHYBA |
| 16 | TRANSMISSION_UNFINISHED | Zpracování ješte není ukončeno | CHYBA |
| 17 | BATCH_CLOSED | Dávka uzavřena | CHYBA |
| 18 | BATCH_UNFINISHED | Zpracování ješte není ukončeno | CHYBA |
| 19 | BATCH_INVALID | V dávce se vyskytují chybné záznamy | CHYBA |
| 20 | TRANSMISSION_NOT_EXISTS | Podání neexistuje | CHYBA |
| 21 | PARTIALLY_ACCEPTED | Částečně přijato | INFO |
| 100 | INVALID_PARCEL_CODE | Neplatné ID zásilky | CHYBA |
| 101 | DUPLICATE_PARCEL_CODE | Duplicitní ID zásilky v rámci 13-ti měsíců | CHYBA |
| 102 | FULL_SEQUENCE | Vyčerpaná řada podacích čísel | CHYBA |
| 103 | INVALID_PREFIX | Neznámý typ zásilky | CHYBA |
| 104 | INVALID_WEIGHT | Hmotnost mimo povolený rozsah | CHYBA |
| 105 | INVALID_PRICE | Udaná cena mimo povolený rozsah | CHYBA |
| 106 | INVALID_AMOUNT | Dobírka mimo povolený rozsah | CHYBA |
| 107 | INVALID_CURRENCY | Neplatná měna dobírkové částky | CHYBA |
| 108 | MISSING_VS | Neuveden variabilní symbol poukázky | CHYBA |
| 109 | INVALID_WIDTH | Šířka mimo povolený rozsah | CHYBA |
| 110 | INVALID_HEIGHT | Výška mimo povolený rozsah | CHYBA |
| 111 | INVALID_LENGTH | Délka mimo povolený rozsah | CHYBA |
| 112 | ILLEGAL_COMBINATION_SERVICE | Nepovolená kombinace doplňkových služeb | CHYBA |
| 113 | MISSING_REQUIRED_SERVICE | Neuvedena alespoň jedna povinná doplňková služba | CHYBA |
| 114 | MISSING_SURNAME | Neuvedeno příjmení fyzické osoby | CHYBA |
| 115 | MISSING_COMPANY_NAME | Neuveden název právnické osoby | CHYBA |
| 116 | UNKNOWN_CITY | Neznámá obec adresáta | CHYBA |
| 117 | UNKNOWN_ZIP_CODE | Neznámé PSČ adresáta | CHYBA |
| 118 | MISSING_PHONE_NUMBER | Neuvedeno telefonní číslo | CHYBA |
| 119 | INVALID_ADRESS | Adresa odesílatele není vhodná pro produkt Nadrozměrná zásilka (adresa obsahuje údaj P.O.Box nebo Poste restante) | CHYBA |
| 120 | INVALID_DENSITY | Objemová hmotnost mimo povolený rozsah | CHYBA |
| 121 | BAD_WEIGHT | Hmotnost není číslo | CHYBA |
| 122 | BAD_PRICE | Udaná cena není číslo | CHYBA |
| 123 | BAD_AMOUNT | Dobírka není číslo | CHYBA |
| 124 | MISSING_AMOUNT | Neuvedena částka dobírky | CHYBA |
| 125 | MISSING_REQUIRED_SERVICE 20/22/1U | Neuvedena povinná služba 20 ani 22 ani 1U | CHYBA |
| 126 | MISSING_REQUIRED_SERVICE 37/38 | Neuvedena povinná služba 37 ani 38 | CHYBA |
| 127 | MISSING_REQUIRED_SERVICE 42/43/44 | Neuvedena povinná služba 42 ani 43 ani 44 | CHYBA |
| 128 | MISSING_PREFIX | Neuveden typ zásilky | CHYBA |
| 129 | INVALID_WEIGHT_FOR_SERVICE_11 | Hmotnost mimo povolený rozsah služby 11 | CHYBA |
| 130 | MISSING_PRICE | Neuvedena částka udané ceny | CHYBA |
| 131 | MISSING_AMOUNT_TYPE | Neuveden typ dobírky | CHYBA |
| 132 | BAD_VS | Variabilní symbol poukázky není číslo | CHYBA |
| 133 | BAD_WIDTH | Šířka není celé číslo | CHYBA |
| 134 | BAD_HEIGHT | Výška není celé číslo | CHYBA |
| 135 | BAD_LENGTH | Délka není celé číslo | CHYBA |
| 136 | MISSING_REQUIRED_PHONE_NUMBER | Není uveden povinný údaj - telefonní číslo adresáta | CHYBA |
| 137 | BAD_PREFIX | Zásilku tohoto typu nelze na uvedenou adresu odeslat | CHYBA |
| 138 | MISSING_REQUIRED_PHONE_NUMBER_OR_EMAIL | Není uveden povinný údaj - telefonní číslo nebo e-mail adresáta | CHYBA |
| 139 | INVALID_ADRESS_FOR_AMOUNT_OVER_20000 | Zásilku tohoto typu s dobírkou vetší než 20 000 Kč nelze na uvedenou adresu odeslat | CHYBA |
| 140 | BAD_PREFIX | Zásilku tohoto typu nelze na uvedenou adresu odeslat | CHYBA |
| 141 | INVALID_ADRESS | Adresa je vhodná pouze pro produkt Na poštu | CHYBA |
| 142 | INVALID_ADRESS | "Adresu nelze zvolit (adresa obsahuje údaj P.O.Box, Poste restante nebo Na poštu)" | CHYBA |
| 143 | FULL_SEQUENCE | Vyčerpaná řada podacích čísel | CHYBA |
| 144 | DUPLICATE_PARCEL_CODE | Duplicitní zásilka | CHYBA |
| 145 | INVALID_PARCEL_CODE_CONTROL | Nesouhlasí kontrolní číslo v ID zásilky | CHYBA |
| 146 | MISSING_REQUIRED_MRN_CODE | Neuveden MRN kód | CHYBA |
| 147 | INVALID_MRN_CODE_CONTROL | Neplatný kód MRN | CHYBA |
| 150 | INVALID_ADRESS | Adresa je vhodná pouze pro produkt Na poštu | CHYBA |
| 155 | INVALID_ADRESS | Adresát není vhodný pro produkt Nadrozměrná zásilka (nevyplněn mobil nebo telefon) | CHYBA |
| 156 | MISSING_REQUIRED_SERVICE 14/19 | Neuvedena povinná služba 14 | CHYBA |
| 159 | MISSING_REQUIRED_PHONE_NUMBER | Nevyplněn variabilní symbol zásilky | CHYBA |
| 160 | INVALID_PARCEL_CODE | Neuvedeno ID odpovědní zásilky | CHYBA |
| 161 | INVALID_PARCEL_CODE | Neuvedeno ID zásilky | CHYBA |
| 164 | INVALID_PARCEL_CODE | Nesouhlasí technologické číslo s ID zásilky | CHYBA |
| 165 | BAD_ADDRESSEE | Chybný adresát | CHYBA |
| 166 | BAD_QUANTITY_PARCEL_NUMBER | Nepovolený počet VK | CHYBA |
| 168 | MISSING_HEIGHT | Neuvedena výška | CHYBA |
| 169 | MISSING_WIDTH | Neuvedena šířka | CHYBA |
| 170 | MISSING_LENGTH | Neuvedena délka | CHYBA |
| 171 | MISSING_PALETTS_NUMBER | Počet palet mimo povolený rozsah | CHYBA |
| 173 | INVALID_WEIGHT | Součet fyzických hmotností celé vícekusové zásilky mimo povolený rozsah | CHYBA |
| 174 | INVALID_DENSITY | Součet objemových hmotností celé vícekusové zásilky mimo povolený rozsah | CHYBA |
| 176 | INVALID_AMOUNT | Napočtená dobírka u hlavní zásilky je nad povolený rozsah | CHYBA |
| 177 | INVALID_AMOUNT | "Limit pro uložení zásilky na Výdejním místě je pro Dobírku max. 50.000,- Kč. Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená. " | CHYBA |
| 178 | INVALID_PRICE | "Limit pro uložení zásilky na Výdejním místě je pro Udanou cenu a Dobírku max. 50.000,- Kč. Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená. " | CHYBA |
| 179 | INVALID_PRICE_AND_AMOUNT | "Limit pro uložení zásilky na Výdejním místě je pro Udanou cenu a Dobírku max. 50.000,- Kč. Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená. " | CHYBA |
| 182 | INVALID_PHONE_NUMBER | Neplatný formát telefonního čísla | CHYBA |
| 183 | INVALID_EMAIL | Neplatný formát e-mailu | CHYBA |
| 184 | INVALID_PHONE_NUMBER | Neplatný formát telefonního čísla | CHYBA |
| 185 | INVALID_EMAIL | Neplatný formát e-mailu | CHYBA |
| 186 | MISSING_REQUIRED_SERVICE 4 | "Musí být vybraná služba ""Dobírka Pk A"" " | CHYBA |
| 187 | INVALID_PREFIX | Nepovolená kombinace doplňkových služeb | CHYBA |
| 188 | MISSING_SENDER_EMAIL | Neuveden povinný údaj e-mail odesílatele | CHYBA |
| 189 | MISSING_REQUIRED_MOBIL_NUMBER | Není uveden povinný údaj - telefonní číslo nebo mobil adresáta | CHYBA |
| 190 | INVALID_SIGN_NUMBER | Neuveden počet dokumentů určených k podpisu | CHYBA |
| 191 | INVALID_SERVICE_36 | Nepovolená kombinace adresy do Balíkomatu a služby 36 (Potvrzení dokumentace při dod.) | CHYBA |
| 192 | INVALID_SERVICE_37 | Nepovolená kombinace adresy do Balíkomatu a služby 37 (Ověření údajů při dod.) | CHYBA |
| 193 | INVALID_SERVICE_38 | Nepovolená kombinace adresy do Balíkomatu a služby 38 (Předání inf. z dod.) | CHYBA |
| 194 | INVALID_ADDRESS_ADDRESSEE_DOCUMENT | Zásilku tohoto typu nelze na uvedenou adresu adresáta dokumentů odeslat (obsahuje údaj Na poštu) | CHYBA |
| 195 | MISSING_REQUIRED_ADDRESSEE_DOCUMENT | Adresát dokumentů neuveden | CHYBA |
| 196 | MISSING_REQUIRED_MOBIL_OR_EMAIL | Není uveden povinný údaj - mobilní telefonní číslo nebo e-mail adresáta | CHYBA |
| 197 | INVALID_ZPRO_ORDER_NUMBER | Nesprávný formát čísla objednávky ZPRO | CHYBA |
| 198 | INVALID_PARTNER_CODE | Váš kód partnera neodpovídá zadanému kódu objednávky | CHYBA |
| 199 | INVALID_ORDER_NUMBER | Neexistující číslo objednávky | CHYBA |
| 200 | INVALID_ORDER_NUMBER | Objednávka s tímto číslem byla stornována | CHYBA |
| 201 | INVALID_ORDER_NUMBER | "K číslu objednávky již existuje přiřazená zásilka, číslo objednávky nelze použít " | CHYBA |
| 202 | INVALID_AMOUNT | Dobírková částka je vyšší než celková cena objednávky | CHYBA |
| 203 | MISSING_REQUIRED_ZPRO_ORDER_NUMBER | Neuvedeno číslo objednávky ZPRO | CHYBA |
| 204 | INVALID_VS_PARCEL | Variabilní symbol není číslo | CHYBA |
| 205 | INVALID_PARCEL_CODE | Zadané ID zásilky není v rozmezí vaší přidělené číselné řady | CHYBA |
| 206 | MISSING_PARCEL_CUSTOM_GOODS | Neuvedena data celní prohlášky | CHYBA |
| 207 | MISSING_CATEGORY_CUSTOM_DECALARATION | Neuvedena kategorie zásilky | CHYBA |
| 208 | MISSING_CURRENCY_CUSTOM_DECALARATION | Neuvedena měna celní hodnoty | CHYBA |
| 209 | INVALID_QUANTITY_CUSTOM_GOOD | Množství celního obsahu mimo povolený rozsah | CHYBA |
| 210 | MISSING_QUANTITY_CUSTOM_GOOD | Neuvedeno množství celního obsahu | CHYBA |
| 211 | INVALID_WEIGHT_CUSTOM_GOOD | Hmotnost celního obsahu mimo povolený rozsah | CHYBA |
| 212 | MISSING_WEIGHT_CUSTOM_GOOD | Neuvedena hmotnost celního obsahu | CHYBA |
| 213 | MISSING_PRICE_CUSTOM_GOOD | Neuvedena celní hodnota položky | CHYBA |
| 214 | MISSING_ISO_CUSTOM_GOOD | Neuvedena země původu zboží | CHYBA |
| 215 | MISSING_HS_CODE_CUSTOM_GOOD | Neuveden tarifní kód | CHYBA |
| 216 | MISSING_CONTENT_CUSTOM_GOOD | Neuveden popis obsahu zboží | CHYBA |
| 217 | INVALID_PRICE_CURRENCY | Nesouhlasí měna udané ceny | CHYBA |
| 218 | INVALID_AMOUNT_CURRENCY | Nesouhlasí měna dobírky | CHYBA |
| 219 | MISSING_ADDRESSEE_ZIP_CODE | PSČ adresáta musí být vyplněno | CHYBA |
| 220 | MISSING_ADDRESSEE_CITY | Obec adresáta musí být vyplněna | CHYBA |
| 221 | INVALID_WEIGHT_CUSTOM_GOOD_SUMMARY | Celková hmotnost zboží je vyšší než hmotnost uvedená u zásilky | CHYBA |
| 222 | MISSING_PARCEL_CUSTOM_GOOD | Neuvedena zásilka k položkám obsahu zboží | CHYBA |
| 223 | INVALID_WEIGHT | Váhové rozmezí je mimo povolený rozsah | CHYBA |
| 224 | INVALID_ORDER_NUMBER | "Číslo objednávky nelze použít, ještě nedošlo k jejímu odeslání " | CHYBA |
| 225 | INVALID_PREFIX | Nesouhlasí typ zásilky s typem produktu dané dávky | CHYBA |
| 226 | INVALID_CONTENT_CUSTOM_GOOD | Celní hodnota položky je mimo povolený rozsah | CHYBA |
| 227 | INVALID_CUSTOM_GOOD_NUMBER | Počet položek celního obsahu mimo povolený rozsah | CHYBA |
| 228 | MISSING_REQUIRED_VOUCHER_PRICE | Neuvedena částka | CHYBA |
| 230 | MISSING_REQUIRED_PAYDAY | Termín výplaty není uveden | CHYBA |
| 231 | INVALID_PAYDAY | Termín výplaty je mimo povolené rozmezí 365 dní | CHYBA |
| 232 | INVALID_PAYDAY | Termín výplaty není platné datum | CHYBA |
| 240 | MISSING_REQUIRED_SERVICE 3/32/33 | Neuvedena povinná služba 3 ani 32 ani 33 | CHYBA |
| 241 | MISSING_REQUIRED_SERVICE_10 | Neuvedena služba 10 | CHYBA |
| 242 | MISSING_REQUIRED_SERVICE 1A/1B | Neuvedena povinná služba 1A ani 1B | CHYBA |
| 243 | MISSING_REQUIRED_SERVICE | Neuvedeny dispozice pro nakládání se zásilkou | CHYBA |
| 243 | MISSING_REQUIRED_SERVICE | Neuveden způsob vrácení zásilky (ekonom./let.) | CHYBA |
| 245 | MISSING_RETURN_NUMBER_DAYS | Neuveden počet dní pro vrácení zásilky | CHYBA |
| 246 | INVALID_RETURN_NUMBER_DAYS | Počet dní pro vrácení zásilky mimo povolený rozsah | CHYBA |
| 247 | INVALID_ADRESS | Nepovolená provozovna pro adresu typu Balíkovna | CHYBA |
| 248 | INVALID_ADRESS | Adresa je vhodná pouze pro produkt balík do Balíkovny | CHYBA |
| 250 | MISSING_REQUIRED_EMAIL | Není uveden povinný údaj e-mail adresáta | CHYBA |
| 252 | MISSING_REQUIRED_FIRST_NAME_ADDRESSEE_DOCUMENT | Neuvedeno jméno adresáta dokumentů | CHYBA |
| 253 | INFO_INEXACT_ADDRESS | Nepřesná (nejednoznačná) adresa | INFO |
| 254 | INVALID_PARCEL_CODE | Chybné ID čárového kódu | CHYBA |
| 255 | INVALID_PARCEL_CODE | Chybné ID čárového kódu | CHYBA |
| 256 | DUPLICATE_PARCEL_CODE | Duplicitní ID čárového kódu | CHYBA |
| 257 | INVALID_ADRESS | Adresa je vhodná pouze pro vnitrostátní zásilky | CHYBA |
| 258 | MISSING_VS | Nevyplněn variabilní symbol | CHYBA |
| 259 | MISSING_ADDRESSEE_CITY | Není uveden povinný údaj - město adresáta | CHYBA |
| 260 | MISSING_ADDRESSEE_STREET | Není uveden povinný údaj – ulice adresáta | CHYBA |
| 261 | MISSING_SIZE_CATEGORY | Neuvedena rozměrová kategorie zásilky | CHYBA |
| 262 | INVALID_PRICE | Udaná cena mimo povolený rozsah | CHYBA |
| 263 | INFO_SPECIAL_PACKAGING_REQUEST | Pozor – požadavek na speciální balení zásilky | INFO |
| 264 | INVALID_PRICE | Službu Cenný obsah je možné zvolit až od 10 tis. Kč | CHYBA |
| 265 | INVALID_WEIGHT_CUSTOM_GOOD_SUMMARY | Celková hmotnost zboží je vyšší než hmotnost uvedená u zásilky | CHYBA |
| 266 | INVALID_HS_CODE_CUSTOM_GOOD | Nesprávný formát tarifního kódu | CHYBA |
| 267 | MISSING_REQUIRED_SERVICE_4/5/41 | K dobírkové částce neuvedena dopl. sl. Dobírka | CHYBA |
| 268 | MISSING_AMOUNT | K dopl. sl. Dobírka neuvedena dobírková částka | CHYBA |
| 269 | MRN_CODE_ALREADY_USED | MRN již bylo použito | CHYBA |
| 275 | INVALID_MASTER_PARCEL_CODE_CONTROL | Nesouhlasí kontrolní číslo v ID řídící zásilky | CHYBA |
| 276 | INVALID_MASTER_PARCEL_CODE | Nesouhlasí technologické číslo s ID řídící zásilky | CHYBA |
| 277 | MISSING_MASTER_PARCEL_CODE | Neuvedeno ID řídící zásilky | CHYBA |
| 278 | MISSING_PARCEL_CODE | Neuvedeno ID zásilky | CHYBA |
| 279 | MISSING_SEQUENCE | Neuvedeno pořadí zásilky v rámci VK III | CHYBA |
| 280 | MISSING_QUANTITY | Neuveden celkový počet zásilek v rámci VK III | CHYBA |
| 281 | INVALID_PARCEL/MASTER_CODE | Nesouhlasí ID zásilky s ID řídící zásilky | CHYBA |
| 282 | INVALID_BANK_CODE | Neplatný kód banky | CHYBA |
| 283 | INVALID_BANK_ACCOUNT | Chybný účet nebo předčíslí | CHYBA |
| 284 | MISSING_REQUIRED_SERVICE 3/32/33/44 | Neuvedena povinná služba 3 ani 32 ani 33 ani 44 | CHYBA |
| 285 | MISSING_REQUIRED_SERVICE 20/22 | Neuvedena povinná služba 20 ani 22 | CHYBA |
| 300 | MISSING_ADDRESSEE | Adresát neuveden | CHYBA |
| 301 | INFO_CITY_CHANGED | "V adrese byl upraven údaj ""obec"" dle zadaného psč " | INFO |
| 302 | MISSING_ADDRESS | Nepovolená kombinace adresy a subjektu | CHYBA |
| 303 | INFO_INVALID_BIRTH_DAY | Neplatný formát data narození | INFO |
| 304 | INFO_INVALID_MOBIL_NUMBER | Mobil - neplatné telefonní číslo | INFO |
| 305 | INFO_INVALID_TELEPHONE_NUMBER | Telefon - neplatné telefonní číslo | INFO |
| 306 | INFO_INVALID_PREFIX_ACCOUNT | Předčíslí není číslo | INFO |
| 307 | INFO_INVALID_ACCOUNT | Účet není číslo | INFO |
| 308 | INFO_INVALID_BANK_CODE | Banka není číslo | INFO |
| 309 | INVALID_ADDRESS | Chybná adresa - neexistující PSČ nebo obec | CHYBA |
| 310 | INVALID_PREFIX | Neplatný typ zásilky | CHYBA |
| 311 | INVALID_PREFIX | Nesouhlasí typ zásilky s ID zásilky | CHYBA |
| 312 | INFO_CANCEL_SERVICE_29 | Zrušena služba 29 - nepovolená služba pro typ adresy Poste restante /P.O:Box | INFO |
| 313 | INFO_INVALID_WEIGHT | Hmotnost není číslo | INFO |
| 314 | INFO_INVALID_PRICE | Udaná cena není číslo | INFO |
| 315 | INFO_INVALID_AMOUNT | Dobírka není číslo | INFO |
| 316 | INVALID_AMOUNT_CURRENCY | Nesouhlasí měna dobírkove částky | CHYBA |
| 317 | INFO_INVALID_SPEC_SYMBOL | Specifický symbol není číslo | INFO |
| 318 | INFO_CANCEL_SERVICE_27 | Zrušena služba 27 - nepovolená služba pro adresáta s PSČ Výdejního místa | INFO |
| 319 | INVALID_SERVICE_18 | Nepovolená kombinace adresy a služby Doruč v So | CHYBA |
| 320 | INVALID_SERVICE_19 | Nepovolená kombinace adresy a služby Doruč v Ne/sv | CHYBA |
| 321 | INFO_CANCEL_SERVICE_30 | "Zrušena služba 30 - nepovolená služba u produktu Balík Do ruky nad 31,5 kg " | INFO |
| 322 | INFO_CANCEL_SERVICE_31 | "Zrušena služba 31 - nepovolená služba u produktu Balík Do ruky nad 31,5 kg " | INFO |
| 323 | INFO_CANCEL_SERVICE_47 | "Zrušena služba 47 - nepovolená služba u produktu Balík Do ruky do 31,5 kg " | INFO |
| 324 | INFO_SERVICE_29+47 | "Zásilku s výškou nad 150cm nelze podat jako Balík Do ruky se sl.47, ale musí být využit Balík Nadrozměr v kategorii NZ 2 " | INFO |
| 325 | INFO_CANCEL_SERVICE_34 | Zrušena služba 34 - nesprávný formát telefonního čísla | INFO |
| 326 | INFO_CANCEL_SERVICE_45 | Zrušena služba 45 - nesprávný formát telefonního čísla nebo emailu | INFO |
| 327 | MISSING_REQUIRED_EMAIL | Není uveden povinný údaj e-mail adresáta | CHYBA |
| 328 | INFO_CANCEL_SERVICE_25 | Zrušena služba 25 - neuvedena povinná služba 24 k této službě | INFO |
| 329 | MISSING_REQUIRED_PARCEL_CODE | Neuvedeno ID zásilky | CHYBA |
| 330 | INVALID_PARCEL_CODE | Nepovolené ID zásilky | CHYBA |
| 331 | MISSING_PALETTS_NUMBER | Neuveden počet palet | CHYBA |
| 332 | INFO_CANCEL_PALETTS_NUMBER | Počet palet není celé číslo | INFO |
| 333 | INFO_CANCEL_WIDTH | Šířka není celé číslo | INFO |
| 334 | INFO_CANCEL_HEIGHT | Výška není celé číslo | INFO |
| 335 | INFO_CANCEL_LENGTH | Délka není celé číslo | INFO |
| 336 | MISSING_REQUIRED_PRICE | Neuvedena částka udané ceny | CHYBA |
| 337 | INVALID_AMOUNT_TYPE | Neuveden typ dobírky | CHYBA |
| 338 | INFO_CANCEL_VS_VOUCHER | Variabilní symbol poukázky není číslo | INFO |
| 339 | INVALID_SERVICE_COMBINATION | Nepovolená kombinace doplňkových služeb | CHYBA |
| 340 | INVALID_MRN_CODE | Neplatný kód MRN | CHYBA |
| 341 | INFO_CANCEL_SERVICE_34 | Zrušena služba 34 - nesprávný formát telefonního čísla | INFO |
| 342 | INFO_CANCEL_SERVICE_46 | Zrušena služba 46 - nesprávný formát e-mailu | INFO |
| 343 | INFO_CANCEL_SERVICE_45 | Zrušena služba 45 - nesprávný formát telefonního čísla nebo e-mailu | INFO |
| 344 | MISSING_REQUIRED_ADDRESSEE_DOCUMENT | Adresát dokumentů neuveden | CHYBA |
| 345 | INVALID_ADDRESS_ADDRESSEE_DOCUMENT | Chybná adresa adresáta dokumentů - neexistující PSČ nebo obec | CHYBA |
| 346 | INVALID_ADDRESS_ADDRESSEE_DOCUMENT | Nepřesná adresa adresáta dokumentů - nenalezen objekt | CHYBA |
| 347 | INF0_CANCEL_MOBIL_OR_EMAIL_ADDRESSEE_DOCUMENT | Mobil - neplatné telefonní číslo nebo e-mail adresáta dokumentů | INFO |
| 348 | INFO_CANCEL_CUST_CARD_NUMBER | Nesprávný formát zákaznické karty | INFO |
| 349 | INFO_CANCEL_CUST_CARD_NUMBER_ADDRESSEE_DOCUMENT | Nesprávný formát zákaznické karty adresáta dokumentů | INFO |
| 350 | INVALID_ZPRO_ORDER_NUMBER | Nesprávný formát čísla objednávky ZPRO | CHYBA |
| 351 | INFO_ADD_REQUIRED_SERVICE_75 | Doplněna povinná služba 75 k číslu objednávky ZPRO | INFO |
| 352 | INVALID_PRICE_CURRENCY | Nesouhlasí měna udané ceny | CHYBA |
| 353 | INVALID_CATEGORY_CUSTOM_DECALARATION | Nesprávný formát kategorie zásilky | CHYBA |
| 354 | INVALID_CURRENCY_CUSTOM_DECALARATION | Nesprávný formát měny celní hodnoty | CHYBA |
| 355 | INVALID_QUANTITY_CUSTOM_GOOD | Nesprávný formát množství celního obsahu | CHYBA |
| 356 | INVALID_WEIGHT_CUSTOM_GOOD | Nesprávný formát hmotnosti celního obsahu | CHYBA |
| 357 | INVALID_PRICE_CUSTOM_GOOD | Nesprávný formát hodnoty celní položky | CHYBA |
| 358 | INVALID_ISO_CUSTOM_GOOD | Neexistující země původu zboží | CHYBA |
| 359 | INVALID_ISO_CUSTOM_GOOD | Nesprávný formát země původu zboží | CHYBA |
| 360 | INVALID_HS_CODE_CUSTOM_GOOD | Nesprávný formát tarifního kódu | CHYBA |
| 361 | MISSING_REQUIRED_SERVICE_43/44 | Neuvedena povinná služba č. 43 nebo č. 44 k datům celní prohlášky | CHYBA |
| 362 | INFO_CANCEL_PRICE | Částka není číslo | INFO |
| 363 | INFO_CANCEL_PRICE | Příliš velká částka | INFO |
| 364 | INFO_CANCEL_PERSONAL_IDENTIFICATION_NUMBER | Neplatný formát rodného čísla | INFO |
| 365 | INVALID_ADDRESSEE | Chybný adresát | CHYBA |
| 366 | INVALID_RESPONSIBLE_CONSIGNMENT_NUMBER | "Hodnota ""počet odpovědních zásilek"" je mimo povolený rozsah " | CHYBA |
| 367 | INVALID_RESPONSIBLE_CONSIGNMENT_NUMBER | Nesprávný formát počtu odpovědních zásilek | CHYBA |
| 368 | INVALID_RESPONSIBLE_CONSIGNMENT_NUMBER | Počet odpovědních zásilek při vyplnění ID zásilky nelze importovat | CHYBA |
| 369 | INFO_CANCEL_SERVICE_1A/1B | Zrušena služba 1A/1B - nepovolená ke službě 40 | INFO |
| 370 | INFO_CANCEL_SERVICE_1A | Zrušena služba 1A – nepovolená ke službě 40 | INFO |
| 371 | INFO_CANCEL_SERVICE_1B | Zrušena služba 1B – nepovolena k PSČ adresáta | INFO |
| 372 | INVALID_TARE_WEIGHT | Hmotnost obalu je mimo povolený rozsah | CHYBA |
| 373 | INVALID_NUMBER_CLOSURE | Duplicitní číslo uzávěru | CHYBA |
| 374 | INVALID_PARCEL_CODE | Duplicitní ID zásilky v rámci souboru | CHYBA |
| 375 | INVALID_TIMING | Nesprávný předstih podání | CHYBA |
| 376 | INFO_CANCEL_SERVICE_1A+1B | Zrušena služba 1A a 1B - nepovolená kombinace doplňkových služeb | INFO |
| 377 | INFO_CANCEL_SERVICE_1B | Zrušena služba 1B | INFO |
| 378 | INVALID_PREFIX_COMBINATION | Zásilka je chybně přiřazena k ID tiskové šablony | CHYBA |
| 379 | PARCEL_DOES_NOT_MEET_THE_REQUIREMENTS_FORM | Parametry zásilky nesplňují podmínky požadovaného formuláře | CHYBA |
| 380 | NO_CONTRACT_SERVICE_RETURN_RECEIPT | K formuláři není sjednána smlouva ke službě Dodejka | CHYBA |
| 381 | INFO_CANCEL_SERVICE_1B_ADD_SERVICE_1A | "Služba 1B není povolena k PSČ adresáta, nahrazena službou 1A" | INFO |
| 382 | INFO_CANCEL_SERVICE_1A | Zrušena služba 1A – nepovolena k PSČ adresáta | INFO |
| 383 | INVALID_CUSTOMER_CARD_NUMBER | Chybné číslo zákaznické karty | CHYBA |
| 384 | BAD_FORMAT_RETURN_NUMBER_DAYS | Neplatný formát počtu dní pro vrácení zásilky | CHYBA |
| 385 | INFO_ADD_SERVICE_1B | Přiřazena služba 1B Doruč. 13-19 hod | INFO |
| 386 | INFO_ADD_SERVICE_1A | Přiřazena služba 1A Doruč. 8-14 hod | INFO |
| 387 | INFO_CANCEL_SERVICE_1A | Zrušena služba 1A Doruč. 8-14 hod - nepovolena se službou 1B | INFO |
| 388 | INFO_CANCEL_SERVICE_1B | Zrušena služba 1B Doruč. 13-19 hod - nepovolena se službou 1A | INFO |
| 389 | INFO_CANCEL_SERVICE_1V | Zrušena nepovolená služba 1V - Vrácení zboží | INFO |
| 390 | INFO_ADDRESSEE_TO_LONG | Adresát mimo rozsah 40 znaků pro přenos ke zpracování Pk B | INFO |
| 391 | INFO_MISSING_PART_CITY_SERVICE_DELIVERY_ON_SUNDAY/HOLIDAY_MAY_NOT_BE_REALIZED | Neuvedena část obce - sl. Gar. čas dodání v Ne/Sv nemusí být realizována | INFO |
| 392 | NFO_CANCEL_SERVICE_9 | Zrušena nepovolená služba 9 prioritně | INFO |
| 393 | INFO_ADD_SERVICE_9 | Přiřazena služba 9 prioritně | INFO |
| 394 | INFO_CANCEL_SERVICE_1E | Zrušena služba 1E - neuveden kontaktní údaj adresáta | INFO |
| 395 | INFO_CANCEL_SERVICE_5B | Zrušena služba 5B - neuveden kontaktní údaj adresáta | INFO |
| 396 | INFO_CANCEL_SERVICE_5C | Zrušena služba 5C - neuveden kontaktní údaj adresáta | INFO |
| 397 | INFO_CANCEL_SERVICE_5D | Zrušena služba 5D - neuveden kontaktní údaj adresáta | INFO |
| 398 | INFO_CANCEL_SERVICE_5B_AND_5C | Zrušena služba 5B a 5C - nepovolená kombinace doplňkových služeb | INFO |
| 399 | INFO_CANCEL_SERVICE_5B_AND_5D | Zrušena služba 5B a 5D - nepovolená kombinace doplňkových služeb | INFO |
| 400 | INFO_CANCEL_SERVICE_5C_AND_5D | Zrušena služba 5C a 5D - nepovolená kombinace doplňkových služeb | INFO |
| 401 | INFO_INVALID_CATEGORY_CUSTOM_DECALARATION | Uvedena nepovolená kategorie zásilky - nahrazena kategorií Dokumenty' | INFO |
| 402 | INVALID_SUBISO_COUNTRY | Neexistující nebo nesprávný členský stát | CHYBA |
| 403 | NO_CONTRACT_SERVICE_41 | Pro tech. číslo a produkt nesjednána služba bezdokladová dobírka | CHYBA |
| 404 | INVALID_SERVICE_COMBINATION | Nepovolená kombinace doplňkových služeb – rozměr zásilky | CHYBA |
| 405 | INVALID_SERVICE_COMBINATION | Nepovolená kombinace doplňkových služeb – rozměr zásilky a sl.11 (Křehce) | CHYBA |
| 406 | INFO_ADD_SERVICE_1D | Přiřazena služba 1D – cenný obsah | INFO |
| 407 | INFO_CANCEL_SERVICE_1D | Zrušena služba 1D | INFO |
| 408 | INFO_ADDRESS_WAS_MODIFIED | "Adresa není přesná, byla upravena" | INFO |
| 409 | INVALID_ADDRESSE_ZIP_CODE | Chybný formát PSČ adresáta | CHYBA |
| 410 | INVALID_ADDRESSEE | Nesouhlasí země určení s VDD | CHYBA |
| 411 | INCORECT_NUMBER_OF_RECEIVED_PARCELS | Nepořízeny všechny zásilky k VDD | CHYBA |
| 412 | INFO_HS_CODE_WAS_MODIFIED | Upraven tarifní kód na max. počet 6-ti znaků | INFO |
| 413 | INVALID_CATEGORY_CUSTOM_DECALARATION | Nepovolená kategorie zásilky – dárek – jde pouze o zboží/komodity zasílané mezi dvěma fyzickými osobami | CHYBA |
| 414 | MISSING_DOCUMENT_TYPE | Neuveden typ dokumentu | CHYBA |
| 415 | DUPLICIT_DOCUMENT_TYPE | Duplicitní typ dokumentu | CHYBA |
| 416 | MISSING_LOCATION_NAME | Název podacího místa musí být vyplněn | CHYBA |
| 417 | INFO_INVALID_IC_FORMAT | Nesprávný formát IČ | INFO |
| 418 | INFO_INVALID_IC_FORMAT_ADDRESSEE_DOCUMENT | Nesprávný formát IČ adresáta dokumentů | INFO |
| 419 | INVALID_HS_CODE | Neplatný tarifní kód | CHYBA |
| 420 | INVALID_CONTENT_CUSTOM_GOOD | Neplatný popis celního obsahu | CHYBA |
| 421 | INFO_HS_CODE_WAS_MODIFIED | Tarifní kód upraven dle popisu celního obsahu | INFO |
| 422 | INFO_CONTENT_CUSTOM_GOOD_WAS_MODIFIED | Popis celního obsahu upraven dle tarifního kódu | INFO |
| 423 | INFO_NON_EXISTENT_ZIP_CODE_REPLACED | Neexistující PSČ nahrazeno konstantou | INFO |
| 424 | INFO_CANCEL_SERVICE_40 | Zrušena služba 40 - neuveden kontaktní údaj adresáta | INFO |
| 425 | INFO_CANCEL_SERVICE_29 | Zrušena dopl. sl. 29 – neuveden kontaktní údaj | INFO |
| 426 | INFO_CANCEL_SERVICE_40 | Zrušena služba 40 – nepovolena se sl. 29 | INFO |
| 427 | INFO_CANCEL_SERVICE_40 | Zrušena služba 40 – zásilka Poste restante/P.O.Box | INFO |
| 428 | INFO_CANCEL_SERVICE_7K | Zrušena služba 7K - nesjednaná služba pro zákaznické řešení | INFO |
| 429 | INFO_NOTIFICIATON_WAS_MODIFIED | Služba avizování přiřazena dle kontaktních údajů | INFO |
| 430 | INFO_ADDRESS_CHANGED | adresní údaj Poštovní přihrádka nahrazen údajem P.O.Box | INFO |
POST: /sendParcels
The operation is used to transfer data to shipments for further processing. If processing has taken place successfully, the data is automatically forwarded to the post office. The data received in this way for shipments is possible display via the POL web application. The output of this operation is the AsyncResponse object it contains unique ID (idTransaction) needed to determine the result of operation processing, this ID must be passed to the operation GET sendParcels
Operation request parameters
| Item | Parameter description | Comment | ||
|---|---|---|---|---|
| idContract | IDCČK of the submitter's client | It is sent as a parameter in the URI. If not filled in, the IDCČK associated with the API token is used. Not mandatory, it is important for the aggregator | ||
| parcelHeader | ||||
| transmissionDate | Expected date of posting | Only the date is given, e.g. 2022-03-05 | ||
| customerID | Technological number of the Sender | Example M12345 | ||
| postCode | Postcode of Post Office of posting | Postal code of the post office where the consignment will be transported. Post offices are pre-arranged and the customer cannot submit shipments to other post offices | ||
| senderAddress | Sender’s address | It is recommended that you use the locationNumber element to avoid address inconsistencies | ||
| codAddress | COD amount recepient’s address | It is recommended that you use the locationNumber element to avoid address inconsistencies | ||
| codBank | COD amount recepient’s bank account | Also part of locationNumber | ||
| senderContacts | Sender’s contact details | Also part of locationNumber | ||
| locationNumber | Delivery point number | This is the number of the delivery point under which it wants to perform the import - in case of using this item, it is not necessary to state the data senderAddress, codAddress, codBank, senderContacts in the request | ||
| goodToAccept | Indication of whether other correct data should be accepted for processing in the event of a data error | 1 - correct data for shipments received, incorrect ignored, the customer must correct and send only incorrect data. 0 - if there is at least one error in the batch, the whole batch must be corrected and sent again | ||
| parcelDataList | Consignment Data | |||
| parcelDataList.parcelParams | Consignments parameters | |||
| recordID | Unique ID of record | We recommend using application IDs to identify possible error conditions for individual records when generating shipments | ||
| parcelCode | Consignment ID | If it is not specified, ČP assigns the shipment id and monitors the sequence of the series | ||
| prefixParcelCode | Type of consignment (prefix) | Example DR, NB, RR | ||
| weight | Weight | It is given in hundredths. Above 31.5, the shipment is already Oversized | ||
| insuredValue | Declared value | The price at which the shipment will be insured | ||
| amount | Cash on delivery amount | Must be entered during service 41 - Bezdokladová cash on delivery | ||
| currency | ISO code of COD currency | Default CZK | ||
| vsVoucher | Variable symbol – money order | Must be entered during service 41 - Bezdokladová cash on delivery | ||
| sequenceParcel | Order in frame of multi consignment | In the case of a multi-piece, it is necessary to enter for each included consignment | ||
| quantityParcel | Total number of consignmet at multi consignments | In the case of a multi-piece, it is necessary to enter for each included consignment | ||
| note | Note | Internal note | ||
| notePrint | Note for printing | Appears on the label | ||
| parcelDataList.parcelServices | Requested additional services | |||
| Service | Requested additional service | |||
| parcelDataList.parcelAddress | Consignment addressee | |||
| recordID | Internal addressee’s marking | |||
| firstName | Name | |||
| surname | Family name | |||
| company | Company name | |||
| aditionAddress | Additional information to addressee’s name | |||
| subject | Type of addressee | F - Non-legal person / P - Legal person | ||
| address | ||||
| address.street | Street | |||
| address.houseNumber | Descriptive (house) number | |||
| address.sequenceNumber | Orientation (sequence) number | |||
| address.cityPart | Part of the city | |||
| address.city | City | |||
| address.zipCode | Postcode | |||
| address.isoCountry | ISO country code | |||
| address.subIsoCountry | ISO code of district, is required in some cases of international shipments | |||
| address.addressCode | Code of address RUIAN | |||
| mobilNumber | Mobile phone | |||
| phoneNumber | Telephone number | |||
| emailAddress | ||||
| parcelCustomsDeclaration | Datas of customs declaration | To be filled in only if the shipment is outside the EU or if anything needs to be cleared | ||
| category | Parcel (Letter) category | |||
| note | Note | |||
| customValCur | ISO code of the customs value currency | |||
| parcelCustomGoods | Array of individual items to be cleared | |||
| sequence | Sequence | |||
| customCont | Goods description/td> | |||
| quantity | Quantity | |||
| weight | Weight | |||
| customVal | Custom value | |||
| hsCode | HS code | |||
| /td> | iso | Country of origin of the goods |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
GET: /sendParcels/idTransaction/{idTransaction}
Get the result of processing the submitted sendParcels information.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| ResultSendParcelsList | List of processed consignments | ||
| recordNumber | Unique ID of record | ||
| parcelCode | Parcel's ID | ||
| parcelStateResponse | |||
| responseCode | Code of response | ||
| responseText | Description of response |
GET: /sendParcels/stats
Get statistic informations about sendParcels datas.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| dateFrom | Date from | ||
| dateTo | Date to |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| importAll | Sum of all imports | ||
| importErr | Number of failed imports | ||
| importOK | Number of accepted parcels | ||
| parcels | Number of accepted parcels |
POST: /parcelPrinting
The operation is used to obtain address labels.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| printingHeader | |||
| customerID | Technological number of the Sender | ||
| contractNumber | ID defined for the B2B service of the relevant backend - ID CČK of submitter | ||
| idForm | Label form ID | The list can be downloaded in the Basic Information section | |
| shiftHorizontal | Value of shift right (in mm) | ||
| shiftVertical | Value of shift down (in mm) | ||
| position | Position value on A4 paper | ||
| printingData | Items data |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| printingHeaderResult | |||
| printingHeader | |||
| customerID | Technological number of the Sender | ||
| contractNumber | ID defined for the B2B service of the relevant backend - ID CČK of submitter | ||
| idForm | Label form ID | The list can be downloaded in the Basic Information section | |
| shiftHorizontal | Value of shift right (in mm) | ||
| shiftVertical | Value of shift down (in mm) | ||
| position | Position value on A4 paper | ||
| printingStatusResponse | |||
| responseCode | Code of response | ||
| responseText | Description of response | ||
| printingDataResult | Label data in base64 encoding |
POST: /parcelService
Performs validation and data entry, or generation of an address label for the shipment
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idContract | IDCČK of the submitter's client | It is sent as a parameter in the URI. If not filled in, the IDCČK associated with the API token is used. Not mandatory, it is important for the aggregator | |
| parcelServiceHeader | |||
| parcelServiceHeader.parcelServiceHeaderCom | |||
| transmissionDate | Expected date of posting | Only the date is given, e.g. 2022-03-05 | |
| customerID | Technological number of the Sender | ||
| postCode | Postcode of Post Office of posting | ||
| senderCustCardNum | Customer’s (sender) card number | ||
| locationNumber | Delivery point number | This is the number of the delivery point under which it wants to perform the import | |
| parcelServiceHeader.printParams | parameters for label printing | ||
| idForm | Label form ID | The list can be downloaded in the Basic Information section | |
| shiftHorizontal | Value of shift right (in mm) | ||
| shiftVertical | Value of shift down (in mm) | ||
| parcelServiceHeader.position | Position value on A4 paper | ||
| parcelServiceData | Consignment Data | ||
| parcelServiceData.parcelParams | Consignments parameters | ||
| recordID | Unique ID of record | We recommend using application IDs to identify possible error conditions for individual records when generating shipments | |
| parcelCode | Consignment ID | If it is not specified, ČP assigns the shipment id and monitors the sequence of the series | |
| prefixParcelCode | Type of consignment (prefix) | Example DR, NB, RR | |
| weight | Weight | It is given in hundredths. Above 31.5, the shipment is already Oversized | |
| insuredValue | Declared value | The price at which the shipment will be insured | |
| amount | Cash on delivery amount | Must be entered during service 41 - Bezdokladová cash on delivery | |
| currency | ISO code of COD currency | Default CZK | |
| vsVoucher | Variable symbol – money order | Must be entered during service 41 - Bezdokladová cash on delivery | |
| sequenceParcel | Order in frame of multi consignment | In the case of a multi-piece, it is necessary to enter for each included consignment | |
| quantityParcel | Total number of consignmet at multi consignments | In the case of a multi-piece, it is necessary to enter for each included consignment | |
| note | Note | Internal note | |
| notePrint | Note for printing | Appears on the label | |
| parcelServiceData.parcelServices | Requested additional services | ||
| Services are listed in the field | Requested additional service | ||
| parcelServiceData.parcelAddress | Consignment addressee | ||
| recordID | Internal addressee’s marking | ||
| firstName | Name | ||
| surname | Family name | ||
| company | Company name | ||
| aditionAddress | Additional information to addressee’s name | ||
| subject | Type of addressee | F - Non-legal person / P - Legal person | |
| address | |||
| address.street | Street | ||
| address.houseNumber | Descriptive (house) number | ||
| address.sequenceNumber | Orientation (sequence) number | ||
| address.cityPart | Part of the city | ||
| address.city | City | ||
| address.zipCode | Postcode | ||
| address.isoCountry | ISO country code | ||
| address.subIsoCountry | ISO code of district | ||
| address.addressCode | Code of address RUIAN | ||
| mobilNumber | Mobile phone | ||
| phoneNumber | Telephone number | ||
| emailAddress | |||
| parcelCustomsDeclaration | Datas of customs declaration | To be filled in only if the shipment is outside the EU or if anything needs to be cleared | |
| category | Parcel (Letter) category | ||
| note | Note | ||
| customValCur | ISO code of the customs value currency | ||
| parcelCustomGoods | Array of individual items to be cleared | ||
| sequence | Sequence | ||
| customCont | Goods description/td> | ||
| quantity | Quantity | ||
| weight | Weight | ||
| customVal | Custom value | ||
| hsCode | HS code | ||
| /td> | iso | Country of origin of the goods | |
| multipartParcelData | Přidružené zásilky | ||
| multipartParcelData.addParcelData | Data přidružených zásilek | ||
| recordID | Unique ID of record | We recommend using application IDs to identify possible error conditions for individual records when generating shipments | |
| parcelCode | Consignment ID | If it is not specified, ČP assigns the shipment id and monitors the sequence of the series | |
| prefixParcelCode | Type of consignment (prefix) | Example DR, NB, RR | |
| weight | Weight | It is given in hundredths. Above 31.5, the shipment is already Oversized | |
| sequenceParcel | Order in frame of multi consignment | In the case of a multi-piece, it is necessary to enter for each included consignment | |
| quantityParcel | Total number of consignmet at multi consignments | In the case of a multi-piece, it is necessary to enter for each included consignment | |
| multipartParcelData.addParcelDataServices | Services |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| responseHeader | |||
| responseHeader.resultHeader | |||
| responseCode | Code of response | ||
| responseText | Description of response | ||
| responseHeader.resultParcelData | |||
| recordNumber | Unique ID of record | We recommend using application IDs to identify possible error conditions for individual records when generating shipments | |
| parcelCode | Consignment ID | ||
| parcelStateResponse | |||
| parcelStateResponse.responseCode | Code of response | ||
| parcelStateResponse.responseText | Description of response |
POST: /parcelStatus
The operation is used to obtain a list of shipment status
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| parcelIds | Parcel's ID | Up to ten shipments can be entered | |
| language | Prefered language answer |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idParcel | Parcel's ID | ||
| parcelType | Prefix of the parcel (type of the parcel) | ||
| weight | Weight | ||
| amount | Cash on delivery amount | ||
| currency | ISO code of currency of cash on delivery amount | ||
| parcelsQuantity | Quantity | ||
| depositTo | Consignment deposited until | ||
| timeDeposit | Deposit time | ||
| countryOfOrigin | Country of origin | ||
| countryOfDestination | Country of destination | ||
| parcelStatuses | |||
| id | Status ID | ||
| date | Status date | ||
| text | Status text | ||
| postCode | Postcode of status origin | ||
| name | Name of outlet of status origin |
GET: /parcelDataHistory/parcelID/{parcelID}:
Obtaining shipment history
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idContract | ID of submitter (idContract) | ||
| parcelID | Parcel's ID |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| parcelCode | Parcel's ID | ||
| customerID | Technological number of the Sender | ||
| name | Name | ||
| surname | Surname | ||
| company | Company name | ||
| aditionAddress | Additional information to addressee’s name | ||
| address | |||
| street | Street | ||
| houseNumber | Descriptive (house) number | ||
| sequenceNumber | Orientation (sequence) number | ||
| cityPart | Part of the city | ||
| city | City | ||
| zipCode | Postcode | ||
| isoCountry | ISO country code | ||
| subIsoCountry | ISO code of district | ||
| addressCode | Code of address RUIAN | ||
| cashOnDelivery | Cash on delivery amount | ||
| insuredValue | Insured value | ||
| weight | Weight | ||
| services | Additional service | ||
| vsVoucher | Variable symbol of voucher | ||
| vsParcel | Variable symbol of parcel | ||
| currency | ISO code of COD currency | ||
| height | Height | ||
| width | Width | ||
| lenght | Length | ||
| volumeWeight | Weight of volume | ||
| payoutAmount | Payout amount | ||
| payoutAmountSum | Sum of payout amounts for multi-part package | ||
| sumWeight | Sum of weight's of multi-part package | ||
| sequenceParcel | Order in the case of a multi-part package | ||
| quantityParcel | Sum of parts in multi-part package | ||
| creditedData | |||
| deliveryPostCode | The postal code of delivery office that paid the cash on delivery amount | ||
| deliveryPostOfficeName | Name of the delivery office | ||
| paymentDate | Date of payment in the delivery post office | ||
| serialSubnumber | Subnumber of serial number | ||
| transactionDate | Date of the transaction | ||
| senderCustCardNum | Number of customer card |
POST: /letterWithCN22
Stores data of submitted shipments for OLZ. Asynchronous.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idContract | IDCČK of the submitter's client | It is sent as a parameter in the URI. If not filled in, the IDCČK associated with the API token is used. Not mandatory, it is important for the aggregator | |
| letterHeader | |||
| transmissionDate | Expected date of posting | Only the date is given, e.g. 2022-03-05 | |
| customerID | Technological number of the Sender | ||
| postCode | Postcode of Post Office of posting | ||
| contractNumber | Order number | The customer may have a specific order with the Post Office, the order number is given here | |
| frankingNumber | Payout machine number | ||
| senderCustCardNum | Number of customer card | ||
| locationNumber | Delivery point number | This is the number of the delivery point under which it wants to perform the import | |
| letterData | Data of letters | ||
| letterData.letterParams | Parameters of letters | ||
| recordID | Unique ID of record | We recommend using application IDs to identify possible error conditions for individual records when generating shipments | |
| parcelCode | Consignment ID | ||
| weight | Weight | ||
| note | Note | ||
| note2 | Note | ||
| letterParams.letterServices | Requested additional services | ||
| services are listed in the field | Requested additional service | ||
| letterAddress | Recipient's address | ||
| letterAddress.title | Recipient's information | ||
| recordID | Internal identification of the addressee | ||
| firstName | Name | ||
| surname | Family name | ||
| company | Company name | ||
| aditionAddress | Additional information to addressee’s name | ||
| subject | Type of addressee | F - Non-legal person / P - Legal person | |
| ic | CIN - company identification number | ||
| dic | VATIN - value added tax identification number | ||
| specification | Specification, eg. birthdate | ||
| letterAddress.address | Recipient's address | ||
| street | Street | ||
| houseNumber | Descriptive (house) number | ||
| sequenceNumber | Orientation (sequence) number | ||
| cityPart | Part of the city | ||
| city | City | ||
| zipCode | Postcode | ||
| isoCountry | ISO country code | ||
| subIsoCountry | ISO code of district | ||
| addressCode | Code of address RUIAN | ||
| letterAddress.bank | Recepient’s bank account | ||
| prefixAccount | Prefix for account | ||
| account | Číslo účtu | ||
| bank | Bank code | ||
| letterAddress.contact | Contact information | ||
| mobilNumber | Number of mobile phone | ||
| phoneNumber | Phone number | ||
| emailAddress | Email address | ||
| letterAddress.custCardNum | Number of customer card | ||
| letterAddress.adviceInfo | |||
| adviceInformationsList | Informations no.x to delivery note | ||
| adviceNote | Note for delivery note | ||
| letterCustomsDeclaration | |||
| category | Parcel (Letter) category | ||
| note | Note | ||
| customValCur | ISO code of the customs value currency | ||
| importerRefNum | Importer number | ||
| customGoods | |||
| customGoods.sequence | Sequence | ||
| customGoods.customCont | Goods description | ||
| customGoods.quantity | Quantity | ||
| customGoods.weight | Weight | ||
| customGoods.customVal | Custom value | ||
| customGoods.hsCode | HS code | ||
| customGoods.iso | Country of origin of the goods. |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
GET: /letterWithCN22/idTransaction/{idTransaction}
Get the result of processing the submitted letterWithCN22 information
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| parcelParamsResult | |||
| recordNumber | Transaction ID assigned by the B2B module (asynchronous call) | ||
| parcelCode | Transaction ID assigned by the B2B module (asynchronous call) | ||
| parcelStateResponse | Transaction ID assigned by the B2B module (asynchronous call) | ||
| responseCode | Code of response | ||
| responseText | Description of response |
GET: /location/idContract/{idContract}
Lists filing locations, addresses, bank connections, and contacts. These places are used in sendParcel and parcelService operations in the locationNumber parameter.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idContract | ID CCK of submitter |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| locationNumber | Delivery point number | This is the number of the delivery point under which it wants to perform the import - in case of using this item in request, it is not necessary to state the data senderAddress, codAddress, codBank, senderContacts in the request | |
| location | Location details | ||
| locationName | Location name | This is the name of the sender's delivery point | |
| locationNameAddOn | Name of location - addon | ||
| senderAddress | Sender address | ||
| companyName | Company name | ||
| aditionAddress | Added company name information | ||
| street | Street | ||
| houseNumber | Descriptive (house) number | ||
| sequenceNumber | Orientation (sequence) number | ||
| cityPart | Part of the city | ||
| city | City | ||
| zipCode | Postcode | ||
| isoCountry | ISO country code | ||
| subIsoCountry | ISO code of district | ||
| addressCode | Code of address RUIAN | ||
| codAddress | COD amount recepient’s address | ||
| companyName | Company name | ||
| aditionAddress | Added company name information | ||
| street | Street | ||
| houseNumber | Descriptive (house) number | ||
| sequenceNumber | Orientation (sequence) number | ||
| cityPart | Part of the city | ||
| city | City | ||
| zipCode | Postcode | ||
| isoCountry | ISO country code | ||
| subIsoCountry | ISO code of district | ||
| addressCode | Code of address RUIAN | ||
| codBank | COD amount recepient’s bank account | ||
| prefixAccount | Prefix for account | ||
| account | Account number | ||
| bank | Bank code | ||
| senderContacts | Sender’s contact details | ||
| mobilNumber | Number of mobile phone | ||
| phoneNumber | Phone number | ||
| emailAddress | Email address |
DELETE: /location/idContract/{idContract}
Delete the transmitter place, address, bank informations and contatct.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idContract | ID CCK of submitter |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| LocationDeleteResponse | 0 | Response of delete method for deleting location |
POST: /location/idContract/{idContract}
Create and save the transmitter place, address, bank informations and contatct. These places are used in sendParcel and parcelService operations in the locationNumber parameter.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| locationName | Location name | This is the name of the sender's delivery point | |
| locationNameAddOn | Name of location - addon | ||
| senderAddress | Sender address | ||
| companyName | Company name | ||
| aditionAddress | Added company name information | ||
| street | Street | ||
| houseNumber | Descriptive (house) number | ||
| sequenceNumber | Orientation (sequence) number | ||
| cityPart | Part of the city | ||
| city | City | ||
| zipCode | Postcode | ||
| isoCountry | ISO country code | ||
| subIsoCountry | ISO code of district | ||
| addressCode | Code of address RUIAN | ||
| codAddress | COD amount recepient’s address | ||
| companyName | Company name | ||
| aditionAddress | Added company name information | ||
| street | Street | ||
| houseNumber | Descriptive (house) number | ||
| sequenceNumber | Orientation (sequence) number | ||
| cityPart | Part of the city | ||
| city | City | ||
| zipCode | Postcode | ||
| isoCountry | ISO country code | ||
| subIsoCountry | ISO code of district | ||
| addressCode | Code of address RUIAN | ||
| codBank | COD amount recepient’s bank account | ||
| prefixAccount | Prefix for account | ||
| account | Číslo účtu | ||
| bank | Bank code | ||
| senderContacts | Sender’s contact details | ||
| mobilNumber | Number of mobile phone | ||
| phoneNumber | Phone number | ||
| emailAddress | Email address |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| locationStateSenderResponse | |||
| responseCode | Code of response | ||
| responseText | Description of response | ||
| locationStateCodResponse | |||
| responseCode | Code of response | ||
| responseText | Description of response | ||
| locationData | |||
| locationNumber | Delivery point number | This is the number of the delivery point under which it wants to perform the import - in case of using this item in requests, it is not necessary to state the data senderAddress, codAddress, codBank, senderContacts in the request | |
| locationDataResponseList | |||
| locationDataResponseList.responseCode | Code of response | ||
| locationDataResponseList.responseText | Description of response |
GET: /parcelStatuses/current/idParcel/{idParcel}
Get the current status of the consignment - search by id of the consignment.
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idParcel | ID of consignment/parcel |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idParcel | ID of consignment/parcel | ||
| parcelStatus | Extended ParcelStatus, reason included. | ||
| statusID | Status ID | ||
| reasonID | Reason ID | ||
| date | Date format ISO8601 | ||
| statusDescription | Text value of combination of statusID + reasonID | ||
| postOffice | Postcode of the post office of the status origin. | ||
| postOfficeName | Name of the post office |
POST: /report/parcelStatuses/current/period
Get the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| DateFrom | Date and time FROM | 2023-02-26T12:25:39+01:00 | |
| DateTo | Date and time TO | 2023-03-01T20:25:39+01:00 | |
| idContract | The source (partner identification) of the requested data - by ID CCK of submitter. | If you fill in only the contract ID (IDCČK), you will get info for all technology numbers falling under that ID | |
| customerID | The source (partner identification) of the requested data - by Customer ID of submitter | If you also fill in the technology number, you will get info for all shipments of that technology number falling under that IDCČK |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
GET: /result/parcelStatuses/current/period/{idTransaction}
Get the result of request of the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Get the result of request of the current status of the consignments - search by given period |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| parcelStatusCurrentList | Pole zásilek s jednotlivými statusy | ||
| idParcel | ID of consignment/parcel | ||
| parcelStatus | Extended ParcelStatus, reason included. | ||
| statusID | Status ID | ||
| reasonID | Reason ID | ||
| date | Date format ISO8601 | ||
| statusDescription | Text value of combination of statusID + reasonID | ||
| postOffice | Postcode of the post office of the status origin. | ||
| postOfficeName | Name of the post office |
POST: /report/parcelStatusesB2B/period/
Get the result of request of the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| Date | Date FROM | ||
| TimeFrom | Time FROM | Example: TimeFrom=00:00:00.000 | |
| TimeTo | Time TO | Example: TimeTo=23:59:59.999 | |
| idContract | The source (partner identification) of the requested data - by ID CCK of submitter. | If you fill in only the contract ID (IDCČK), you will get info for all technology numbers falling under that ID | |
| customerID | The source (partner identification) of the requested data - by Customer ID of submitter | If you also fill in the technology number, you will get info for all shipments of that technology number falling under that IDCČK |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
GET: /result/parcelStatusesB2B/period/{idTransaction}
Get the result of request of the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Get the result of request of the current status of the consignments - search by given period |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| parcelInfoPeriodList | Shipment fields with shipment information and individual statuses | ||
| parcelCode | Parcel's ID | ||
| statusID | Status ID | ||
| reasonID | Reason ID | ||
| timeStamp | Date and time of consignment status origin | ||
| postOffice | Postcode of the post office of the status origin | ||
| payoutAmount | Payout amount | ||
| weight | Weight | ||
| amount | Cash on delivery amount | ||
| insuredValue | Insured value | ||
| services | Required additional services | ||
| discount | Collection tariff | ||
| variableSymbol | Variable symbol | ||
| custNum | Number of customer by Sender | ||
| zipCodeAddr | Postal code of Addressee |
POST: /report/submittedConsignments
Get the result of request of the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| DateFrom | Date From | Example: DateFrom=2022-11-11T12:25:39+01:00 | |
| DateTo | Date To | Example: DateTo=2022-11-11T12:25:39+01:00 | |
| idContract | The source (partner identification) of the requested data - by ID CCK of submitter. | If you fill in only the contract ID (IDCČK), you will get info for all technology numbers falling under that ID | |
| customerID | The source (partner identification) of the requested data - by Customer ID of submitter | If you also fill in the technology number, you will get info for all shipments of that technology number falling under that IDCČK | |
| prefix | Filter by prefix of the consignments |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
GET: /result/submittedConsignments/{idTransaction}
Get the result of request of the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Get the result of request of the current status of the consignments - search by given period |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| submittedConsignmentsList | Pole zásilek s informacemi o zásilce | ||
| parcelCode | Parcel's ID | ||
| prefix | Prefix of the parcel (type of the parcel) | ||
| transmissionDate | Supposed date of transmission in ISO8601 format | ||
| postCode | Postcode of the filing branch | ||
| postOfficeName | Office name of transmission | ||
| variableSymbol | Variable symbol | ||
| services | Required additional services | ||
| weight | Weight | ||
| amount | Cash on delivery amount | ||
| payoutAmount | Payout amount | ||
| multipartConsignmentMaster | Parcel code of master consignemnt in case of multi-part parcels | ||
| multipartConsignmentOrder | Order of the consingment in case of multi-part parcels | ||
| multipartConsignmentNumber | Number of the consignments in case of multi-part parcels | ||
| customerID | Technological number of the transmitter | ||
| idContractHeadquarters | ID defined for the B2B service of the relevant backend - ID CCK of submitter | ||
| idContractBranch | ID defined for the B2B service of the relevant backend - ID CCK of submitter | ||
| customerCard | Number of customer card | ||
| addressee | Addressee | ||
| name | Name of the addressee | ||
| street | Name of the street (maxLength = 40) | ||
| houseNumber | Descriptive (house) number | ||
| city | City | ||
| zipCode | Postal code | ||
| Email address of addressee | |||
| phone | Phone number of addressee | ||
| deliveryAttemptDate | Date of delivery atempt of the consignment | ||
| deliveryAttemptPostOffice | Zip code of the post office of delivery of the consignment | ||
| deliveryAttemptPostOfficeName | Name of the post office of the consignment's delivery attempt | ||
| deliveryAttemptStatusText | The name of the status when attempted to deliver | ||
| saveToDate | Date of saving of the consignment in the office | ||
| saveToPostOffice | ZipCode of the post office of saving of the consignment | ||
| saveToPostOfficeName | Name of the post office of saving of the consignment | ||
| saveToStatusText | Name of the status when save to the Save post office | ||
| dateD1 | Date for D+1 | ||
| deliveryDate | Date of delivery of the consignment | ||
| priorityD1 | Fulfillment of priority D+1 | ||
| deliveryTime | Time for deliver | ||
| deliveryPostOffice | Post code of the office which deliver | ||
| deliveryPostOfficeName | Name of the post office which deliver | ||
| deliveryStatusText | Name of the status when deliver | ||
| returnDate | Date of return of the consignment, format ISO8601 | ||
| returnPostOffice | Zip code of the post office, when returned | ||
| returnPostOfficeName | Name of the post office, when returned | ||
| returnStatusText | Name of the status when returned | ||
| customerNumberSender | Number of customer (Sender) | ||
| isoCountryTo | ISO code of the country where will be delivered to | ||
| nameCountryTo | Name of the country |
POST: /report/quality/caterror/{catError}
Get the result of request of the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| catError | Kategorie chyby. True - s chybami / false - bez chyb | ||
| DateFrom | Date From | Example: DateFrom=2022-11-21 | |
| DateTo | Date To | Example: DateTo=2022-11-23 | |
| idContract | The source (partner identification) of the requested data - by ID CCK of submitter. | If you fill in only the contract ID (IDCČK), you will get info for all technology numbers falling under that ID | |
| customerID | The source (partner identification) of the requested data - by Customer ID of submitter | If you also fill in the technology number, you will get info for all shipments of that technology number falling under that IDCČK |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Transaction ID assigned by the B2B module (asynchronous call) |
GET: /result/quality/{idTransaction}
Get the result of request of the current status of the consignments - search by given period
Operation request parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| idTransaction | Get the result of request of the current status of the consignments - search by given period |
Operation response parameters
| Item | Parameter description | Comment | |
|---|---|---|---|
| qualityList | Quality information field | ||
| customerID | Technological number of the transmitter | ||
| idContractHeadquarters | ID defined for the B2B service of the relevant backend - ID CCK of submitter | ||
| idContractBranch | ID defined for the B2B service of the relevant backend - ID CCK of submitter | ||
| nameHeadquarters | Name of headquarters | ||
| parcelCode | Parcel's ID | ||
| prefix | Prefix of the parcel (type of the parcel) | ||
| productType | Type of the product | ||
| submissionDate | Supposed date of transmission in ISO8601 format | ||
| submissionPostCode | Postcode of the filing branch | ||
| submissionPostOfficeName | Name of the post office where submissed | ||
| deliveryPostCode | Postcode of the filing branch | ||
| deliveryPostOfficeName | Name of the post office where delivered | ||
| addressAtSubmission | Address at submission | ||
| categoryError | Category error. Specifies the severity of the address error | Zadna_chyba - without errors, Mala_chyba - small error, Stredni_chyba - medium error, Zavazna_chyba - big error | |
| flagErrMdm | Defines whether the address has been cleared or not | Values: - vycistena = cleared, - nevycistena = uncleared | |
| clearedCAD | Determines the quality of the address data from the perspective of the CAD system | CAD_bez_zmeny - CAD without changes, CAD_zmena - CAD with changes, Data_podani_bez_zmeny - Submit datas without changes, Data_podani_zmena - Submit datas with changes, Neurceno - undetermined | |
| adrMatchMdm | Determines the quality of the address data from the perspective of the MDM system | Values: - NOMATCH – ID_DDM was at the entrance, - MATCH0 – the most accurate address, - MATCH1 – less exact address, - MATCH3 - etc.., - NOT_FOUND – address not found | |
| replacementCode | Replacement code | ||
| addressLocation | address | ||
| street | Name of the street | ||
| houseNumber | Descriptive (house) number | ||
| sequenceNumber | Orientation (sequence) number | ||
| cityPart | Part of the city | ||
| city | City | ||
| zipCode | Postal code | ||
| zipCodeAddressee | Postal code | ||
| emailAddressee | Email address of addressee |
Test accounts
The address for test environment: https://b2b-test.postaonline.cz:444/restservices/ZSKService/v1/*
For test accounts, you must specify S, M, L or XL as the service. Accounts do not have a set uniform price. In a live environment, assuming the client has contracted a uniform price, this necessity is eliminated.
| API Token | Secret key | Customer ID | Post code | ID CČK |
|---|---|---|---|---|
| b79b16c2-2f77-450f-91a5-868c3c698a82 | dOJWwjp+BWqUcof3K+3OW6XGTnEpmWerx64TCNk0+0pZnonHdN99NFRIGaJSX0/HTtiu6AGYpKp0mjguzqp+wg== | U066, U124, U126 | 10003, 60011 | 256712001 |
| 113b6ef0-723d-4de4-9f0a-0b426203957a | ZWXwGSe4D2bFy3qGKMV5z80fN1z6pt8TKtlUQ0g3v9Gn78xGFi5wieYyszrVSTAC3gOp+TfOP8zkAH43gWPWIw== | U062, U118, U121 | 37271 | 194402001 |
| ae9007cf-57b9-471b-b443-cda0bb2ba31e | /qzdUBd3JnRFOcpLJNVdKGNi4sq2XpMGIMpl51bQ4XhXSc4FEZKzIxoPhbxLO4wk9hknaJjo4NEcyc2XK5JUYA== | U061, U114, U116 | 77072 | 167463001 |
| d7e3ab6c-85c8-4502-ae49-351529cce9d0 | hkV0h5YH7f4cTSiwsLK4x9E+s9W6s1dznYC8gq7sC+f33dpWOSDMnkXG4ie4eWDCItPrpiJbuHpqgakzvNTEvA== | U060, U070, U067 | 70071 | 153526001 |
Please note that this is a test environment where data is shared between all users. For security reasons, it is forbidden to write production or raw data and protected information (personal data, trade secrets, etc.) in the test environment. We ask users to respect this prohibition. Each user is responsible for adhering to the basic principles of data protection and security when handling data and Česká pošta, s.p. is not responsible for any violation of this prohibition by the user.
Examples
DR sendParcels + No card COD
{ "parcelHeader": { "transmissionDate": "2022-02-01", "customerID": "M00077", "postCode": "10003", "locationNumber": 1, "goodToAccept": true }, "parcelDataList": [ { "parcelParams": { "recordID": "1", "prefixParcelCode": "DR", "weight": "1.20", "insuredValue": 1500, "amount": 1500, "currency": "CZK", "vsVoucher": "28988358", "length": 100, "width": 34, "height": 12 }, "parcelAddress": { "recordID": "1", "firstName": "Jan", "surname": "Novák", "aditionAddress": "areál MÚ", "subject": "F", "address": { "street": "Těšínská", "houseNumber": "42", "sequenceNumber": "2672", "cityPart": "Předměstí", "city": "Opava", "zipCode": "74601", "isoCountry": "CZ", "addressCode": 30821647 }, "mobilNumber": "+420603123456", "emailAddress": "jan.novak@email.cz", "custCardNum": "1000008444201" }, "parcelServices": [ "7", "41", "45", "M" ] } ] }
DR parcelService + No card COD
{"parcelServiceHeader":{"parcelServiceHeaderCom":{"transmissionDate":"2022-03-05","customerID":"M00077","postCode":"10003","locationNumber":1},"printParams":{"idForm":101,"shiftHorizontal":0,"shiftVertical":0},"position":1},"parcelServiceData":{"parcelParams":{"recordID":"1","prefixParcelCode":"DR","weight":"1.20","insuredValue":100,"amount":105,"currency":"CZK","vsVoucher":"123456","vsParcel":"5955819014","length":10,"width":20,"height":30},"parcelAddress":{"recordID":"1","firstName":"John","surname":"Doe","address":{"street":"Těšínská","houseNumber":"42","sequenceNumber":"2672","cityPart":"Předměstí","city":"Opava","zipCode":"74601","isoCountry":"CZ"},"mobilNumber":"+420904222163","emailAddress":"name.surname123@somemaildomain.cz"},"parcelServices":["7","41","45","M"]}}
NB sendParcels + No card COD
{ "parcelHeader": { "transmissionDate": "2022-02-01", "customerID": "M00077", "postCode": "12000", "locationNumber": 1, "goodToAccept": true }, "parcelDataList": [ { "parcelParams": { "recordID": "1", "prefixParcelCode": "NB", "weight": "100.20", "insuredValue": 1500, "amount": 1500, "currency": "CZK", "vsVoucher": "28988358", "length": 100, "width": 34, "height": 12 }, "parcelAddress": { "recordID": "1", "firstName": "Jan", "surname": "Novák", "address": { "street": "Balíkovna", "city": "Opava", "zipCode": "74606" }, "mobilNumber": "+420603123456", "emailAddress": "jan.novak@email.cz" }, "parcelServices": [ "7", "41", "45", "M" ] } ] }
NP sendParcels + No card COD
{ "parcelHeader": { "transmissionDate": "2022-02-01", "customerID": "M00077", "postCode": "12000", "locationNumber": 1, "goodToAccept": true }, "parcelDataList": [ { "parcelParams": { "recordID": "1", "prefixParcelCode": "NP", "weight": "100.20", "insuredValue": 1500, "amount": 1500, "currency": "CZK", "vsVoucher": "28988358", "length": 100, "width": 34, "height": 12 }, "parcelAddress": { "recordID": "1", "firstName": "Jan", "surname": "Novák", "address": { "street": "Na poštu", "zipCode": "74608" }, "mobilNumber": "+420603123456", "emailAddress": "jan.novak@email.cz" }, "parcelServices": [ "7", "41", "45", "M" ] } ] }
DR sendParcels + Multiparcel + No card COD
{"parcelHeader":{"transmissionDate":"2022-03-17","customerID":"M00077","postCode":"10003","locationNumber":1,"goodToAccept":true},"parcelDataList":[{"parcelParams":{"recordID":"1","prefixParcelCode":"DR","weight":"2.20","insuredValue":1500,"amount":1500,"currency":"CZK","vsVoucher":"28988358","sequenceParcel":1,"quantityParcel":4,"length":100,"width":34,"height":12},"parcelAddress":{"recordID":"1","firstName":"Jan","surname":"Novák","aditionAddress":"areál MÚ","subject":"F","address":{"street":"Těšínská","houseNumber":"42","sequenceNumber":"2672","cityPart":"Předměstí","city":"Opava","zipCode":"74601","isoCountry":"CZ","addressCode":30821647},"mobilNumber":"+420603123456","emailAddress":"jan.novak@email.cz"},"parcelServices":["7","41","45","M","70"]},{"parcelParams":{"recordID":"1","prefixParcelCode":"DR","weight":"1.20","insuredValue":1500,"amount":1200,"currency":"CZK","vsVoucher":"28988358","sequenceParcel":2,"quantityParcel":4,"length":100,"width":34,"height":12},"parcelAddress":{"recordID":"2","firstName":"Karel","surname":"Haviř","aditionAddress":"areál MÚ","subject":"F","address":{"street":"Otická","houseNumber":"42","city":"Opava","zipCode":"74601","isoCountry":"CZ","addressCode":30821647},"mobilNumber":"+420603123987","emailAddress":"jan.novak@email.cz"},"parcelServices":["7","41","45","M","70"]},{"parcelParams":{"recordID":"1","prefixParcelCode":"DR","weight":"1.20","insuredValue":1500,"amount":1200,"currency":"CZK","vsVoucher":"28988358","sequenceParcel":3,"quantityParcel":4,"length":100,"width":34,"height":12},"parcelAddress":{"recordID":"2","firstName":"Karel","surname":"Haviř","aditionAddress":"areál MÚ","subject":"F","address":{"street":"Otická","houseNumber":"42","city":"Opava","zipCode":"74601","isoCountry":"CZ","addressCode":30821647},"mobilNumber":"+420603123987","emailAddress":"jan.novak@email.cz"},"parcelServices":["7","41","45","M","70"]},{"parcelParams":{"recordID":"1","prefixParcelCode":"DR","weight":"1.20","insuredValue":1500,"amount":1200,"currency":"CZK","vsVoucher":"28988358","sequenceParcel":4,"quantityParcel":4,"length":100,"width":34,"height":12},"parcelAddress":{"recordID":"2","firstName":"Karel","surname":"Haviř","aditionAddress":"areál MÚ","subject":"F","address":{"street":"Otická","houseNumber":"42","city":"Opava","zipCode":"74601","isoCountry":"CZ","addressCode":30821647},"mobilNumber":"+420603123987","emailAddress":"jan.novak@email.cz"},"parcelServices":["7","41","45","M","70"]}]}
DR parcelService + Multiparcel + No card COD
{"parcelServiceHeader":{"parcelServiceHeaderCom":{"transmissionDate":"2022-03-05","customerID":"M00077","postCode":"10003","locationNumber":1},"printParams":{"idForm":101,"shiftHorizontal":0,"shiftVertical":0},"position":1},"parcelServiceData":{"parcelParams":{"recordID":"1","prefixParcelCode":"DR","weight":"1.20","insuredValue":100,"amount":105,"currency":"CZK","vsVoucher":"123456","vsParcel":"5955819014","sequenceParcel":1,"quantityParcel":4},"parcelAddress":{"recordID":"1","firstName":"Jan","surname":"Novák","address":{"street":"Těšínská","houseNumber":"42","sequenceNumber":"2672","cityPart":"Předměstí","city":"Opava","zipCode":"74601","isoCountry":"CZ"},"mobilNumber":"+420603488433","emailAddress":"name.surname123@somemaildomain.cz"},"parcelServices":["7","41","45","M","70"]},"multipartParcelData":[{"addParcelData":{"recordID":"2","prefixParcelCode":"DR","weight":"1.20","sequenceParcel":2,"quantityParcel":4},"addParcelDataServices":["70","M"]},{"addParcelData":{"recordID":"3","prefixParcelCode":"DR","weight":"2.20","sequenceParcel":3,"quantityParcel":4},"addParcelDataServices":["70","M"]},{"addParcelData":{"recordID":"4","prefixParcelCode":"DR","weight":"3.20","sequenceParcel":4,"quantityParcel":4},"addParcelDataServices":["70","M"]}]}