Integrácia Vášho e-shopu so službou DEPO

Základným cieľom pre vytvorenie integrácie Vášho e-shopu so službou DEPO je sprístupnenie výberu výdajného miesta pre Vášho zákazníka v rámci procesu vytvorenia objednávky na Vašom e-shope. Výber výdajného miesta je možné sprístupniť pomocou vložiteľného HTML kódu alebo pomocou vlastného riešenia.

Integrácia pomocou vložiteľného HTML kódu (iframe)

Tento spôsob predpokladá 2 nevyhnutné kroky:

1. Vloženie HTML kódu na vhodné miesto do zvyšného HTML kódu Vášho e-shopu. V prípade, ak umožňujete zákazníkovi výber z viacerých možností prepravy je nevyhnutné, aby sa vložený HTML zobrazil iba v prípade, v ktorom si zákazník zvolil spôsob doručenia pomocou služby DEPO. Zobrazovanie a schovanie vloženého HTML kódu je možné riešiť napr. pomocou vhodného javascriptu a CSS (vlastnosť display, hodnoty none a block). Zákazník si v rámci obsahu elementu iframe môže vybrať výdajné miesto. Vložiteľný HTML kód je unikátny pre každý e-shop a jeho aktuálny tvar môžete nájsť po prihlásení do klientskej zóny v rámci modulu „Zvolené výdajné miesta zákazníkov“. URL uvedené v rámci elementu <iframe> je nutné modifikovať pre každú objednávku úpravou query parametra „o“. Na miesto textu „unikatne_cislo_objednavky“ je potrebné uviesť unikátny identifikátor objednávky, ktorý môže byť vytvorený podľa ľubovoľného pravidla. V rôznych prípadoch to môže byť napr. id košíka, id objednávky (ak je dostupné), guid alebo náhodný textový reťazec do dĺžky 100 znakov.

Príklady unikátnych URL:
https://admin.depo.sk/eshop?c=12345&o=721413-20160101124555
https://admin.depo.sk/eshop?c=12345&o=a8d56710acc97db
https://admin.depo.sk/eshop?c=12345&o=20160425_36544

Unikátny identifikátor objednávky je potrebné generovať len raz pre každú objednávku a uložiť ho spoločne s ostatnými údajmi o objednávke. Bez jeho znalosti nebude možné zistiť výdajné miesto, ktoré si Váš zákazník zvolil.

2. Ďalším krokom integrácie je overenie, že k výberu výdajného miesta zákazníkom skutočne došlo. Na tento účel slúži API metóda getSelectedPlace, ktorej dokumentácia je uvedená nižšie. API metóda očakáva hodnotu unikátneho identifikátora objednávky vygenerovaného v rámci integrácie v predchádzajúcom bode. Bez správne zvoleného výdajného miesta by nemalo dôjsť k potvrdeniu objednávky a Váš zákazník by mal byť opätovne vyzvaný k zvoleniu výdajného miesta. Údaje o zvolenom výdajnom mieste je potrebné uložiť spoločne s ostatnými údajmi o objednávke.

Integrácia pomocou vlastného riešenia

Inou možnosťou integrácie na strane e-shopu je pravidelné načítavanie (min 1x denne) zoznamu miest, ktoré si e-shop uloží lokálne. Zoznam miest je možné získať pomocou API metódy places, ktorej dokumentácia je uvedená nižšie. Z tohoto zoznamu môžu byť sprístupnený výber (napr. pomocou formulárového elementu select) všetkých alebo vybraných miest, ktoré sú označené ako výdajné (s hodnotou atribútu is_output rovnou 1). Zvolené výdajné miesto si e-shop musí uložiť spoločne s ostatnými údajmi o objednávke.

API metóda: places

Umožňuje získať informácie o miestach na podanie a výdaj zásielok Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

GET https://admin.depo.sk/v2/api/places

Vráti zoznam všetkých miest.

Atribúty

