HP Shipping Service API - 6. Delivery point methods

Previous Next
(docx) HP Shipping Service API - Technical documentation (pdf)

6. Delivery point methods 

6.1.GetParcelDeliveryPoint


Definition

This method is used to retrieve accurate and available information about working hours, addresses and other information of Croatian Post offices and parcel lockers.
Method URL example - TEST
GET https://dxwebapit.posta.hr:9020/api/delivery_point/get_parcel_delivery_point
 
 

Request parameters

Class ParcelDeliveryPointData
Parameter Type Description REQUIRED
facilityType String Parameter that filters data on post offices and parcel lockers
Possible values:
ALL – Retrieves post offices and parcel lockers
PU – Retrieves only post lockers
PAK – Retrieves only parcel lockers		 YES
nextWeek Integer A parameter that determines whether the working hours for post offices will be retrieved for the current week or for the current and the following week
Possible values:
0 – Retrieves post office working hours for the current week
1 – Retrieves post office working hours for the current and the following week		 YES
searchText String A parameter that filters the retrieved data by name, location, postal code or parcel locker code and street
Empty string does not filter results		 YES
 

Request example

 
1. Example of a service call that retrieves all post offices and parcel lockers with business hours for the current week, without filtering the results
{
"facilityType": "ALL",
"nextWeek": 0,
"searchText": ""
}
 
 
2. Example of a service call that retrieves only parcel lockers
{
"facilityType": "PAK",
"nextWeek": 0,
"searchText": ""
}
 
3. Example of a service call that retrieves only post offices with business hours for the current and following week
{
"facilityType": "PU",
"nextWeek": 1,
"searchText": ""
}
 
4. Example of a service call that retrieves data by filtering
{
"facilityType": "ALL",
"nextWeek": 0,
"searchText": "62102"
}
{
"facilityType": "PU",
"nextWeek": 0,
"searchText": "Zagreb"
}
 

Response example

"postaInfoList": 
[ 
    { 
        "type": "string", 
        "name": "string", 
        "zip": "string", 
        "city": "string", 
        "address": "string", 
        "tel": "string", 
        "fax": "string", 
        "geoLatitude": 0, 
        "getLongitude": 0, 
        "workingHours": 
        [ 
            { 
            "weekDay": 0, 
            "date": "string", 
            "openingTime": 
                { 
                "hour": 0, 
                "minute": 0, 
                "second": 0 
                }, 
            "closingTime": 
                { 
                "hour": 0, 
                "minute": 0, 
                "second": 0 
                }, 
            "closed": "string" 
            } 
        ] 
    } 
], 
"paketomatInfoList": 
[ 
    { 
    "type": "string", 
    "name": "string", 
    "zip": "string", 
    "city": "string", 
    "address": "string", 
    "geoLat": 0, 
    "getLng": 0, 
    "code": "string" 
    } 
] 
}
 
 
 
The service returns two lists: one for post offices "postaInfoList" and one for parcel lockers "paketomatInfoList".
 
PostaInfoList
 
Within the list for post offices, the service returns information about working hours "workingHours" structured in such a way that working hours are returned separately for each day of the week. WorkingHours contains the following parameters within its structure:
Parameter Type Description
weekDay Integer Brojčana oznaka dana u tjednu
1 – ponedjeljak
2 – utorak
.
.
7 - nedjelja
date String Designates the date
openingTime String Designates the opening time of the postal office
closingTime String Designates the closing time of the postal office
Closed String Designates whether the postal office is open or closed
0 – PO closed
1 – PO open