Skip to content

Dokumentace

delibarry edited this page Nov 8, 2016 · 25 revisions

Delibarry - dokumentace veřejné API

Popis parametrů jednotlivých metod

Tučně uvedené parametry jsou povinné


Autentizace

Autentizace probíhá pomocí API klíče vygenerovaného v prostředí Delibarry Business.
Získaný API klíč se přidává jako parametr do každé volané metody.

Položka Typ Popis
key string API klíč uživatele

POST https://www.delibarry.com/api/getrate

Metoda: GetRate - získání ceny a data dodání zásilky jednotlivých přepravců dle nastavených parametrů

Položka Typ Popis
from string Odesílatel - kód země podle ISO 3166-1 alpha-2
to string Příjemce - kód země podle ISO 3166-1 alpha-2
pickup_date string Preferované datum vyzvednutí (formát YYYY-MM-DD)
currency string Kód použité měny podle ISO 4217
insurance integer Nastavení pojištění*
cod string Nastavení dobírky* - částka dobírky ve vybrané měně
package array Seznam položek/balíků zásilky, obsahuje parametry balíku (viz níže)

Poznámka:
Nastavení dobírky - zasílání na dobírku je možné pouze pro přepravce InTime CZ a GLS CZ Nastavení pojištění - Hodnoty: 0-nezahrnovat pojištění, 1-zahrnout pojištění, výchozí:1

Package - parametry položek

Položky jsou uváděny jako asociativní pole obsahující rozměry balíku a jeho hmotnost.

Položka Typ Popis
weight number hmotnost balíku v kg
size1 number délka balíku v cm
size2 number šířka balíku v cm
size3 number výška balíku v cm
Poznámka: Nutnost uvádět rozměry balíku pro přesný výpočet ceny se liší podle jednotlivých přepravců.

Příklad volání:

curl -v –X POST https://www.delibarry.com/api/getrate \
-H "Content-Type:application/json" \
-d '{
	"key" : "[your API key]",
	"from" : "CZ",
	"to" : "CZ",
	"currency" : "CZK",
	"shipment_value" : 3400,
	"insurance" : 1,
	"cod" : 150,
	"pickup_date": "2016-09-30",
	"package": [{"weight": 2, "size1": 30, "size2":20, "size3":30}]
}'

Návratové hodnoty

Položka Typ Popis
operators array Přehled dostupných operátorů pro zadané parametry zásilky (viz níže)
balance array Aktuální stav kreditu uživatele (viz níže)

Operators - parametry

Položka Typ Popis
id integer ID přepravce
name string Název přepravce
pickup_time_real string Datum vyzvednutí podle požadavku uživatele
pickup_time_first_available string Nejbližší možné datum vyzvednutí
delivery_time string Předpokládané datum doručení
currency string Použitá měna
total_amount number Celková cena přepravy
price_from number Nejnižší cena v případě, kdy přepravce vyžaduje přesnější parametry zásilky (upřesnění požadavků se nachází v parametru error)
error string Chybové hlášky

Balance - parametry

Položka Typ Popis
amount number Hodnota zbývajícího kreditu
currency string Měna kreditu

Příklad návratových hodnot:

{
  "operators": [
    {
      "id": "2",
      "name": "InTime",
      "pickup_time_real": "2016-05-30",
      "delivery_time": "2016-06-01",
      "total_amount": 179,
      "currency": "CZK",
      "pickup_time_first_available": "2016-05-26"
    },
    {
      "id": "3",
      "name": "GLS",
      "pickup_time_real": "2016-05-30",
      "delivery_time": "2016-06-01",
      "total_amount": 340,
      "currency": "CZK",
      "pickup_time_first_available": "2016-05-26"
    },
    {
      "id": "7",
      "name": "TNT express",
      "pickup_time_real": "2016-05-30",
      "delivery_time": "2016-05-31",
      "currency": "CZK",
      "error": "REQUIRED_PACKAGE_SIZE",
      "price_from": 130,
      "pickup_time_first_available": "2016-05-25"
    }
  ],
  "balance": {
    "amount": "6790",
    "currency": "CZK"
  }
}

