Hrvatska pošta

Žuti klik

Pratite pošiljku

HP Shipping Service API - 5. Shipment metode

Prethodna Sljedeća
(docx) (pdf)

 

1.Shipment metode

 

5.1.CreateShipmentOrders

 

Definicija

Ova metoda upotrebljava se za kreiranje pošiljki.
 
Metoda URL primjer - TEST
POST https://dxwebapit.posta.hr:9020/api/shipment/create_shipment_orders
 

Parametri poziva

 
Class ShipmentOrdersData
Parametar Tip Opis REQUIRED
parcels List Lista pošiljki za kreiranje DA
return_address_label Bool Zastavica koja označava vraćamo li u rezultatu poziva adresnice za kreirane pošiljke u obliku PDF formata
Mogući odabiri:
False - NE
True - DA		  
 
Class ShipmentOrderData
Parametar Tip Opis REQUIRED
client_reference_number String Jedinstveni ID pošiljke u klijentovu sustavu
Maks. Duljina: 100		 DA
service Integer Vrsta usluge
Mogući odabiri:
24 - Paletizirana pošiljka
26 - Paket 24 D+1
29 - Paket 24 D+2
32 - Paket 24 D+3
38 - Paket 24 D+4		 DA
payed_by Integer Platitelj pošiljke
Mogući odabiri:
1 - Pošiljatelj
2 - Primatelj
Ako je NULL, onda se za platitelja upotrebljava pošiljatelj pošiljke.		  
delivery_type Integer Vrsta uručenja pošiljke
Mogući odabiri:
1 - Adresa
2 - Poštanski ured
3 - Paketomat		 DA
value Decimal Osigurana vrijednost pošiljke
Broj decimalnih mjesta: 2		  
payment_value Decimal Otkupnina
Broj decimalnih mjesta: 2		 DA ako je odabrana dodatna usluga 9 - Plaćanje pouzećem (i obrnuto)
pickup_type Integer Vrsta prikupa pošiljke
Mogući odabiri:
1 - Adresa
2 - Poštanski ured
3 - Paketomat		  
parcel_size String Veličina paketa
Mogući odabiri:
X - Paket veličine XS
S - Paket veličine S
M - Paket veličine M
L - Paket veličine L
Dimenzije pretinaca:
https://www.posta.hr/dimenzije-pretinaca/9279		 DA ako je delivery_type 3
(uručenje pošiljke u paketomat)
reference_field_B String Referentno polje naloga B
NOT UNIQUE. Maks. duljina: 100		  
reference_field_C String Referentno polje naloga C
NOT UNIQUE. Maks. duljina: 100		  
reference_field_D String Referentno polje naloga D
NOT UNIQUE. Maks. duljina: 100		  
sender SenderData Podaci o pošiljatelju DA
recipient RecipientData Podaci o primatelju DA
additional_services List Lista dodatnih usluga  
packages List Lista paketa pošiljke DA

 
Lista paketa pošiljke DA            
SenderData
Parametar Tip Opis REQUIRED
sender_name String Naziv pošiljatelja
Maks. duljina: 50		 DA
sender_phone String Telefonski broj pošiljatelja
Maks. duljina: 25		 DA
sender_email String Email adresa pošiljatelja
Maks. duljina: 25		  
sender_street String Ulica pošiljatelja
Maks. duljina: 50		 DA
sender_hnum String Kućni broj pošiljatelja
Maks. duljina: 10		 DA
sender_hnum_suffix String Dodatak kućnom broju pošiljatelja
Maks. duljina: 10		 DA
sender_zip String Poštanski broj pošiljatelja
Maks. duljina: 5		 DA
sender_city String Naziv grada pošiljatelja
Maks. duljina: 25		 DA
sender_pickup_center String Šifra poštanskog ureda ili paketomata za prikup
Maks. duljina: 5		 DA ako je pickup_type 2 ili 3
 