Atribút Popis Povinný
id Id miesta ÁNO
name Názov miesta ÁNO
street Ulica miesta ÁNO
zip PSČ miesta ÁNO
city Obec miesta ÁNO
country Štát miesta ÁNO
latitude Zemepisná šírka miesta NIE
longitude Zemepisná dĺžka miesta NIE
is_input 0/1 informácia o tom, či na mieste je možné podať novú zásielku ÁNO
is_output 0/1 informácia o tom, či na mieste je možné vydať zásielku (odoslať na toto výdajné miesto) ÁNO
open_hours Informácia o aktuálnych otváracích hodinách miesta: type: typ (každý deň|každý pracovný deň|každý deň okrem sviatkov|sviatok|konkrétny dátum|konkrétny deň v týždni) is_open: 0/1 informácia, či je v daný deň otvorené open_time: čas otvorenia (hh:mm:ss) close_time: čas zatvorenia (hh:mm:ss) ÁNO
route Informácia o trase (pre interné účely) NIE
image Fotografia NIE
card_payment_enabled 0/1 informácia o tom, či na mieste je možné platiť kartou ÁNO
foto_by_depo 0/1 informácia o tom, či na mieste je možné využiť službu Foto by depo ÁNO

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/hal+json
application/json

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/hal+json
application/json

Telo

{
   "_links": {
       "self": {
           "href": "/api/places"
       },
       "first": {
           "href": "/api/places?page={page}"
       },
       "prev": {
           "href": "/api/places?page={page}"
       },
       "next": {
           "href": "/api/places?page={page}"
       },
       "last": {
           "href": "/api/places?page={page}"
       }
   },
   "_embedded": {
       "places": [
           {
               "_links": {
                   "self": {
                       "href": "/api/places[/:places_id]"
                   }
               },
              "id": "Id miesta",
              "name": "Názov miesta",
              "street": "Ulica miesta",
              "zip": "PSČ miesta",
              "city": "Obec miesta",
              "country": "Štát miesta",
              "latitude": "Zemepisná šírka miesta",
              "longitude": "Zemepisná dĺžka miesta",
              "is_input": "0/1 informácia o tom, či na mieste je možné podať novú zásielku",
              "is_output": "0/1 informácia o tom, či na mieste je možné vydať zásielku (odoslať na toto výdajné miesto)",
              "open_hours": [{
                 "type": "typ otváracých hodín (každý deň|každý pracovný deň|každý deň okrem sviatkov|sviatok|konkrétny dátum|konkrétny deň v týždni)",
                  "is_open": "0/1 informácia, či je v daný deň otvorené",
                  "open_time": "čas otvorenia (hh:mm:ss)",
                  "close_time": "čas zatvorenia (hh:mm:ss)"
              }],
              "route": "Informácia o trase (pre interné účely)",
              "card_payment_enabled": "0/1 informácia o tom, či na mieste je možné platiť kartou"
              
           }
       ]
   }
}

GET https://admin.depo.sk/v2/api/places[/:id]

Vráti údaje jedného miesta.

Atribúty

Atribút Popis Povinný
id Id miesta ÁNO
name Názov miesta ÁNO
street Ulica miesta ÁNO
zip PSČ miesta ÁNO
city Obec miesta ÁNO
country Štát miesta ÁNO
latitude Zemepisná šírka miesta NIE
longitude Zemepisná dĺžka miesta NIE
is_input 0/1 informácia o tom, či na mieste je možné podať novú zásielku ÁNO
is_output 0/1 informácia o tom, či na mieste je možné vydať zásielku (odoslať na toto výdajné miesto) ÁNO
open_hours Informácia o aktuálnych otváracích hodinách miesta: type: typ (každý deň|každý pracovný deň|každý deň okrem sviatkov|sviatok|konkrétny dátum|konkrétny deň v týždni) is_open: 0/1 informácia, či je v daný deň otvorené open_time: čas otvorenia (hh:mm:ss) close_time: čas zatvorenia (hh:mm:ss) ÁNO
route Informácia o trase (pre interné účely) NIE
image Fotografia NIE
card_payment_enabled 0/1 informácia o tom, či na mieste je možné platiť kartou ÁNO
foto_by_depo 0/1 informácia o tom, či na mieste je možné využiť službu Foto by depo ÁNO

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/hal+json
application/json

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/hal+json
application/json