POST https://www.delibarry.com/api/createshipment

Metoda: CreateShipment - vytvoření objednávky pro konkrétního přepravce a zásilku

Položka Typ Popis
operator_code integer ID požadovaného operátora
pickup_address_id integer ID adresy odesílatele / svozového místa (pro jeho získání kontaktujte zákaznickou podporu)
recipient array Příjemce - adresa (viz níže)
currency string Kód měny
sender array Odesílatel - adresa odesílatele na štítku (viz níže)
discount string Kód slevového voucheru
pickup_date string Preferované datum vyzvednutí, pokud není nastaveno, použije se nejbližší možné datum
timezone string Časová zóna
documents integer Zásilka obsahuje pouze dokumenty (0-NE, 1-ANO), výchozí hodnota:0
cod number Hodnota dobírky*
customer_reference integer Zákazníkův identifikátor zásilky, který slouží současně jako variabilní symbol při vyplácení dobírek*
insurance integer Nastavení pojištění*
shipment_value array Hodnota zásilky
package array Seznam položek/balíků zásilky, obsahuje parametry balíku (viz níže)

Poznámka:
Nastavení dobírky - zasílání na dobírku je možné pouze pro přepravce InTime CZ, PPL a GLS CZ

Nastavení pojištění - Hodnoty: 0-nezahrnovat pojištění, 1-zahrnout pojištění, výchozí:1

Recipient - parametry adresy příjemce

Položky jsou uváděny jako asociativní pole definující příjemce a jeho adresu

Položka Typ Popis
firstname string Jméno
lastname string Příjmení
address string Adresa a číslo popisné
city string Město
postalcode string Poštovní směrovací číslo
country string Země - kód země podle [ISO 3166-1 alpha-2]
phone_prefix string Telefonní předčíslí země/státu
phone string Telefonní číslo
email string E-mail

Sender - parametry adresy odesílatele

Položky jsou uváděny jako asociativní pole definující odesílatele a jeho adresu uváděnou na štítku zásilky (nyní pouze pro PPL štítky)

Položka Typ Popis
firstname string Jméno
lastname string Příjmení
address string Adresa a číslo popisné
city string Město
postalcode string Poštovní směrovací číslo
country string Země - kód země podle [ISO 3166-1 alpha-2]
company string Firma, společnost

Package - parametry položek zásilky

Položky jsou uváděny jako asociativní pole obsahující rozměry balíku, jeho hmotnost, obsah a hodnotu.

Položka Typ Popis
weight number hmotnost balíku v kg
content string popis položky
value number hodnota položky*
size1 number délka balíku v cm*
size2 number šířka balíku v cm*
size3 number výška balíku v cm*
Poznámka 1: Nutnost uvádět rozměry balíku pro přesný výpočet ceny se liší podle jednotlivých operátorů.
Poznámka 2: Lze uvést celkovou cenu zásilky pouze v parametru shipment_value.

Příklad volání:

curl -v –X POST https://www.delibarry.com/api/createshipment \
-H "Content-Type:application/json" \
-d '{
  "key" : "[your API key]", 
  "operator_code" : 14,
  "pickup_address_id" : 13,
  "recipient":{
    "firstname": "Jan",
    "lastname": "Novák",
    "address": "Dělnická 12",
    "city": "Praha 7",
    "postalcode": "170 00",
    "country": "CZ",
    "phone_prefix": "+420",
    "phone": "123 456 789",
    "email": "jan.novak@testmail.com"
   },
  "currency" : "CZK",
  "insurance" : 1,
  "pickup_date": "2016-09-30",
  "package" : [
    {
      "weight": 2, 
      "size1": 30, 
      "size2":20, 
      "size3":30,
      "content": "Toner do tiskarny",
      "value" : 1200
    }
  ]
}'

Návratové hodnoty

Položka Typ Popis
responseCode integer Kód stavu požadavku
message string Zpráva o úspěšnosti
orderId integer Číslo objednávky
token string Unikátní token objednávky

