O co jde?

Pro Vaše pohodlí nabízíme možnost snadného exportu štítků na Vaše zásilky. Pouhým zavoláním služby obdržíte PDF soubor obsahující štítky na Vámi vybrané zásilky.

K čemu to je?

Export štítků z našeho systému Vám přináší dvě hlavní výhody:

  1. Zásilky nemusíte popisovat ručně.

    Abychom mohli Vaše zásilky spolehlivě doručit adresátovi, potřebujeme mít balíčky správně popsané. To můžete dělat ručně, ale při větším objemu zásilek je to nezanedbatelná práce. Proto nabízíme možnost vyexportovat si štítky přímo z našeho systému. Pak stačí vložit do tiskárny arch lepítek a štítky vytisknout, hotovo.

  2. Máte jistotu, že uvedené údaje jsou správné.

    Pokud zásilky popisujete ručně, může dojít k chybě, jsme jenom lidé. Zbytečně je pak potřeba řešit případné nesrovnalosti. Pokud ale vytisknete štítky vygenerované z našeho systému, pak máte jistotu, že uvedené údaje přesně souhlasí s tím, co jste uvedli v objednávce.

Největší výhodu posyktuje API pro tisk štítků v kombinaci s importovacími službami. Tato dvojice společně umožňuje automatizovaně objednat přepravu a vytisknout štítky, zcela bez zásahu člověka.

Jak to funguje?

Náš systém vystavuje webovou službu. Jejím zavoláním si vyžádáte štítky pro zásilky, které specifikujete pomocí parametrů v URL při volání této služby. Náš systém ihned pro tyto zásilky vygeneruje štítky, které Vám vrátí ve formě PDF souboru. Ten stačí poslat na tiskárnu a máte hotovo.

Technická specifikace

Podporované formáty

V současnosti podporujeme dva rozdílné formáty (tj. velikosti) štítků, které pasují na samolepící etikety nejčastěji používaných rozměrů.

  • A4, 14 štítků na stránce, každý o rozměrech 104 x 42 mm s tolerancí 1-2mm (náhled)

    Nejčastěji používaný formát. Na jednu stránku A4 se se vejde čtrnáct lepítek ve dvou sloupcích a sedmi řádcích.

  • termotisková páska, tisk po jednom štítku, každý o rozměrech 105 x 66 mm (náhled)

    Šablona přizpůsobená na standardní rozměr lepítek na termotiskové pásce pro termotiskárny Zebra. Při použití tohoto formátu je každý štítek ve výsledném souboru umístěn na samostatně stránce o správných rozměrech. Podle našich zkušeností nemají tiskárny Zebra s tiskem takových souborů žádný problém.

Ukázkové soubory

Všechny náhledy souborů výše obsahují pouze jedinou objednávku, která sestává z několika balíků. Po zadání čísla objednávky náš systém vždy vygeneruje štítky pro všechny balíky v této objednávce obsažené. Při tisku štítků pro více objednávek najednou pak samozřejmě v jednom souboru najdete štítky pro všechny vyžádané objednávky, třeba jako tady - dvě objednávky, každá po jednom kuse.

Požadované parametry

Abychom Vám mohli vygenerovat štítky, které chcete, potřebueme od Vás několik málo údajů.

Povinné parametry

Povinný parametr je jen jeden:

Parametr Očekávaný formát Očekávaná hodnota Popis
orderIds pole čísel čísla objednávek, pro které chcete štítek vygenerovat Protože se jedná o pole a službu můžete volat metodou GET, je nutné v tomto případě parametr zopakovat tolikrát, kolik čísel objednávek do služby chcete poslat.

Nepovinné parametry

Nepovinné parametry jsou dva:

Parametr Očekávaný formát Očekávaná hodnota Popis
printFromPosition číslo pořadové číslo štítku, od kterého má tisk začít Pomocí tohoto parametru lze nastavit, na kterou pozici v rámci archu má náš systém umístit první vygenerovaný štítek, což umožňuje přepoužívat již "načaté" archy lepítek. Detailní vysvětlení viz níže.
format číslo identifikátor požadovaného formátu štítků Zadáním tohoto parametru můžete zvolit požadovaný formát, ve kterém Vám štítky vygenerujeme. Přípustné hodnoty a jejich významy jsou:
  • 2 - A4, 10 štítků na stránce
  • 3 - termotisková páska