Telo

{
   "_links": {
       "self": {
           "href": "/api/places[/:places_id]"
       }
   },
   "id": "Id miesta",
   "name": "Názov miesta",
   "street": "Ulica miesta",
   "zip": "PSČ miesta",
   "city": "Obec miesta",
   "country": "Štát miesta",
   "latitude": "Zemepisná šírka miesta",
   "longitude": "Zemepisná dĺžka miesta",
   "is_input": "0/1 informácia o tom, či na mieste je možné podať novú zásielku",
   "is_output": "0/1 informácia o tom, či na mieste je možné vydať zásielku (odoslať na toto výdajné miesto)",
   "open_hours": [{
      "type": "typ otváracých hodín (každý deň|každý pracovný deň|každý deň okrem sviatkov|sviatok|konkrétny dátum|konkrétny deň v týždni)",
      "is_open": "0/1 informácia, či je v daný deň otvorené",
      "open_time": "čas otvorenia (hh:mm:ss)",
      "close_time": "čas zatvorenia (hh:mm:ss)"
    }],
    "route": "Informácia o trase (pre interné účely)",
    "card_payment_enabled": "0/1 informácia o tom, či na mieste je možné platiť kartou"
}

API metóda: packages

Umožňuje získať informácie o registrovaných zásielkách. Klient sa autentifikuje pomocou pridelených prihlasovacích údajov, ktoré sú v požiadavke obsahnuté pomocou mechanizmu HTTP Basic authentication. Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

GET https://admin.depo.sk/v2/api/packages

Vráti zoznam všetkých zásielok registrovaných k prihlásenému kontu.

Atribúty

Atribút Popis Povinný
number Číslo zásielky ÁNO
target Id výdajného miesta pre zásielku (id pochádza z API metódy places) ÁNO
recipient_name Meno a priezvisko príjemcu zásielky ÁNO
recipient_street Ulica príjemcu zásielky (nepovinné) NIE
recipient_zip PSČ príjemcu zásielky (nepovinné) NIE
recipient_city Obec príjemcu zásielky (nepovinné) NIE
recipient_country Krajina príjemcu zásielky (nepovinné) NIE
recipient_phone Mobilné telefónne číslo príjemcu zásielky v medzinárodnom tvare bez medzier a znaku +. Povolené sú len číslice. ÁNO
recipient_email E-mailová adresa príjemcu zásielky ÁNO
cod Suma dobierky ÁNO
cod_currency Mena dobierky ÁNO
insurance Hodnota zásielky ÁNO
insurance_currency Mena hodnoty zásielky ÁNO
size_a Rozmer zásielky a (v centimetroch, nepovinné) NIE
size_b Rozmer zásielky b (v centimetroch, nepovinné) NIE
size_c Rozmer zásielky c (v centimetroch, nepovinné) NIE
weight Hmotnosť zásielky (v gramoch, nepovinné) NIE
service_18plus Služba 18+ (overenie veku príjemcu v DEPO) NIE
sender_reference Interné číslo (nepovinný údaj) NIE
deliver_to_address Doručiť na adresu zákazníka NIE
pickup_from_address Vyzdvihnúť z adresy klienta NIE
recipient_number Číslo domu príjemcu NIE
ref2 Ref2 (nepovinný údaj) NIE
ref3 Ref3 (nepovinný údaj) NIE

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/hal+json
application/json
Authorization HTTP Basic Authorization

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/hal+json
application/json

Telo