Příklad návratových hodnot:

{
 "responseCode" : 1,
 "message" : "shipment created",
 "trackingNumber" : "312258"
}

GET https://www.delibarry.com/api/getlabels

Metoda: GetLabels - vrací URL adresu pro stažení štítků k odpovídající zásilce

Položka Typ Popis
tokens string Unikátní token objednávky (v případě více tokenů je lze oddělit čárkou)

Příklad volání:

curl -v –X GET https://www.delibarry.com/api/getlabels?tokens=d41d8cd98f00b204e9800998ecf8427e,912ec803b2ce49e4a541068d495ab570

Návratové hodnoty

Položka Typ Popis
result array pole s daty štítků
not_found array seznam nenalezených/nedostupných štítků

Result - pole s daty štítků

Položka Typ Popis
token string unikátní token objednávky
fileType string MIME typ souboru v položce content
content base64 data štítku zakódována do Base64
Poznámka 1: Štítky jsou standardně poskytovány ve formátu PDF.

Příklad návratových hodnot:

{
  "result": [
    {
      "token": "0e9456d75a5e589eb50cc13af0712086",
      "fileType": "application/pdf",
      "content": "JVBERi0xLjMKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1...iUlRU9GCg=="
    }
  ],
  "not_found": [
    "d41d8cd98f00b204e9800998ecf8427e",
    "912ec803b2ce49e4a541068d495ab570"
  ]
}

GET https://www.delibarry.com/api/tracking

Metoda: Tracking - vrací informace o sledování zásilky

Položka Typ Popis
token string Unikátní token objednávky

Příklad volání:

curl -v –X GET https://www.delibarry.com/api/tracking?token=6t2h4ad6h1dt6shd1g5d2s3

Návratové hodnoty

Položka Typ Popis
state string stav objednávky
result array informace o sledování zásilky
code string interní kód aktuálního stavu
name string popis kontrolního bodu
date string den zápisu kontrolního bodu
time text čas zápisu kontrolního bodu

Příklad návratových hodnot:

  
{
    "state": "delivered",
    "result": [
        {
            "code": "PU",
            "name": "Prague - Shipment Collected From Customer",
            "date": "Mon 06.06.2016",
            "time": "14:09"
        },
        {
            "code": "DH",
            "name": "Prague - Shipment Received At Tnt Location",
            "date": "Mon 06.06.2016",
            "time": "16:54"
        },
        {
            "code": "CI",
            "name": "Prague - Shipment Received At Origin Depot.",
            "date": "Mon 06.06.2016",
            "time": "17:02"
        },
        {
            "code": "TR",
            "name": "Prague - Shipment In Transit.",
            "date": "Mon 06.06.2016",
            "time": "17:04"
        },
        {
            "code": "OS",
            "name": "Prague - Shipment In Transit.",
            "date": "Mon 06.06.2016",
            "time": "22:16"
        },
        {
            "code": "TR",
            "name": "Nuernberg Hub - Shipment In Transit.",
            "date": "Tue 07.06.2016",
            "time": "07:28"
        },
        {
            "code": "AS",
            "name": "Northampton Hub - Shipment Received At Transit Point.",
            "date": "Wed 08.06.2016",
            "time": "17:35"
        },
        {
            "code": "TR",
            "name": "Northampton Hub - Shipment In Transit.",
            "date": "Wed 08.06.2016",
            "time": "17:49"
        },
        {
            "code": "IR",
            "name": "Worcester - Shipment Received At Tnt Location",
            "date": "Thu 09.06.2016",
            "time": "00:53"
        },
        {
            "code": "OD",
            "name": "Worcester - Out For Delivery.",
            "date": "Thu 09.06.2016",
            "time": "07:09"
        },
        {
            "code": "OK",
            "name": "Worcester - Shipment Delivered In Good Condition. <strong>Signed by: jan novak<\/strong>",
            "date": "Thu 09.06.2016",
            "time": "08:00"
        }
    ]
}
Clone this wiki locally
You can’t perform that action at this time.