RecipientData
Parametar Tip Opis REQUIRED
recipient_name String Naziv primatelja
Maks. duljina: 50		 DA
recipient_phone String Telefonski broj primatelja
Maks. duljina: 25		 DA
recipient_email String Adresa e-pošte primatelja
Maks. duljina: 25		  
recipient_street String Ulica primatelja
Maks. duljina: 50		 DA
recipient_hnum String Kućni broj primatelja
Maks. duljina: 10		 DA
recipient_hnum_suffix String Dodatak kućnom broju primatelja
Maks. duljina: 10		 DA
recipient_zip String Poštanski broj primatelja
Maks. duljina: 5		 DA
recipient_city String Naziv grada primatelja
Maks. duljina: 25		 DA
recipient_delivery_center String Šifra poštanskog ureda ili paketomata za isporuku
Maks. duljina: 5		 DA ako je delivery_type 2 ili 3
 
 
Class AdditionalServiceData
Parametar Tip Opis REQUIRED
additional_service_id Integer ID dopunske usluge
Mogući odabiri:
1 - Uručiti osobno
3 - Uručenje subotom
4 - S povratnicom
9 - Plaćanje pouzećem (Otkupnina)
30 - Slanje obavijesti primatelju
32 - Slanje poruke e-pošte primatelju
47 - Konsolidirana pošiljka		  
 
Class PackageData
Parametar Tip Opis REQUIRED
barcode String Barkod paketa Hrvatske pošte
Šalje se kada je barcode_type 0.
Empty string kada je barcode_type 1.
Maks. duljina: 20		 DA ako je barcode_type 0
barcode_type Integer Tip barkoda
Mogući odabiri:
0 - Predefiniran range dobiven od HP-a
1 - Barcode dobiven u odgovoru iz sustava pri kreiranju pošiljke		 DA
barcode_client String Klijentov barkod
Šalje se kada je barcode_type 1.
Empty string kada je barcode_type 0.
Maks. duljina: 500		 DA ako je barcode_type 1
weight Decimal Masa paketa u kilogramima
Broj decimalnih mjesta: 3		 DA

Primjer poziva

{
    "parcels": [
        {
            "client_reference_number": "test",
            "service": "26",
            "payed_by": 1,
            "delivery_type": 1,
            "value": null,
            "payment_value": 20,
            "pickup_type": 1,
            "parcel_size": "X",
            "reference_field_B": "string",
            "reference_field_C": "string",
            "reference_field_D": "string",
            "sender": {
                "sender_name": "string",
                "sender_phone": "string",
                "sender_email": "string",
                "sender_street": "string",
                "sender_hnum": "string",
                "sender_hnum_suffix": "string",
                "sender_zip": "string",
                "sender_city": "string",
                "sender_pick_up_center": "string"
            },
            "recipient": {
                "recipient_name": "string",
                "recipient_phone": "string",
                "recipient_email": "string",
                "recipient_street": "string",
                "recipient_hnum": "string",
                "recipient_hnum_suffix": "",
                "recipient_zip": "string",
                "recipient_city": "string",
                "recipient_delivery_center": "string"
            },
            "additional_services": [
                {
                    "additional_service_id": 9
                }
            ],
            "packages": [
                {
                    "barcode": "",
                    "barcode_type": 1,
                    "barcode_client": "string",
                    "weight": 3
                },
                {
                    "barcode": "",
                    "barcode_type": 1,
                    "barcode_client": "string",
                    "weight": 3
                }
            ]
        },
        {
            "client_reference_number": "test1",
            "service": "26",
            "payed_by": 1,
            "delivery_type": 1,
            "value": null,
            "payment_value": 0,
            "pickup_type": 1,
            "parcel_size": "S",
            "reference_field_B": "string",
            "reference_field_C": "string",
            "reference_field_D": "string",
            "sender": {
                "sender_name": "string",
                "sender_phone": "string",
                "sender_email": "string",
                "sender_street": "string",
                "sender_hnum": "string",
                "sender_hnum_suffix": "string",
                "sender_zip": "string",
                "sender_city": "string",
                "sender_pick_up_center": "string"
            },
            "recipient": {
                "recipient_name": "string",
                "recipient_phone": "string",
                "recipient_email": "string",
                "recipient_street": "string",
                "recipient_hnum": "string",
                "recipient_hnum_suffix": "string",
                "recipient_zip": "string",
                "recipient_city": "string",
                "recipient_delivery_center": "string"
            },
            "additional_services": [
                {
                    "additional_service_id": 30
                }
            ],
            "packages": [
                {
                    "barcode": "",
                    "barcode_type": 1,
                    "barcode_client": "string",
                    "weight": 3
                },
                {
                    "barcode": "",
                    "barcode_type": 1,
                    "barcode_client": "string",
                    "weight": 3
                }
            ]
        }
    ],
    "return_address_label": true
}
 