{
	"_links": {
		"self": {
			"href": "/api/packages"
		},
		"first": {
			"href": "/api/packages?page={page}"
		},
		"prev": {
			"href": "/api/packages?page={page}"
		},
		"next": {
			"href": "/api/packages?page={page}"
		},
		"last": {
			"href": "/api/packages?page={page}"
		}
	},
	"_embedded": {
		"packages": [{
			"_links": {
				"self": {
					"href": "/api/packages[/:packages_id]"
				}
			},
			"number": "Číslo zásielky",
			"target": "Id výdajného miesta pre zásielku (id pochádza z API metódy places)",
			"recipient_name": "Meno a priezvisko príjemcu zásielky",
			"recipient_street": "Ulica príjemcu zásielky (nepovinné)",
			"recipient_number": "Číslo domu príjemcu zásielky (nepovinné)",
			"recipient_zip": "PSČ príjemcu zásielky (nepovinné)",
			"recipient_city": "Obec príjemcu zásielky (nepovinné)",
			"recipient_country": "Krajina príjemcu zásielky (nepovinné)",
			"recipient_phone": "Mobilné telefónne číslo príjemcu zásielky v medzinárodnom tvare bez medzier a znaku +. Povolené sú len číslice.",
			"recipient_email": "E-mailová adresa príjemncu zásielky",
			"cod": "Suma dobierky",
			"cod_currency": "Mena dobierky",
			"insurance": "Hodnota zásielky",
			"insurance_currency": "Mena hodnoty zásielky",
			"size_a": "Rozmer zásielky a (v centimetroch, nepovinné)",
			"size_b": "Rozmer zásielky b (v centimetroch, nepovinné)",
			"size_c": "Rozmer zásielky c (v centimetroch, nepovinné)",
			"weight": "Hmotnosť zásielky (v gramoch, nepovinné)",
			"service_18plus": "Služba 18+ (overenie veku príjemcu v DEPO) 0 alebo 1 v prípade požadovania služby",
			"sender_reference": "Interné číslo - Ref1, nepovinné",
			"ref2": "Ref2, nepovinné",
			"ref3": "Ref3, nepovinné",
			"deliver_to_address": "Doručiť na adresu zákazníka",
			"pickup_from_address": "Vyzdvihnúť z adresy klienta"
		}]
	}
}

GET https://admin.depo.sk/v2/api/packages[/:id]

Vráti údaje jednej zásielky

Atribúty

Atribút Popis Povinný
number Číslo zásielky ÁNO
target Id výdajného miesta pre zásielku (id pochádza z API metódy places) ÁNO
recipient_name Meno a priezvisko príjemcu zásielky ÁNO
recipient_street Ulica príjemcu zásielky (nepovinné) NIE
recipient_zip PSČ príjemcu zásielky (nepovinné) NIE
recipient_city Obec príjemcu zásielky (nepovinné) NIE
recipient_country Krajina príjemcu zásielky (nepovinné) NIE
recipient_phone Mobilné telefónne číslo príjemcu zásielky v medzinárodnom tvare bez medzier a znaku +. Povolené sú len číslice. ÁNO
recipient_email E-mailová adresa príjemcu zásielky ÁNO
cod Suma dobierky ÁNO
cod_currency Mena dobierky ÁNO
insurance Hodnota zásielky ÁNO
insurance_currency Mena hodnoty zásielky ÁNO
size_a Rozmer zásielky a (v centimetroch, nepovinné) NIE
size_b Rozmer zásielky b (v centimetroch, nepovinné) NIE
size_c Rozmer zásielky c (v centimetroch, nepovinné) NIE
weight Hmotnosť zásielky (v gramoch, nepovinné) NIE
service_18plus Služba 18+ (overenie veku príjemcu v DEPO) NIE
sender_reference Interné číslo (nepovinný údaj) NIE
deliver_to_address Doručiť na adresu zákazníka NIE
pickup_from_address Vyzdvihnúť z adresy klienta NIE
recipient_number Číslo domu príjemcu NIE
ref2 Ref2 (nepovinný údaj) NIE
ref3 Ref3 (nepovinný údaj) NIE

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/hal+json
application/json
Authorization HTTP Basic Authorization

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/hal+json
application/json