Více o podporovaných formátech zde. Pokud tento parametr neuvedete, dostanete štítky ve výchozím formátu.

Tisk od pozice

Abychom lépe vysvětlili k čemu je nepovinný parametr printFromPosition dobrý, použijeme příklad:

Představme si, že máme standardní arch lepítek formátu A4, kde jich je 14 ve dvou sloupcích a sedmi řadách. Pokud by byl zcela nový a žádné lepítko by nebylo použito, vypadal by takový arch asi nějak takhle:

1 2
3 4
5 6
7 8
9 10
11 12
13 14

Pro přehlednost jsme si jednolivá lepítka očíslovali zleva doprava a shora dolů. Nyní si představme, že jsme již na tento arch vytiskli tři nějaké štítky a tedy lepítka na pozicích 1 až 3 chybí.
Takový arch by pak vypadal takto (chybějící lepítka znázorněna šedou výplní):

1 2
3 4
5 6
7 8
9 10
11 12
13 14

V tomto případě tedy chceme, aby v souboru, kterým nám vrátí služba pro export štítků, byl první štítek umístěn až na čtvrté pozici. A právě tento požadavek vyjádříme tak, že použijeme parametr printFromPosition, přičemž v tomto konkrétním případě bychom jej nastavili na hodnotu 4. Výsledný soubor by pak mohl vypadat třeba takto.

Dostupné služby

Máte dvě možnosti, jak zavolat službu pro export štítků.

Služba s HTTP přihlašováním

Preferovanou variantou je volání služby, která využívá HTTP Basic přihlašování (více o tomto typu přihlášení zde).
Tuto službu lze nalézt na adrese:

						
https://api.messenger.cz/MessengerWeb/API/REST/public/data/printLabels
						
					

Službu lze volat metodou GET, kde je potřeba předat parametry přímo v URL a metodou POST, kde parametry ve formátu JSON obsahuje tělo požadavku. Pro zásilky v řádu stovek je doporučeno použít POST.

Příklad volání GET:

						
https://api.messenger.cz/MessengerWeb/API/REST/public/data/printLabels?orderIds=123456&orderIds=987654
						
					

Příklad volání POST:

						
https://api.messenger.cz/MessengerWeb/API/REST/public/data/printLabels
						
					

Příklad JSON pro POST:

						
	{
		"printFromPosition": "1",
		"orderIds": [
			"123456","987654"
		]
	}
						
					

Výše uvedené příklady předávájí pouze povinné parametry, kterými je specifikováno, že požadujeme štítky pro objednávky s čísly 123456 a 987654. Štítky pro všechny specifikované objednávky služba vrátí vždy v jediném souboru.

Služba bez HTTP přihlašování

Alternativní variantou je volání služby, která namísto HTTP Basic přihlašování přebírá přihlašovací parametry.
Tuto službu lze nalézt na adrese:

						
https://api.messenger.cz/MessengerWeb/PublicREST/data/printLabels
						
					

Službu lze volat také metodou GET, kde je potřeba předat parametry přímo v URL a metodou POST, kde parametry ve formátu JSON obsahuje tělo požadavku. Pro zásilky v řádu stovek je doporučeno použít POST.

Příklad volání GET:

						
https://api.messenger.cz/MessengerWeb/PublicREST/data/printLabels?customerNumber=[ZAKAZNICKE-CISLO]&password=[HESLO]&orderIds=123456&orderIds=987654
						
					

Příklad volání POST:

						
https://api.messenger.cz/MessengerWeb/PublicREST/data/printLabels
						
					

Příklad JSON pro POST:

						
		{
			"printFromPosition": "1",
			"orderIds": [
				"123456","987654"
			],
			"customerNumber":"[ZAKAZNICKE-CISLO]",
			"password": "[HESLO]"
		}
						
					

Hodnoty přihlašovacích parametrů

V příkladu výše je potřeba nahradit [ZAKAZNICKE-CISLO] a [HESLO] za Vaše přihlašovací údaje.