Primjer rezultata poziva

 
{
    "ShipmentOrdersList": [
        {
            "ClientReferenceNumber": "test",
            "ResponseStatus": 0,
            "Packages": [
                {
                    "barcode": "LE900002111HR",
                    "barcode_type": 1,
                    "barcode_client": "test12",
                    "weight": 3.0
                },
                {
                    "barcode": "LE900002125HR",
                    "barcode_type": 1,
                    "barcode_client": "test22",
                    "weight": 3.0
                }
            ],
            "ErrorCode": null,
            "ErrorMessage": null,
            "MessageID": ""
        },
        {
            "ClientReferenceNumber": "test1",
            "ResponseStatus": 0,
            "Packages": [
                {
                    "barcode": "LE900002139HR",
                    "barcode_type": 1,
                    "barcode_client": "test12",
                    "weight": 3.0
                },
                {
                    "barcode": "LE900002142HR",
                    "barcode_type": 1,
                    "barcode_client": "test22",
                    "weight": 3.0
                }
            ],
            "ErrorCode": null,
            "ErrorMessage": null,
            "MessageID": ""
        }
    ],
    "ShipmentsLabel": "base64string"
}
 

Parametri rezultata poziva

 
Class CreateShipmentOrdersMainResponse
Parametar Tip Opis
ShipmentOrdersList List Lista kreiranih ili odbačenih pošiljki ovisno o potencijalnoj grešci
ShipmentsLabel String Adresnice kreiranih pošiljki u „base64” string formatu
 
Class CreateShipmentOrdersResponse
Parametar Tip Opis
ClientReferenceNumber String Jedinstveni ID pošiljke u klijentovu sustavu
ResponseStatus EnumResponseStatus 0 - OK
1 - ERROR
Packages List Lista kreiranih paketa pošiljke
ErrorCode Integer Šifra greške
ErrorMessage String Poruka greške
MessageID String ID greške
 

5.2.       CancelShipmentOrders

 

Definicija

Ova metoda upotrebljava se za storniranje pošiljki.
Metoda URL primjer - TEST
POST https://dxwebapit.posta.hr:9020/api/shipment/cancel_shipment_orders
 

Parametri poziva

 
Class CancelOrdersData
Parametar Tip Opis REQUIRED
parcels List Lista pošiljki za storniranje DA
 
 
Class CancelOrderData
Parametar Tip Opis REQUIRED
client_reference_number String Jedinstveni ID pošiljke u klijentovu sustavu
Maks. duljina: 100		 DA
 

Primjer poziva

{
    "parcels": [
        {
            "client_reference_number": "test"
        },
        {
            "client_reference_number": "test1"
        }
    ]
}

 

Primjer rezultata poziva

[
    {
        "ClientReferenceNumber": "test",
        "ResponseStatus": 0,
        "ErrorCode": null,
        "ErrorMessage": null
    },
    {
        "ClientReferenceNumber": "test1",
        "ResponseStatus": 0,
        "ErrorCode": null,
        "ErrorMessage": null
    }
]
 

Parametri rezultata poziva

Class CancelShipmentOrdersResponse
Parametar Tip Opis
ClientReferenceNumber String Jedinstveni ID pošiljke u klijentovu sustavu
ResponseStatus EnumResponseStatus 0 - OK
1 - ERROR
ErrorCode Integer Šifra greške
ErrorMessage String Poruka greške
 
 
 

5.3.       GetShipmentStatus

 

Definicija

Ova metoda upotrebljava se za dohvaćanje statusa pošiljki.
Metoda URL primjer - TEST
GET https://dxwebapit.posta.hr:9020/api/shipment/get_shipment_status

 

 