Telo

{
	"_links": {
		"self": {
			"href": "/api/packages[/:packages_id]"
		}
	},
	"number": "Číslo zásielky",
	"target": "Id výdajného miesta pre zásielku (id pochádza z API metódy places)",
	"recipient_name": "Meno a priezvisko príjemcu zásielky",
	"recipient_street": "Ulica príjemcu zásielky (nepovinné)",
	"recipient_number": "Číslo domu príjemcu zásielky (nepovinné)",
	"recipient_zip": "PSČ príjemcu zásielky (nepovinné)",
	"recipient_city": "Obec príjemcu zásielky (nepovinné)",
	"recipient_country": "Krajina príjemcu zásielky (nepovinné)",
	"recipient_phone": "Mobilné telefónne číslo príjemcu zásielky v medzinárodnom tvare bez medzier a znaku +. Povolené sú len číslice.",
	"recipient_email": "E-mailová adresa príjemncu zásielky",
	"cod": "Suma dobierky",
	"cod_currency": "Mena dobierky",
	"insurance": "Hodnota zásielky",
	"insurance_currency": "Mena hodnoty zásielky",
	"size_a": "Rozmer zásielky a (v centimetroch, nepovinné)",
	"size_b": "Rozmer zásielky b (v centimetroch, nepovinné)",
	"size_c": "Rozmer zásielky c (v centimetroch, nepovinné)",
	"weight": "Hmotnosť zásielky (v gramoch, nepovinné)",
	"service_18plus": "Služba 18+ (overenie veku príjemcu v DEPO) 0 alebo 1 v prípade požadovania služby",
	"sender_reference": "Interné číslo - Ref1, nepovinné",
	"ref2": "Ref2, nepovinné",
	"ref3": "Ref3, nepovinné",
	"deliver_to_address": "Doručiť na adresu zákazníka",
	"pickup_from_address": "Vyzdvihnúť z adresy klienta"
}

API metóda: send

Metóda na registráciu novej zásielky. Klient sa autentifikuje pomocou pridelených prihlasovacích údajov, ktoré sú v požiadavke obsahnuté pomocou mechanizmu HTTP Basic authentication. Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

POST https://admin.depo.sk/v2/api/packages/send

Metóda na registráciu novej zásielky

Atribúty