Parametri poziva

 
Class BarcodesData
Parametar Tip Opis REQUIRED
barcodes List Lista barkodova za koje se dohvaćaju statusi DA
 
Class BarcodeData
Parametar Tip Opis REQUIRED
barcode String Barkod paketa za koji se dohvaća status
Maks. duljina: 20		 DA
 

Primjer poziva

{    "barcodes": [
        {
            "barcode": "LE347087966HR"
        },
        {
            "barcode": "LE347087952HR"
        }
    ]
}

Primjer rezultata poziva

[
    {
        "Barcode": "LE347087966HR",
        "PackageScansList": [
            {
                "Scan": "NOV",
                "ScanDescription": "Definirani podaci o pošiljci",
                "ScanTime": "2022-11-16T11:15:33.257",
                "Center": "ROOT",
                "Comment": null,
                "CommentNPA": "5000002"
            }
        ],
        "ResponseStatus": 0,
        "ErrorCode": null,
        "ErrorMessage": null
    },
    {
        "Barcode": "LE347087952HR",
        "PackageScansList": [
            {
                "Scan": "NOV",
                "ScanDescription": "Definirani podaci o pošiljci",
                "ScanTime": "2022-11-16T11:30:22.763",
                "Center": "ROOT",
                "Comment": null,
                "CommentNPA": "5000002"
            }
        ],
        "ResponseStatus": 0,
        "ErrorCode": null,
        "ErrorMessage": null
    }
]
 

Parametri rezultata poziva

 
Class GetShipmentStatusResponse
Parametar Tip Opis
Barcode String Barkod paketa za koji je dohvaćen status
PackageScansList List Lista dohvaćenih statusa za pojedini barkod
ResponseStatus EnumResponseStatus 0 - OK
1 - ERROR
ErrorCode Integer Šifra greške
ErrorMessage String Poruka greške
 
Class PackageScanData
Parametar Tip Opis
Scan String Šifra skena
Popis skenova: Dodatak A
ScanDescription String Opis skena
ScanTime DateTime Datum skeniranja
Center String Poslovnica gdje je obavljen sken
Comment String Napomena skena
CommentNPA String Napomena skena NPA
Popis napomena: Dodatak B

 

 

1.4.GetShippingLabels

 

Definicija

Ova metoda upotrebljava se za dohvaćanje adresnica već kreiranih pošiljki.
Dohvaćanje adresnica može se vršiti preko client reference numbera i/ili barkodova.
Metoda URL primjer - TEST
GET https://dxwebapit.posta.hr:9020/api/shipment/get_shipping_labels
 

Parametri poziva

 
Class LabelsData
Parametar Tip Opis REQUIRED
client_reference_number String Jedinstveni ID pošiljke u klijentovu sustavu
Maks. duljina: 100		 DA ako nije naveden „barcodes”
barcodes List Lista barkodova za koje se dohvaćaju adresnice DA ako nije naveden CRN
A4 Bool Zastavica koja označava želimo li ispis u A4 formatu (četiri adresnice na jednoj stranici)
Mogući odabiri:
False - NE
True - DA
Ako je NULL, onda je default 0.		  
 
Class BarcodeData
Parametar Tip Opis REQUIRED
barcode String Barkod paketa za koji dohvaćamo adresnicu
Maks. duljina: 20		  
 

Primjer poziva

{    
"client_reference_number": "test",
"barcodes": [
        {
            "barcode": "LE900001297HR"
        },
        {
            "barcode": "LE900001310HR"
        }
    ],
"A4":false
}

Primjer rezultata poziva

{
    "PackageLabel": "base64string",
    "ResponseStatus": 0,
    "ErrorCode": null,
    "ErrorMessage": null
}
 
 

Parametri rezultata poziva

 
Class GetShippingLabelsResponse
Parametar Tip Opis
PackageLabel String Adresnice kreiranih pošiljki u „base64” string formatu
ResponseStatus EnumResponseStatus 0 - OK
1 - ERROR
ErrorCode Integer Šifra greške
ErrorMessage String Poruka greške