Atribút Popis Povinný
target Id výdajného miesta pre zásielku (id pochádza z API metódy places), nie je povinné ak sa požaduje doručenie na adresu zákazníka; textový reťazec; v prípade neuvedenia stačí uviesť prázdny reťazec NIE
recipient_name Meno a priezvisko príjemcu zásielky; textový reťazec; max. dĺžka 200 znakov ÁNO
recipient_street Ulica príjemcu zásielky (nepovinné ak nie je požadované doručenie na adresu príjemcu); textový reťazec; max. dĺžka 200 znakov NIE
recipient_zip PSČ príjemcu zásielky (nepovinné ak nie je požadované doručenie na adresu príjemcu), textový reťazec; v prípade doručenia na adresu musí mať 5 číslic NIE
recipient_city Obec príjemcu zásielky (nepovinné ak nie je požadované doručenie na adresu príjemcu); textový reťazec; max. dĺžka 200 znakov NIE
recipient_country Krajina príjemcu zásielky (nepovinné); textový reťazec; max. dĺžka 200 znakov NIE
recipient_phone Mobilné telefónne číslo príjemcu zásielky v medzinárodnom tvare bez medzier a bez znaku + bez úvodných núl; Povolené sú len číslice; textový reťazec; príklad: 421901123456 ÁNO
recipient_email E-mailová adresa príjemcu zásielky; textový reťazec; musí byť e-mailová adresa v platnom formáte ÁNO
cod Suma dobierky v EUR; číslo; max. 2 desatinné miesta; povolené hodnoty <0, 1000000) NIE
insurance Hodnota zásielky v EUR; číslo; max. 2 desatinné miesta; povolené hodnoty (0, 1000000) ÁNO
size_a Rozmer zásielky a (v centimetroch, nepovinné); číslo; max. 2 desatinné miesta; povolené hodnoty (0, 1000000) NIE
size_b Rozmer zásielky b (v centimetroch, nepovinné); číslo; max. 2 desatinné miesta; povolené hodnoty (0, 1000000) NIE
size_c Rozmer zásielky c (v centimetroch, nepovinné); číslo; max. 2 desatinné miesta; povolené hodnoty (0, 1000000) NIE
weight Hmotnosť zásielky (v gramoch, nepovinné); číslo; max. 2 desatinné miesta; povolené hodnoty (0, 1000000) NIE
service_18plus Služba 18+ (overenie veku príjemcu v DEPO); číslo 0/1 NIE
sender_reference Interné číslo - Ref1 (nepovinný údaj); textový reťazec; max. dĺžka 64kB NIE
deliver_to_address Doručiť na adresu príjemcu (podľa atribútov recipient_*); číslo 0/1 NIE
pickup_from_address Vyzdvihnúť z adresy klienta (definovanú v profile), je možné aplikovať len spolu s aktívnym deliver_to_address; číslo 0/1 NIE
recipient_number Číslo domu príjemcu (nepovinné); textový reťazec; max. dĺžka 20 znakov NIE
return Id miesta pre vrátenie zásielok (nepovinné); textový reťazec NIE
destination_country Cieľová krajina (nepovinné); textový reťazec; max. dĺžka 64kB NIE
original_package Identifikácia pôvodnej zásielky iného prepravcu (nepovinné) textový reťazec; max. dĺžka 50 znakov NIE
ref2 Ref2 (nepovinný údaj); textový reťazec; max. dĺžka 64kB NIE
ref3 Ref3 (nepovinný údaj); textový reťazec; max. dĺžka 64kB NIE

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/json
application/*+json
Content-Type
application/vnd.api.v2+json
application/json
Authorization HTTP Basic Authorization

Body

{
   "target": "Id výdajného miesta pre zásielku (id pochádza z API metódy places)",
   "recipient_name": "Meno a priezvisko príjemcu zásielky",
   "recipient_street": "Ulica príjemcu zásielky (nepovinné)",
   "recipient_number": "Číslo domu príjemcu zásielky (nepovinné)",
   "recipient_zip": "PSČ príjemcu zásielky (nepovinné)",
   "recipient_city": "Obec príjemcu zásielky (nepovinné)",
   "recipient_country": "Krajina príjemcu zásielky (nepovinné)",
   "recipient_phone": "Mobilné telefónne číslo príjemcu zásielky v medzinárodnom tvare bez medzier a bez znaku +. Povolené sú len číslice.",
   "recipient_email": "E-mailová adresa príjemncu zásielky",
   "cod": "Suma dobierky v EUR",
   "insurance": "Hodnota zásielky v EUR",
   "size_a": "",
   "size_b": "Rozmer zásielky b (v centimetroch, nepovinné)",
   "size_c": "Rozmer zásielky c (v centimetroch, nepovinné)",
   "weight": "Hmotnosť zásielky (v gramoch, nepovinné)",
   "service_18plus": "Služba 18+ (overenie veku príjemcu v DEPO) 0 alebo 1 v prípade požadovania služby",
   "sender_reference": "Interné číslo - Ref1, nepovinné",
   "ref2": "Ref2, nepovinné",
   "ref3": "Ref3, nepovinné",
   "deliver_to_address": "Doručiť na adresu zákazníka",
   "pickup_from_address": "Vyzdvihnúť z adresy klienta"
}

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/json
application/*+json

Telo

{
   "number": "Číslo zásielky",
   "price": "Odhadovaná cena v EUR za službu",
   "region": "Názov cieľového rajónu (používa sa len pri generovaní vlastného štítku na strane eshopu)"
}
v prípade chyby sa vracia odpoveď application/problem+json podľa RFC 7807:
{
    "validation_messages": {
        "insurance": {
            "notGreaterThan": "Hodnota nie je väčšia ako '0'"
        }
    },
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Unprocessable Entity",
    "status": 422,
    "detail": "Failed Validation"
}
Väčšine chybových stavov je možné predísť validáciou dát pomocou statických validačných pravidiel. Výnimkou sú situácie závislé od stavu miest a bližšie informácie je možné nájst vo vlastnostiach validation_messages alebo detail.
{
  "validation_messages": {
    "target": {
      "invalidValue": "Cie\u013eov\u00e9 miesto nebolo n\u00e1jden\u00e9"
    }
  },
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Failed Validation"
}

API metóda: cancel

Zruší registrovanú (neodoslanú) alebo požiada o vrátenie odoslanej zásielky. Klient sa autentifikuje pomocou pridelených prihlasovacích údajov, ktoré sú v požiadavke obsahnuté pomocou mechanizmu HTTP Basic authentication. Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

POST https://admin.depo.sk/v2/api/packages/cancel

Zruší registrovanú (neodoslanú) alebo požiada o vrátenie odoslanej zásielky

Atribúty

Atribút Popis Povinný
number Číslo zásielky ÁNO

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/json
application/*+json
Content-Type
application/vnd.api.v2+json
application/json
Authorization HTTP Basic Authorization

Body

{
   "number": "Číslo zásielky"
}

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/json
application/*+json

Telo

{
   "number": "Číslo zásielky"
}

API metóda: createLabel

Metóda na generovanie PDF dokumentu s generovaným štítkom pre zásielku. Klient sa autentifikuje pomocou pridelených prihlasovacích údajov, ktoré sú v požiadavke obsahnuté pomocou mechanizmu HTTP Basic authentication. Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

POST https://admin.depo.sk/v2/api/packages/label

Metóda na generovanie PDF dokumentu s generovaným štítkom pre zásielku.

Atribúty

Atribút Popis Povinný
size Počet štítkov na hárok A4 (3x5|2x2) ÁNO
number Číslo zásielky, može byť uvedených viac, oddelených čiarkou ÁNO
position Umiestnenie generovaného štítku na hárku, číslovanie do riadkov začínajúce od 0. Môže byť uvedených viac, oddelených čiarkou NIE
includeLines 0/1 Informácia, či majú byť generované oddelujúce línie NIE

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/json
application/*+json
application/pdf
Content-Type
application/vnd.api.v2+json
application/json
Authorization HTTP Basic Authorization

Body

{
   "size": "Počet štítkov na hárok A4 (3x5|2x2)",
   "number": "Číslo zásielky, može byť uvedených viac, oddelených čiarkou",
   "position": "Umiestnenie generovaného štítku na hárku, číslovanie do riadkov začínajúce od 0. Môže byť uvedených viac, oddelených čiarkou",
   "includeLines": "0/1 Informácia, či majú byť generované oddelujúce línie"
}

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/json
application/*+json
application/pdf

Telo

application/pdf

API metóda: getSelectedPlace

Metóda na zistenie zvoleného výdajného miesta zákazníkom v rámci vloženého kódu <iframe>. Klient sa autentifikuje pomocou pridelených prihlasovacích údajov, ktoré sú v požiadavke obsahnuté pomocou mechanizmu HTTP Basic authentication. Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

POST https://admin.depo.sk/v2/api/places/selected

Metóda na zistenie zvoleného výdajného miesta zákazníkom

Atribúty

Atribút Popis Povinný
order Hodnota parametru o, ktorý bol vložený do kódu iframe ÁNO

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/json
application/*+json
Content-Type
application/vnd.api.v2+json
application/json
Authorization HTTP Basic Authorization

Body

{
   "order": "Parameter s názvom o, ktorý bol predaný v rámci URL kódu iframe"
}

Odpoveď

Hlavičky

Hlavička Hodnota
Content-Type
application/vnd.api.v2+json
application/json
application/*+json

Telo

{
   "is_selected": "0/1 informácia, či pre zadaný identifikátor bolo zvolené výdajné miesto",
   "id": "id zvoleného výdajného miesta (ak bolo zvolené)",
   "name": "názov zvoleného výdajného miesta (ak bolo zvolené)",
   "street": "ulica zvoleného výdajného miesta (ak bolo zvolené)",
   "zip": "PSČ zvoleného výdajného miesta (ak bolo zvolené)",
   "city": "obec zvoleného výdajného miesta (ak bolo zvolené)"
}

API metóda: getPackageState

Získanie stavu zásielky, platný je posledný stav kódy stavov: 1 - registrovaná, 2 - odoslaná (prijatá), 11 - v preprave smerom na cieľové miesto, 12 - zrušená po odoslaní, 14 - vrátená odosielateľovi, 15 - v preprave smerom na miesto, kde bude vrátená odosielateľovi, 17 - v preprave (externé doručenie), 18 - v preprave na výdajný bod, 21 - pripravená na vyzdvihnutie, 22 - doručená príjemcovi (vyzdnihnutá), 23 - nevyzdnihnutá príjemcom (po dobe skladovania), 24 - odmietnutá príjemcom, 25 - pripravená na vrátenie odosielateľovi, 28 - čaká sa na úhradu dobierky, 31 - stratená / zničená, 35 - zlikvidovaná, 51 - zrušená pred odoslaním (nebola fyzicky prijatá), 61 - odovzdané prepravcovi, 71 - prebratá, 72 - doručuje sa, 73 - opätovne sa doručuje, 74 - doručená na lokálny sklad, 75 - vrátená na lokálny sklad, 76 - odmietnutá, 77 - v preprave k odosielatelovi, 78 - nedoručená, 95 - kontrolný sken Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

POST https://admin.depo.sk/v2/api/packages/state

{ "number": "Číslo zásielky" }

Atribúty

Atribút Popis Povinný
number Číslo zásielky ÁNO

Požiadavka

Hlavičky

Hlavička Hodnota
Accept
application/vnd.api.v2+json
application/json
application/*+json
Content-Type
application/vnd.api.v2+json
application/json

Body


                                            

                


                

                    
Odpoveď


                    

                        
Hlavičky

                        

                            
                                

                                    Hlavička
                                    Hodnota
                                

                            
                            
                                

                                    Content-Type
                                    
application/vnd.api.v2+json


application/json


application/*+json

                                

                            
                        


                                                
Telo

                        
[
{
"state": "Stav",
"state_id": "Kód stavu z číselníka",
"datetime": "Dátum a čas ISO 8601",
"place_id": "Id miesta",
"place_name": "Názov miesta"
}
]

                                            

                

            

        

    




            






    

        
API metóda: getClientId

    


    

        

            
Vráti id klienta. Všeobecne na prístup k API je potrebné použiť platné prihlasovacie údaje do klientskej zóny služby DEPO.

        


        

    

        

            

                GET
                https://admin.depo.sk/v2/api/client/id            

        


        

            

                


                
                

                    
Požiadavka


                    

                        
Hlavičky

                        

                            
                                

                                    Hlavička
                                    Hodnota
                                

                            
                            
                                

                                    Accept
                                    
application/vnd.api.v2+json


application/json


application/*+json

                                

                                                                                                

                                    Authorization
                                    HTTP Basic Authorization
                                

                                                            
                        


                                            

                


                

                    
Odpoveď


                    

                        
Hlavičky

                        

                            
                                

                                    Hlavička
                                    Hodnota
                                

                            
                            
                                

                                    Content-Type
                                    
application/vnd.api.v2+json


application/json


application/*+json

                                

                            
                        


                                                
Telo

                        
{"id": "Id klienta"}